live.gnome.org

Task-based topics

As a prelude to ProjectMallard, we could add task-based topics to the gedit manual. Suggestions of topics below please!

• Spellchecking
• Editing system configuration files

Reorganizing the manual

(This has all been pretty much done now...)

What sections should the gedit manual have?

Suggestions, please...

• Introduction
• Getting started
  • Launching gedit
  • The Gedit Window
  • Opening files
  • Autosave
  • Saving to remote locations
  • Using gedit with the command line
• Interface
  • Using tabs
  • Side pane
  • bottom pane
• Finding text
  • Finding text and the highlight
  • Incremental search

  • Find & Replace

• Printing
• Syntax Highlighting
• Programming with Gedit
• Preferences
• Plugins
  • Snippets

Note 1: A fair amount of material on how to cut, copy, paste, etc should probably go in the GNOME Desktop User Guide, as it's common to all GNOME apps.

JesseVanDenKieboom: Does basics include the more non-discoverable features like dragging tabs to other windows, dragging tabs outside the window to create a new window, incremental searching. I think these really need to be in the manual, otherwise noone will know you can do this with gedit.

JoachimNoreiko: That certainly needs to go in somewhere Is interactive searching the same as incremental search? Let's put the bit on tabs in the basics section for now.

JesseVanDenKieboom: Ah yes, sorry. I meant incremental search, not interactive There are also a lot of questions on IRC be people who want to have highlighting for this or that language. I think it couldn't hurt to explain a bit about that in Syntax Highlighting, but it might be a bit to specific, not sure. I haven't read the current manual, but I think autosaving also needs to be in there (how and when it works?, just sprouting ideas

JoachimNoreiko: Thanks. If there's any more frequently-asked questions from IRC, list them here and I'll try to get the answers into the manual. So how do you get highlighting for this or that language? Do you mean people want languages already available with Gedit, or others?

JesseVanDenKieboom: Yes, how do you get highlighting for this or that language. The problem is that we tell people that they need to create a new .lang file, optionally add a new mime type etc. The problem is that 1) this is actually a GtkSourceView thing 2) it's probably to technical for the manual. Another thing that might be added to the manual is how to write your own plugins in gedit.

CategoryDocumentationProject