Bug 342594 - Improve projects plugin documentation
Summary: Improve projects plugin documentation
Status: RESOLVED NOT A BUG
Alias: None
Product: kate
Classification: Applications
Component: application (other bugs)
Version First Reported In: 3.13.2
Platform: Mint (Ubuntu based) Linux
: NOR wishlist
Target Milestone: ---
Assignee: KWrite Developers
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2015-01-07 17:47 UTC by benselme
Modified: 2019-05-19 15:05 UTC (History)
3 users (show)

See Also:
Latest Commit:
Version Fixed/Implemented In:
Sentry Crash Report:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description benselme 2015-01-07 17:47:32 UTC
The projects plugin is activated by default but it's impossible to figure out how to use it without a google search.

Reproducible: Always

Steps to Reproduce:
1. Open Kate
2. See the "projects" menu and sidebar
3. Try to create a new project


Actual Results:  
Look for a way to create a new project in the menus and sidebar: nothing found.
Look in Kate handbook: nothing found.

Expected Results:  
At the very, very least, it should be in the docs.
Comment 1 Kai Uwe Broulik 2015-01-07 20:47:36 UTC
It picks up contents in git repositories automatically which is quite handy and works automagically.
Comment 2 Christoph Cullmann 2015-06-08 19:52:21 UTC
The documentation needs some love, but the plugin works fine, that is no bug.
Comment 3 Gregor Mi 2018-04-19 14:03:05 UTC
I use the Project plugin a lot since years. It is a hidden gem. I myself only learned how to use it because somebody explained it to me in person.

A first step could be to create a toolbar like in the Documents plugin and add a "About / Help" button that shows a little text like

"Shows a tree of all files which are part of a git repository. Restrict search and replace on those files only. And much more."

and a link to this blog post: https://kate-editor.org/2012/11/02/using-the-projects-plugin-in-kate/
Comment 4 Christoph Cullmann 2019-05-19 15:05:43 UTC
Dear user, this wish list item is now closed, as it wasn't touched in the last year and no contributor stepped up to implement it.

The Kate/KTextEditor team is small and we can just try to keep up with fixing bugs.

Therefore wishes that show no activity for a years or more will be closed from now on to keep at least a bit overview about 'current' wishs of the users.
If you want your feature to be implemented, please step up to provide some patch for it.

If you think it is really needed, you can reopen your request, but keep in mind,
if no new good arguments are made and no people get attracted to help out to implement it,
it will expire in a year again.

We have a nice website https://kate-editor.org that provides all the information needed to contribute, please make use of it.

Patches can be handed in via https://phabricator.kde.org/differential/

Greetings
Christoph Cullmann