[gedit-plugins] Add user help, bug 700076
- From: Ekaterina Gerasimova <egerasimov src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gedit-plugins] Add user help, bug 700076
- Date: Fri, 17 May 2013 06:47:27 +0000 (UTC)
commit 9fafdc035f3f26b18025919294a6315161588d84
Author: Ekaterina Gerasimova <kittykat3756 gmail com>
Date: Thu May 16 20:07:29 2013 +0100
Add user help, bug 700076
Add help pages for the plugins, which used to be in the gedit help and
were removed from there in commit
ca59dc566b7f948086be85b29f8da205d8f4c83c.
Makefile.am | 2 +-
configure.ac | 3 +
help/C/bookmarks.page | 52 +++++++++++++++++++
help/C/bracket-comp.page | 27 ++++++++++
help/C/character-map.page | 60 ++++++++++++++++++++++
help/C/code-assistance.page | 51 +++++++++++++++++++
help/C/code-comment.page | 45 ++++++++++++++++
help/C/color-picker.page | 48 ++++++++++++++++++
help/C/commander.page | 69 +++++++++++++++++++++++++
help/C/dashboard.page | 51 +++++++++++++++++++
help/C/draw-spaces.page | 49 ++++++++++++++++++
help/C/join-split-lines.page | 47 +++++++++++++++++
help/C/multi-edit.page | 46 +++++++++++++++++
help/C/session-saver.page | 52 +++++++++++++++++++
help/C/tag-list.page | 114 ++++++++++++++++++++++++++++++++++++++++++
help/C/terminal.page | 59 ++++++++++++++++++++++
help/C/text-size.page | 63 +++++++++++++++++++++++
help/C/word-completion.page | 51 +++++++++++++++++++
help/Makefile.am | 25 +++++++++
19 files changed, 913 insertions(+), 1 deletions(-)
---
diff --git a/Makefile.am b/Makefile.am
index cc945a3..71a0f52 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,4 +1,4 @@
-SUBDIRS = plugins po
+SUBDIRS = help plugins po
ACLOCAL_AMFLAGS = -I m4 ${ACLOCAL_FLAGS}
diff --git a/configure.ac b/configure.ac
index a37af73..4d52805 100644
--- a/configure.ac
+++ b/configure.ac
@@ -304,6 +304,8 @@ AC_SUBST([BUILD_PLUGINS],[$PLUGINS])
AC_PATH_PROG(GLIB_COMPILE_RESOURCES, glib-compile-resources)
AC_PATH_PROG(GLIB_GENMARSHAL, glib-genmarshal)
+YELP_HELP_INIT
+
AC_ARG_ENABLE(deprecations,
[AS_HELP_STRING([--enable-deprecations],
[warn about deprecated usages [default=no]])],,
@@ -335,6 +337,7 @@ AC_SUBST(GEDIT_PLUGINS_DATA_DIR)
AC_CONFIG_FILES([
Makefile
+help/Makefile
plugins/gpdefs.py
plugins/Makefile
plugins/bookmarks/bookmarks.plugin.desktop.in
diff --git a/help/C/bookmarks.page b/help/C/bookmarks.page
new file mode 100644
index 0000000..76c56e8
--- /dev/null
+++ b/help/C/bookmarks.page
@@ -0,0 +1,52 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="topic" style="task"
+ id="gedit-plugins-bookmarks">
+ <info>
+ <link type="guide" xref="gedit-plugin-guide#gedit-additional-plugins"/>
+ <revision version="3.4" date="2013-02-24" status="review"/>
+
+ <credit type="author">
+ <name>Jim Campbell</name>
+ <email>jwcampbell gmail com</email>
+ </credit>
+
+ <desc>Record commonly-referenced locations with bookmarks</desc>
+ </info>
+
+ <title>Bookmarks</title>
+
+ <p>Gedit bookmarks allow you to highlight important lines of text within your
+ document or program, making them easier to find. You can also move up or
+ down between bookmarks, making document navigation a bit faster.</p>
+
+ <p>To enable the bookmark plugin, select <guiseq><gui style="menu">gedit</gui>
+ <gui style="menuitem">Preferences</gui><gui>Plugins</gui>
+ <gui>Bookmarks</gui></guiseq>.</p>
+
+ <steps>
+ <title>Bookmarks are inserted and removed by completing the same action. To
+ insert or remove bookmarks:</title>
+ <item><p>Navigate to the line where you want to insert or remove the
+ bookmark.</p></item>
+ <item><p>Press <keyseq><key>Ctrl</key><key>Alt</key><key>B</key></keyseq>,
+ or click <guiseq><gui style="menu">Edit</gui>
+ <gui style="menuitem">Toggle Bookmark</gui></guiseq>.</p></item>
+ </steps>
+
+ <steps>
+ <title>To move between bookmarks:</title>
+ <item><p>Press <keyseq><key>Ctrl</key><key>B</key></keyseq> to move to the
+ next bookmark.</p></item>
+ <item><p>Press <keyseq><key>Ctrl</key><key>Shift</key><key>B</key></keyseq>
+ to move to the previous bookmark.</p>
+ <note><p>If you prefer using the mouse, you can click <guiseq>
+ <gui style="menu">gedit</gui>
+ <gui style="menuitem">Go to Next Bookmark</gui></guiseq> or
+ <guiseq><gui style="menu">Edit</gui>
+ <gui style="menuitem">Go to Previous Bookmark</gui></guiseq>.</p></note>
+ </item>
+ </steps>
+
+
+
+</page>
diff --git a/help/C/bracket-comp.page b/help/C/bracket-comp.page
new file mode 100644
index 0000000..ca391f7
--- /dev/null
+++ b/help/C/bracket-comp.page
@@ -0,0 +1,27 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="topic" style="task"
+ id="gedit-plugins-bracket-comp">
+
+ <info>
+ <link type="guide" xref="gedit-plugin-guide#gedit-additional-plugins"/>
+ <revision pkgversion="3.8" date="2013-02-24" status="review"/>
+ <credit type="author">
+ <name>Jim Campbell</name>
+ <email>jwcampbell gmail com</email>
+ </credit>
+ <desc>Auto-complete closing brackets</desc>
+ </info>
+
+ <title>Bracket completion</title>
+
+ <p>The <app>Bracket Completion</app> plugin will auto-complete closing
+ brackets for curly braces, parentheses, and square brackets.</p>
+
+ <p>To enable the plugin, select <guiseq><gui style="menu">gedit</gui>
+ <gui style="menuitem">Preferences</gui><gui>Plugins</gui>
+ <gui>Bracket Completion</gui></guiseq>.</p>
+
+ <note><p>This plugin does not automatically insert closing HTML or XML
+ tags.</p></note>
+
+</page>
diff --git a/help/C/character-map.page b/help/C/character-map.page
new file mode 100644
index 0000000..4be2390
--- /dev/null
+++ b/help/C/character-map.page
@@ -0,0 +1,60 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="topic" style="task"
+ id="gedit-plugins-character-map">
+ <info>
+ <revision version="0.2" date="2013-02-24" status="review"/>
+ <link type="guide" xref="gedit-plugin-guide#gedit-additional-plugins"/>
+
+ <credit type="author">
+ <name>Jim Campbell</name>
+ <email>jwcampbell gmail com</email>
+ </credit>
+
+ <credit type="author">
+ <name>Paul Weaver</name>
+ <email>ch3pjw bath ac uk</email>
+ </credit>
+
+ <desc>Insert special characters just by clicking on them</desc>
+ </info>
+
+ <title>Character map</title>
+
+ <comment>
+ <cite date="2013-02-24" href="mailto:ch3pjw bath ac uk">Paul Weaver</cite>
+ <p>This assumes the reader knows how to use gedit in general. By the end of
+ this page, the reader will be able to use the character map plugin to
+ insert characters into their documents.</p>
+ </comment>
+
+ <p>The <app>Character Map</app> plugin enables you to insert characters into
+ your document that you may not be able to type easily using your keyboard. To
+ enable this plugin, select <guiseq><gui style="menu">gedit</gui>
+ <gui style="menuitem">Preferences</gui><gui>Plugins</gui>
+ <gui>Character Map</gui></guiseq>.</p>
+
+ <section id="using-character-map">
+ <title>Using Character Map</title>
+
+ <p>Once the plugin is enabled, you can add characters from the
+ <em>Character Map</em> tab of the side panel (<guiseq><gui>View</gui>
+ <gui>Side Panel</gui></guiseq>).</p>
+
+ <steps>
+ <item><p>Place the cursor at the point in your document at which you would
+ like your special character.</p></item>
+ <item><p>Open the side panel by selecting <guiseq><gui>View</gui>
+ <gui>Side Panel</gui></guiseq>, or by pressing <key>F9</key>.</p></item>
+ <item><p>Select the <em>Character Map</em> tab in the side
+ panel.</p></item>
+ <item><p>If neccessary, choose the character set to which your character
+ belongs from the list at the top of the <em>Character Map</em> tab (e.g.,
+ Arabic).</p></item>
+ <item><p>Double click your desired character to insert it.</p></item>
+ </steps>
+
+ <note style="tip"><p>You must click on the editing view of your document to
+ continue editing normally.</p></note>
+ </section>
+
+</page>
diff --git a/help/C/code-assistance.page b/help/C/code-assistance.page
new file mode 100644
index 0000000..307de94
--- /dev/null
+++ b/help/C/code-assistance.page
@@ -0,0 +1,51 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="topic" style="task"
+ id="gedit-plugins-code-assistance">
+ <info>
+ <link type="guide" xref="gedit-plugin-guide#gedit-additional-plugins"/>
+ <revision version="3.4" date="2013-02-24" status="review"/>
+
+ <credit type="author">
+ <name>Jim Campbell</name>
+ <email>jwcampbell gmail com</email>
+ </credit>
+
+ <desc>Real-time error highlighting for supported languages</desc>
+ </info>
+
+ <title>Code assistance</title>
+
+ <!-- NOTE: This is draft documentation. It is not yet ready for translation.
+ Thank you! -->
+
+ <p>The <app>gedit-code-assistance</app> plugin provides real-time error
+ highlighting for C, C++ and Objective-C. To enable this plugin, select
+ <guiseq><gui style="menu">gedit</gui><gui style="menuitem">Preferences</gui>
+ <gui>Plugins</gui><gui>Code Assistance</gui></guiseq>.</p>
+
+ <!--
+ <section id="code-assistance-features">
+ <title>Code assistance features</title>
+ <list>
+ <item><p>Feature #1</p></item>
+ <item><p>Feature #2</p></item>
+ <item><p>Feature #3</p></item>
+ <item><p>Feature #4</p></item>
+ </list>
+ </section>
+ -->
+
+ <section id="how-gedit-code-assistance-works">
+ <title>How the code assistance plugin works</title>
+
+ <p>The plugin currently relies on information in the makefile to deduce the
+ Clang error-highlighting rules. It examines the <code>make</code> rules
+ and determines which targets depend on the the file that is being parsed.
+ The plugin then extracts the compiler flags by simulating an
+ execution of those targets.</p>
+
+ <p>This is not completely fool proof, of course. In the future, the plugin
+ will allow you to manually specify the compile flags.</p>
+ </section>
+
+</page>
diff --git a/help/C/code-comment.page b/help/C/code-comment.page
new file mode 100644
index 0000000..e64552c
--- /dev/null
+++ b/help/C/code-comment.page
@@ -0,0 +1,45 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="topic" style="task"
+ id="gedit-plugins-code-comment">
+ <info>
+ <link type="guide" xref="gedit-plugin-guide#gedit-additional-plugins"/>
+ <revision version="3.4" date="2013-02-24" status="review"/>
+
+ <credit type="author">
+ <name>Jim Campbell</name>
+ <email>jwcampbell gmail com</email>
+ </credit>
+
+ <desc>Comment-out or uncomment a block of code</desc>
+ </info>
+
+ <title>Code comment</title>
+
+ <p>Code comments are portions of text that make it easier for people to
+ understand a program's code, but they don't affect how a program works.
+ Comments are separated from other parts of a program by special
+ characters.</p>
+
+ <p>The <app>code comment</app> plugin makes it easier to quickly create or
+ remove code comments. To enable the code comment plugin, select
+ <guiseq><gui style="menu">gedit</gui><gui style="menuitem">Preferences</gui>
+ <gui>Plugins</gui><gui>Code comment</gui></guiseq>.</p>
+
+ <p>To create or remove a comment:</p>
+ <steps>
+ <item><p>Highlight the portion of text where you want to add or remove
+ a comment.</p></item>
+ <item><p>To add a comment, click <guiseq><gui style="menu">gedit</gui>
+ <gui>Comment Code</gui></guiseq>, or press <keyseq><key>Ctrl</key>
+ <key>M</key></keyseq>.</p></item>
+ <item><p>To remove a comment, click <guiseq><gui style="menu">gedit</gui>
+ <gui>Uncomment Code</gui></guiseq>, or press <keyseq><key>Shift</key>
+ <key>Ctrl</key><key>M</key></keyseq>.</p></item>
+ </steps>
+
+ <note style="tip"><p><app>gedit</app> will automatically use the correct
+ style of comment based on the language or syntax of the file. If
+ <app>gedit</app> doesn't identify your language or syntax, you can select it
+ from the language list in the bottom <gui>Status bar</gui>.</p></note>
+
+</page>
diff --git a/help/C/color-picker.page b/help/C/color-picker.page
new file mode 100644
index 0000000..7cc0cfe
--- /dev/null
+++ b/help/C/color-picker.page
@@ -0,0 +1,48 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="topic" style="task"
+ id="gedit-plugins-color-picker">
+ <info>
+ <link type="guide" xref="gedit-plugin-guide#gedit-additional-plugins"/>
+ <revision version="3.4" date="2013-02-24" status="review"/>
+
+ <credit type="author">
+ <name>Jim Campbell</name>
+ <email>jwcampbell gmail com</email>
+ </credit>
+
+ <desc>Pick a color from a dialog and insert its hexadecimal representation
+ </desc>
+ </info>
+
+ <title>Color picker</title>
+
+ <p>The <app>color picker</app> plugin helps you to insert the character
+ codes that represent a certain color. This can make it easier to choose
+ and use the correct color in your programs.</p>
+
+ <p>To enable the color picker plugin, select <guiseq>
+ <gui style="menu">gedit</gui><gui style="menuitem">Preferences</gui>
+ <gui>Plugins</gui><gui>Color Picker</gui></guiseq>.</p>
+
+ <p>To open and use the color picker:</p>
+ <steps>
+ <item><p>Place your cursor at the point in your document where you want
+ to insert the color code.</p></item>
+ <item><p>Select <guiseq><gui>Tools</gui><gui>Pick Color...</gui></guiseq>.
+ The color picker dialog will appear.</p></item>
+ <item><p>Click on the desired color in the color picker window.</p>
+ </item>
+ <item><p>The appropriate color code will be inserted where you had placed
+ your cursor.</p></item>
+ <item><p>To close the <app>color picker</app>, click <gui>Close</gui>.
+ </p></item>
+ </steps>
+
+ <!--TODO: Update this section for the "Custom" values -->
+ <note style="tip"><p>You can make fine-grained adjustments to the color by
+ adjusting the values for Hue, Saturation, Value, Red, Green, or Blue.</p>
+ <p>Additionally, you can save colors by right-clicking on any of the colored
+ boxes in the color picker, and selecting <gui>Save color here</gui>. This
+ will make it easier to insert commonly-used colors later.</p>
+ </note>
+</page>
diff --git a/help/C/commander.page b/help/C/commander.page
new file mode 100644
index 0000000..7e96206
--- /dev/null
+++ b/help/C/commander.page
@@ -0,0 +1,69 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="topic" style="task"
+ id="gedit-plugins-commander">
+ <info>
+ <link type="guide" xref="gedit-plugin-guide#gedit-additional-plugins"/>
+ <revision version="3.4" date="2013-02-24" status="review"/>
+
+ <credit type="author">
+ <name>Jim Campbell</name>
+ <email>jwcampbell gmail com</email>
+ </credit>
+
+ <desc>Use a command-line interface for advanced editing</desc>
+ </info>
+
+ <title>Commander</title>
+
+
+ <p>The <app>Commander</app> plugin is a plugin for advanced <app>gedit</app>
+ users that allows you to perform command-line actions on the current
+ file. To enable the commander plugin, select <guiseq>
+ <gui style="menu">gedit</gui><gui style="menuitem">Preferences</gui>
+ <gui>Plugins</gui><gui>Commander</gui></guiseq>.</p>
+
+ <p>Once you have enabled the plugin, activate it by pressing <keyseq><key>
+ Ctrl</key><key>.</key></keyseq>.</p>
+
+ <note style="tip"><p>The last key in the above key combination is a period.
+ </p></note>
+
+ <table frame="all" rules="all">
+ <thead>
+ <tr>
+ <td><p>To Do This</p></td> <td><p>Press This</p></td>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><p>See an overview of available commands</p></td> <td><p>Tab + Tab
+ </p></td>
+ </tr>
+ <tr>
+ <td><p>Find a word within the current file</p></td> <td><p>/ <em>foo
+ </em></p>
+ <p>This will find the word <em>foo</em>.</p></td>
+ </tr>
+ <tr>
+ <td><p>Replace a word within the current file</p></td> <td><p>// foo
+ bar</p>
+ <p>This will replace <em>foo</em> with <em>bar</em>.</p></td>
+ </tr>
+ <tr>
+ <td><p>Move the cursor to a certain line number in your file</p></td>
+ <td><p>go [line number] <em>or</em> just <em>g</em> [line number]</p>
+ </td>
+ </tr>
+ <tr>
+ <td><p>Toggle the bookmark indicator for the current line</p></td>
+ <td><p>bookmark <em>or</em> just <em>b</em></p></td>
+ </tr>
+ </tbody>
+ </table>
+
+ <note style="tip"><p>Some commands, such as the <app>bookmark</app> command
+ require that the appropriate plugin be installed and activated. If you do not
+ have the appropriate plugin installed and activated, you will receive an
+ error message.</p></note>
+
+</page>
diff --git a/help/C/dashboard.page b/help/C/dashboard.page
new file mode 100644
index 0000000..800c227
--- /dev/null
+++ b/help/C/dashboard.page
@@ -0,0 +1,51 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="topic" style="task"
+ id="gedit-plugins-dashboard">
+ <info>
+ <link type="guide" xref="gedit-plugin-guide#gedit-additional-plugins"/>
+ <revision version="3.4" date="2013-02-24" status="review"/>
+
+ <credit type="author">
+ <name>Jim Campbell</name>
+ <email>jwcampbell gmail com</email>
+ </credit>
+
+ <desc>Display recently-used and most-used files on startup</desc>
+ </info>
+
+ <title>Dashboard</title>
+
+ <p>The <app>Dashboard</app> plugin provides quick access to your most
+ recently-used files and most-frequently used files. To
+ activate the <app>Dashboard</app> plugin, select <guiseq>
+ <gui style="menu">gedit</gui><gui style="menuitem">Preferences</gui>
+ <gui>Plugins</gui><gui>Dashboard</gui></guiseq>. You will need to restart
+ <app>gedit</app> to activate the <app>Dashboard</app> plugin.</p>
+
+ <p>The <app>dashboard</app> also includes a <gui>Search</gui> window,
+ allowing you to search for files that may not appear in the list of files.</p>
+
+ <section id="gedit-recently-used">
+ <title>Recently used files</title>
+ <p>The dashboard will initially display a shortcut for an <gui>empty
+ document</gui> and seven of your most recently-used files. Click on the
+ <gui>empty document</gui> to create a new file. Click on any of the other
+ files to open that file.</p>
+ </section>
+
+ <section id="gedit-most-used">
+ <title>Most frequently-used files</title>
+ <p>Similarly, the dashboard displays a shortcut for an <gui>empty document
+ </gui> and seven of your most frequently-used files. Click on the <gui>
+ empty document</gui> to create a new file. Click on any of the other
+ files to open that file.</p>
+
+ <note style="tip"><p>Once activated, the <app>dashboard</app> will be
+ displayed by default when you open <app>gedit</app>. You can also open the
+ <app>dashboard</app> by clicking <guiseq><gui>File</gui><gui>New</gui>
+ </guiseq>, or by pressing <keyseq><key>Ctrl</key><key>N</key></keyseq>.</p>
+ </note>
+
+ </section>
+
+</page>
diff --git a/help/C/draw-spaces.page b/help/C/draw-spaces.page
new file mode 100644
index 0000000..b2dec15
--- /dev/null
+++ b/help/C/draw-spaces.page
@@ -0,0 +1,49 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="topic" style="task"
+ id="gedit-plugins-draw-spaces">
+ <info>
+ <link type="guide" xref="gedit-plugin-guide#gedit-additional-plugins"/>
+ <revision version="3.8" date="2013-02-24" status="review"/>
+
+ <credit type="author">
+ <name>Jim Campbell</name>
+ <email>jwcampbell gmail com</email>
+ </credit>
+
+ <desc>Show white space between words or portions of code</desc>
+ </info>
+
+ <title>Draw spaces</title>
+
+ <p>The <app>Draw Spaces</app> plugin is a simple plugin that can mark spaces,
+ tabs, and other types of whitespace with a small, visible marker. By making
+ whitespace visible, you can more easily see how whitespace is used in a
+ document, and can apply spacing strategies more consistently.</p>
+
+ <p>To enable this plugin, select <guiseq><gui style="menu">gedit</gui>
+ <gui style="menuitem">Preferences</gui><gui>Plugins</gui>
+ <gui>Draw Spaces</gui></guiseq>. After you have enabled the plugin, you can
+ set its options by highlighting the plugin and selecting
+ <gui style="menuitem">Preferences</gui>.</p>
+
+ <list>
+ <title>By default, the <app>Draw Spaces</app> plugin will mark the following
+ types of whitespace in a file:</title>
+ <item><p>Spaces</p></item>
+ <item><p>Tabs</p></item>
+ <item><p>Leading spaces</p></item>
+ <item><p>Spaces in text</p></item>
+ <item><p>Trailing spaces</p></item>
+ </list>
+
+ <list>
+ <title>You can also set the plugin to mark:</title>
+ <item><p>New Lines</p></item>
+ <item><p>Non-breaking spaces</p></item>
+ </list>
+
+ <note style="tip"><p>Though you will be able to see the dots when you work on
+ a file, the dots will not be visible when you print a file to
+ paper.</p></note>
+
+</page>
diff --git a/help/C/join-split-lines.page b/help/C/join-split-lines.page
new file mode 100644
index 0000000..a79f86a
--- /dev/null
+++ b/help/C/join-split-lines.page
@@ -0,0 +1,47 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="topic" style="task"
+ id="gedit-plugins-join-split-lines">
+ <info>
+ <link type="guide" xref="gedit-plugin-guide#gedit-additional-plugins"/>
+ <revision version="3.8" date="2013-02-24" status="review"/>
+
+ <credit type="author">
+ <name>Jim Campbell</name>
+ <email>jwcampbell gmail com</email>
+ </credit>
+
+ <desc>Join several lines of text, or split long lines</desc>
+ </info>
+
+ <title>Join/Split lines</title>
+
+ <p>The <app>Join/Split Lines</app> plugin can join shorter lines into one
+ longer line, or can split a long line into multiple shorter lines.</p>
+
+ <p>To enable this plugin, select <guiseq><gui style="menu">gedit</gui>
+ <gui style="menuitem">Preferences</gui><gui>Plugins</gui>
+ <gui>Join/Split Lines</gui></guiseq>.</p>
+
+ <steps>
+ <title>To join multiple lines into one longer line:</title>
+ <item><p>Select the lines that you want to join. To do this, you can use
+ the mouse, or you can press <keyseq><key>Shift</key><key>Up Arrow</key>
+ </keyseq> or <keyseq><key>Shift</key><key>Down Arrow</key></keyseq>.</p>
+ </item>
+ <item><p>Press <keyseq><key>Ctrl</key><key>J</key></keyseq>.</p>
+ <p>The lines that you selected will be joined into one longer line.</p>
+ </item>
+ </steps>
+
+ <steps>
+ <title>To split one line into multiple lines:</title>
+ <item><p>Select the line that you want to split by placing your cursor
+ anywhere on that line.</p></item>
+ <item><p>Press <keyseq><key>Ctrl</key><key>Shift</key><key>J</key></keyseq>.
+ </p>
+ <p>The line will be split into multiple lines. Spaces are used to determine
+ where it is safe to split a line, and the length of each line will
+ not exceed 80 characters.</p></item>
+ </steps>
+
+</page>
diff --git a/help/C/multi-edit.page b/help/C/multi-edit.page
new file mode 100644
index 0000000..b4b5eb7
--- /dev/null
+++ b/help/C/multi-edit.page
@@ -0,0 +1,46 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="topic" style="task"
+ id="gedit-plugins-multi-edit">
+ <info>
+ <link type="guide" xref="gedit-plugin-guide#gedit-additional-plugins"/>
+ <revision version="3.4" date="2013-02-24" status="review"/>
+
+ <credit type="author">
+ <name>Jim Campbell</name>
+ <email>jwcampbell gmail com</email>
+ <years>2011</years>
+ </credit>
+
+ <desc>Edit a document in multiple places at once</desc>
+ </info>
+
+ <title>Multi edit</title>
+
+ <p>The <app>Multi Edit</app> plugin allows you to edit a document in multiple
+ places at once. This can be helpful when performing tedious editing tasks. To
+ enable the Multi Edit plugin, select <guiseq><gui style="menu">gedit</gui><gui>
+ Preferences</gui><gui>Plugins</gui><gui>Multi Edit</gui></guiseq>.</p>
+
+ <p>After you have enabled the plugin, turn-on Multi Edit mode by pressing
+ <keyseq><key>Ctrl</key><key>Shift</key><key>C</key></keyseq>, or clicking
+ <guiseq><gui style="menu">gedit</gui><gui>Multi Edit Mode</gui></guiseq>. You can then
+ select the points in your file that you would like start editing.</p>
+
+ <p>To insert editing points in your file:</p>
+ <steps>
+ <item><p>Place your cursor at your first desired editing point.</p></item>
+ <item><p>Press <keyseq><key>Ctrl</key><key>E</key></keyseq>.</p></item>
+ <item><p>Move to your next editing point, and press <keyseq><key>Ctrl</key>
+ <key>E</key></keyseq> again.</p></item>
+ <item><p>Continue inserting editing points, adding as many as you need.</p>
+ </item>
+ </steps>
+
+ <p>Once you have inserted all of your editing points, you can make your
+ desired edits.</p>
+
+ <p>To remove editing points, press the <key>Esc</key> key. This will remove
+ all of the editing points. Pressing the <key>Esc</key> key again will turn
+ off Multi Edit mode, returning the editor back to its normal state.</p>
+
+</page>
diff --git a/help/C/session-saver.page b/help/C/session-saver.page
new file mode 100644
index 0000000..2b64ef4
--- /dev/null
+++ b/help/C/session-saver.page
@@ -0,0 +1,52 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="topic" style="task"
+ id="gedit-plugins-session-saver">
+ <info>
+ <link type="guide" xref="gedit-plugin-guide#gedit-additional-plugins"/>
+ <revision version="3.4" date="2013-02-24" status="review"/>
+
+ <credit type="author">
+ <name>Jim Campbell</name>
+ <email>jwcampbell gmail com</email>
+ </credit>
+
+ <desc>Save and restore your working sessions</desc>
+ </info>
+
+ <title>Session Saver</title>
+
+ <p>The <app>Session Saver</app> plugin saves groups of files
+ together so that you can open them together at a later time. To enable the
+ plugin, select <guiseq><gui style="menu">gedit</gui>
+ <gui style="menuitem">Preferences</gui><gui>Plugins</gui>
+ <gui>Session Saver</gui></guiseq>.</p>
+
+ <steps>
+ <title>To save a new session:</title>
+ <item><p>Select <guiseq><gui>File</gui><gui>Saved Sessions</gui><gui>Save
+ current session</gui></guiseq>.</p></item>
+ <item><p>Type a session name in the <gui>Save session</gui> dialog box.
+ </p></item>
+ <item><p>Click <gui>Save</gui>.</p></item>
+ </steps>
+
+ <steps>
+ <title>To open an existing session:</title>
+ <item><p>Select <guiseq><gui>File</gui><gui>Saved Sessions</gui></guiseq>.
+ </p></item>
+ <item><p>Click the name of your desired session.</p></item>
+ </steps>
+
+ <steps>
+ <title>To delete an existing session:</title>
+ <item><p>Select <guiseq><gui>File</gui><gui>Saved Sessions</gui><gui>
+ Manage saved sessions</gui></guiseq>.</p></item>
+ <item><p>Select the name of the session that you want to delete.</p>
+ </item>
+ <item><p>Click <gui>Delete</gui>.</p></item>
+ <item><p>Click <gui>Close</gui>.</p>
+ <p>The session name will still be listed in your list of sessions until
+ you close <app>gedit</app>.</p></item>
+ </steps>
+
+</page>
diff --git a/help/C/tag-list.page b/help/C/tag-list.page
new file mode 100644
index 0000000..57782e5
--- /dev/null
+++ b/help/C/tag-list.page
@@ -0,0 +1,114 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="topic" style="task"
+ id="gedit-plugins-tag-list">
+
+<info>
+ <link type="guide" xref="gedit-plugin-guide#gedit-default-plugins"/>
+ <revision pkgversion="3.8" date="2013-02-24" status="review"/>
+ <revision pkgversion="3.8" date="2013-03-22" status="review"/>
+ <credit type="author">
+ <name>Daniel Neel</name>
+ <email>dneelyep gmail com</email>
+ </credit>
+ <credit type="author">
+ <name>Jim Campbell</name>
+ <email>jwcampbell gmail com</email>
+ </credit>
+ <credit type="editor">
+ <name>Sindhu S</name>
+ <email>sindhus live in</email>
+ </credit>
+ <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+ <desc>Automatically insert tags, strings and special characters into a
+ document</desc>
+</info>
+
+ <title>Tag list</title>
+
+ <p>The <app>Tag List</app> plugin allows you to insert common tags and
+ special characters from a list in the side pane. By default, the plugin can
+ insert tags and special characters for <app>HTML</app>, <app>XHTML</app>,
+ <app>XSLT</app>, <app>XUL</app> and <app>LaTeX</app>.</p>
+
+ <section id="enable-tag-list-plugin">
+ <title>Enable Tag List Plugin</title>
+
+ <p>To enable the <app>Tag List</app> plugin:</p>
+
+ <steps>
+ <item>
+ <p>Select <guiseq><gui style="menu">gedit</gui>
+ <gui style="menuitem">Preferences</gui>
+ <gui style="tab">Plugins</gui></guiseq>.</p>
+ </item>
+ <item>
+ <p>Select <gui style="menuitem">Tag List</gui> to enable the
+ plugin.</p>
+ </item>
+ <item>
+ <p>Access the tag list by selecting
+ <guiseq><gui style="menu">View</gui>
+ <gui style="menuitem">Side Pane</gui></guiseq>, or by pressing
+ <key>F9</key>.</p>
+ </item>
+ </steps>
+
+ <p>The side pane will initially show a list of open documents, so to view
+ and use the <app>Tag List</app>, you will need to click on the tab showing
+ the "plus" icon at the bottom of the side pane. The icon will look similar
+ to this:</p>
+
+ <p>
+ <media type="image" mime="image/png" src="figures/gedit-side-pane3.png"/>
+ </p>
+ </section>
+
+ <section id="inserting-tags">
+ <title>Inserting Tags and Special Characters</title>
+
+ <p>The <app>tag list</app> uses a drop-down menu to let you choose from the
+ different types of tags. For example, one tag option is <gui>HTML -
+ Tags</gui>.</p>
+
+ <p>To start inserting tags, complete the following:</p>
+
+ <steps>
+ <item>
+ <p>Move the cursor to where you will want to insert the tag or special
+ character.</p>
+ </item>
+ <item>
+ <p>Select the desired tag type from the drop-down menu at the top of
+ the side pane.</p>
+ </item>
+ <item>
+ <p>Scroll through the list to find the desired tag or character.</p>
+ </item>
+ <item>
+ <p>Double-click on the tag in the tag list.</p>
+ </item>
+ </steps>
+
+ <p>The tag or special character you have chosen will then be displayed in
+ your document.</p>
+ </section>
+
+ <section id="tag-list-tips">
+ <title>Tag List Tips</title>
+ <note style="tip">
+ <p>You can also insert a tag by pressing <key>Return</key> or
+ <keyseq><key>Shift</key><key>Return</key></keyseq>.</p>
+ <p>Pressing the <key>Return</key> key will insert the tag at the cursor
+ position, and then return focus to the document. Pressing
+ <keyseq><key>Shift</key><key>Return</key></keyseq> will insert the tag at
+ the cursor position, but will keep the focus on the
+ <app>tag-list</app>.</p>
+ </note>
+
+ <note style="tip">
+ <p>You can see a preview of what text will be inserted for each tag and
+ special character by clicking on the word the <gui>Preview</gui> at the
+ bottom of the side pane.</p>
+ </note>
+ </section>
+</page>
diff --git a/help/C/terminal.page b/help/C/terminal.page
new file mode 100644
index 0000000..ab4d3a0
--- /dev/null
+++ b/help/C/terminal.page
@@ -0,0 +1,59 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="topic" style="task"
+ id="gedit-plugins-terminal">
+
+ <info>
+ <link type="guide" xref="gedit-plugin-guide#gedit-additional-plugins"/>
+ <link type="seealso" xref="gedit-plugins-pyconsole"/>
+ <revision pkgversion="3.8" date="2013-02-24" status="review"/>
+ <credit type="author">
+ <name>Jim Campbell</name>
+ <email>jwcampbell gmail com</email>
+ </credit>
+ <credit type="author">
+ <name>Sindhu S</name>
+ <email>sindhus live in</email>
+ </credit>
+ <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+ <desc>Add a terminal console to the bottom pane</desc>
+ </info>
+
+ <title>Embedded terminal</title>
+
+ <p><app>gedit</app> makes it possible to include an embedded version of
+ <app>GNOME Terminal</app>, the GNOME command-line application, in the bottom
+ pane of the <app>gedit</app> window. This will let you run scripts, install
+ needed software, or test your program without leaving <app>gedit</app>.</p>
+
+ <section id="enable-embedded-terminal">
+ <title>Enable Embedded Terminal</title>
+
+ <p>To enable the Embedded Terminal plugin:</p>
+
+ <steps>
+ <item>
+ <p>Select <guiseq><gui style="menu">gedit</gui>
+ <gui style="menuitem">Preferences</gui>
+ <gui style="tab">Plugins</gui></guiseq>.</p>
+ </item>
+ <item>
+ <p>Select <gui style="menuitem">Embedded Terminal</gui> to enable the plugin.</p>
+ </item>
+ </steps>
+ </section>
+
+ <section id="using-embedded-terminal">
+ <title>Using Embedded Terminal</title>
+
+ <p>Once you have enabled the plugin, to add a terminal to the bottom
+ pane:</p>
+
+ <steps>
+ <item>
+ <p>Select <guiseq><gui style="menu">View</gui>
+ <gui style="menuitem">Bottom Pane</gui></guiseq>. Alternatively, you
+ can press <keyseq><key>Ctrl</key><key>F9</key></keyseq>.</p>
+ </item>
+ </steps>
+ </section>
+</page>
diff --git a/help/C/text-size.page b/help/C/text-size.page
new file mode 100644
index 0000000..8c9ffbe
--- /dev/null
+++ b/help/C/text-size.page
@@ -0,0 +1,63 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="topic" style="task"
+ id="gedit-plugins-text-size">
+ <info>
+ <link type="guide" xref="gedit-plugin-guide#gedit-additional-plugins"/>
+ <link type="seealso" xref="gedit-change-default-font"/>
+ <revision version="3.4" date="2013-02-24" status="review"/>
+ <credit type="author">
+ <name>Jim Campbell</name>
+ <email>jwcampbell gmail com</email>
+ </credit>
+ <credit type="author">
+ <name>Sindhu S</name>
+ <email>sindhus live in</email>
+ </credit>
+ <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+ <desc>Increase or decrease text size</desc>
+ </info>
+
+ <title>Text Size</title>
+
+ <p>The text size plugin allows you to temporarily change the text size for
+ better readibility in <app>gedit</app> without changing the program's default
+ text size.</p>
+
+ <section id="enable-text-size">
+ <title>Enable Text Size Plugin</title>
+
+ <p>To enable Text Size plugin:</p>
+ <steps>
+ <item>
+ <p>Select <guiseq><gui style="menu">gedit</gui>
+ <gui style="menuitem">Preferences</gui>
+ <gui style="tab">Plugins</gui></guiseq>.</p>
+ </item>
+ <item>
+ <p>Select <gui style="menuitem">Text Size</gui> to enable the
+ plugin.</p>
+ </item>
+ </steps>
+ </section>
+
+ <section id="use-text-size">
+ <title>Use Text Size Plugin</title>
+ <p>Once you have enabled the plugin, do any of the following to change the
+ text size in <app>gedit</app>:</p>
+
+ <list>
+ <item>
+ <p>To <em>increase</em> the text size, press
+ <keyseq><key>Ctrl</key><key>+</key></keyseq>.</p>
+ </item>
+ <item>
+ <p>To <em>decrease</em> the text size, press
+ <keyseq><key>Ctrl</key><key>-</key></keyseq>.</p>
+ </item>
+ <item>
+ <p>To <em>reset</em> the text size to the default size, press
+ <keyseq><key>Ctrl</key><key>0</key></keyseq>.</p>
+ </item>
+ </list>
+ </section>
+</page>
\ No newline at end of file
diff --git a/help/C/word-completion.page b/help/C/word-completion.page
new file mode 100644
index 0000000..42d26c8
--- /dev/null
+++ b/help/C/word-completion.page
@@ -0,0 +1,51 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="topic" style="task"
+ id="gedit-plugins-word-completion">
+ <info>
+ <revision pkgversion="3.8" date="2013-02-24" status="review"/>
+ <link type="guide" xref="gedit-plugin-guide#gedit-additional-plugins"/>
+
+ <credit type="author">
+ <name>Jim Campbell</name>
+ <email>jwcampbell gmail com</email>
+ </credit>
+ <credit type="author">
+ <name>Paul Weaver</name>
+ <email>ch3pjw bath ac uk</email>
+ </credit>
+ <credit type="author">
+ <name>Sindhu S</name>
+ <email>sindhus live in</email>
+ </credit>
+ <desc>Autocomplete words or portions of code as you type</desc>
+ <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+ </info>
+
+ <title>Word completion</title>
+
+ <p>The <app>Word Completion</app> plugin can speed up your editing by
+ suggesting completions of words as you type. To enable the plugin:</p>
+
+ <steps>
+ <item>
+ <p>Select <guiseq><gui style="menu">Edit</gui>
+ <gui style="menuitem">Preferences</gui>
+ <gui style="tab">Plugins</gui></guiseq>.</p>
+ </item>
+ <item>
+ <p>Select <gui style="menuitem">Word Completion</gui> to enable the
+ plugin.</p>
+ </item>
+ </steps>
+
+ <p>While editing, the <app>Word Completion</app> plugin will automatically
+ display a pop-up list of words that begin with the letters you have already
+ typed. Word suggestions are based upon words that appear elsewhere in your
+ document and upon pre-defined keywords if your document is of a recognised
+ format.</p>
+
+ <p>To insert a suggested word, double-click on it in the pop-up list or press
+ <keyseq><key>Alt</key><key>Num</key></keyseq>, where <key>Num</key> is the
+ number displayed next to your desired word.</p>
+
+</page>
diff --git a/help/Makefile.am b/help/Makefile.am
new file mode 100644
index 0000000..a85f9e5
--- /dev/null
+++ b/help/Makefile.am
@@ -0,0 +1,25 @@
+ YELP_HELP_RULES@
+
+HELP_ID = gedit
+
+HELP_FILES = \
+ bookmarks.page \
+ bracket-comp.page \
+ character-map.page \
+ code-assistance.page \
+ code-comment.page \
+ color-picker.page \
+ commander.page \
+ dashboard.page \
+ draw-spaces.page \
+ join-split-lines.page \
+ multi-edit.page \
+ session-saver.page \
+ tag-list.page \
+ terminal.page \
+ text-size.page \
+ word-completion.page
+
+HELP_MEDIA =
+
+HELP_LINGUAS =
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
