diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-27 14:32:59 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-27 14:32:59 +0000 |
| commit | adb934701975f6b0214475d1a8d0d1ce727b9d4d (patch) | |
| tree | 5688c745d10b64c8856586864ec416a6bdae881d /help/C | |
| parent | Initial commit. (diff) | |
| download | gedit-upstream.tar.xz gedit-upstream.zip | |
Adding upstream version 3.38.1.upstream/3.38.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'help/C')
44 files changed, 2514 insertions, 0 deletions
diff --git a/help/C/check_status.sh b/help/C/check_status.sh new file mode 100755 index 0000000..deefeb8 --- /dev/null +++ b/help/C/check_status.sh @@ -0,0 +1,43 @@ +#!/bin/sh + +# Produce a summary of the statuses of all of the .page topics +# (Not done properly, but it's OK for a rough estimate) +# DO NOT TRANSLATE + +echo " " +echo "== NONE ==" +grep -l "status=\"none" *.page +echo " " +echo "== STUB ==" +grep -l "status=\"stub" *.page +echo " " +echo "== INCOMPLETE ==" +grep -l "status=\"incomplete" *.page +echo " " +echo "== DRAFT ==" +grep -l "status=\"draft" *.page +echo " " +echo "== REVIEW ==" +grep -l "status=\"review" *.page +echo " " +echo "== CANDIDATE ==" +grep -l "status=\"candidate" *.page +echo " " +echo "== FINAL ==" +grep -l "status=\"final" *.page +echo " " +echo "== OUTDATED ==" +grep -l "status=\"outdated" *.page + +echo " " +echo " " +echo "== SUMMARY ==" +echo "None: " `grep "status=\"none" *.page | wc -l` +echo "Stub: " `grep "status=\"stub" *.page | wc -l` +echo "Incomplete: " `grep "status=\"incomplete" *.page | wc -l` +echo "Draft: " `grep "status=\"draft" *.page | wc -l` +echo "Review: " `grep "status=\"review" *.page | wc -l` +echo "Candidate: " `grep "status=\"candidate" *.page | wc -l` +echo "Final: " `grep "status=\"final" *.page | wc -l` +echo "Outdated: " `grep "status=\"outdated" *.page | wc -l` +echo " " diff --git a/help/C/figures/gedit-html-snippet.png b/help/C/figures/gedit-html-snippet.png Binary files differnew file mode 100644 index 0000000..5c11e65 --- /dev/null +++ b/help/C/figures/gedit-html-snippet.png diff --git a/help/C/figures/gedit-icon.png b/help/C/figures/gedit-icon.png Binary files differnew file mode 100644 index 0000000..fb37579 --- /dev/null +++ b/help/C/figures/gedit-icon.png diff --git a/help/C/figures/gedit3-screenshot.png b/help/C/figures/gedit3-screenshot.png Binary files differnew file mode 100644 index 0000000..81d54ee --- /dev/null +++ b/help/C/figures/gedit3-screenshot.png diff --git a/help/C/gedit-change-color-scheme.page b/help/C/gedit-change-color-scheme.page new file mode 100644 index 0000000..0c79a17 --- /dev/null +++ b/help/C/gedit-change-color-scheme.page @@ -0,0 +1,66 @@ +<page xmlns="http://projectmallard.org/1.0/" + xmlns:its="http://www.w3.org/2005/11/its" + type="guide" style="task" + id="gedit-change-color-scheme"> + + <info> + <link type="guide" xref="index#configure-gedit"/> + <desc>Change the text and background colors in gedit.</desc> + <revision pkgversion="3.8" date="2013-03-07" status="final"/> + <revision pkgversion="3.15" date="2015-01-29" status="final"/> + <revision pkgversion="3.31.90" date="2019-03-03" status="final"/> + + <credit type="author"> + <name>Jim Campbell</name> + <email>jcampbell@gnome.org</email> + </credit> + <credit type="editor"> + <name>Jana Svarova</name> + <email its:translate="no">jana.svarova@gmail.com</email> + <years>2015</years> + </credit> + <credit type="editor"> + <name>Ekaterina Gerasimova</name> + <email its:translate="no">kittykat3756@gmail.com</email> + <years>2015</years> + </credit> + + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> + </info> + + <title>Change the color scheme</title> + + <p><app>gedit</app> includes several different color schemes, allowing you to + change the appearance of the main text window.</p> + + <steps> + <title>To change the color scheme:</title> + <item> + <p>Press the menu button in the top-right corner of the window and select + <guiseq><gui style="menuitem">Preferences</gui><gui>Font & + Colors</gui></guiseq>.</p> + </item> + <item> + <p>Choose your desired color scheme.</p> + </item> + </steps> + + <p>The new color scheme will be applied immediately.</p> + + <section id="custom-color-scheme"> + <title>Use a Custom Color Scheme</title> + <!-- I'm not sure if I should link to the wiki for this chunk of help, or if + I should describe it here. I'm linking to the wiki for now because the wiki + page includes downloads and screenshots. I'm open to including the help here, + though. --> + + <p>You can also use color schemes that have been created by others, or + create and use your own color schemes.</p> + + <p>Instructions on how to install custom color schemes, as well as examples + of color schemes that you can download and use, are available on the + <link href="https://wiki.gnome.org/Projects/GtkSourceView/StyleSchemes">gedit + wiki</link>.</p> + </section> + +</page> diff --git a/help/C/gedit-change-default-font.page b/help/C/gedit-change-default-font.page new file mode 100644 index 0000000..3c45f46 --- /dev/null +++ b/help/C/gedit-change-default-font.page @@ -0,0 +1,43 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="topic" style="task" + id="gedit-change-default-font"> + <info> + <link type="guide" xref="index#configure-gedit"/> + <desc>Use a custom font for your text in gedit.</desc> + <revision version="3.8" date="2013-03-07" status="final"/> + <revision version="3.38" date="2020-11-13" status="final"/> + + <credit type="author"> + <name>Jim Campbell</name> + <email>jcampbell@gnome.org</email> + <years>2011 2012 2013</years> + </credit> + + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> + +</info> + + <title>Change the default font</title> + + <p><app>gedit</app> will use the system fixed-width font by default, + but you can change the default <app>gedit</app> font to suit your preferences. + </p> + + <steps> + <title>To change the default font in <app>gedit</app>:</title> + + <item><p>Press the menu button in the top-right corner of the window and + select <guiseq><gui style="menuitem">Preferences</gui><gui>Font & + Colors</gui></guiseq>.</p></item> + <item><p>Uncheck the box next to the phrase, "Use the system fixed width + font."</p></item> + <item><p>Click on the current font name. <app>gedit</app> will open + a font-chooser window, allowing you to see available fonts and choose the + one that you prefer.</p></item> + <item><p>After you have chosen a new font, use the <gui>slider</gui> + under the list of fonts to set the default font size.</p></item> + <item><p>Click <gui>Select</gui>, and then close the dialog.</p> + </item> + </steps> + +</page> diff --git a/help/C/gedit-close-file.page b/help/C/gedit-close-file.page new file mode 100644 index 0000000..5470744 --- /dev/null +++ b/help/C/gedit-close-file.page @@ -0,0 +1,27 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="topic" style="task" + id="gedit-close-file"> + + <info> + <link type="guide" xref="gedit-files-basic" group="fourth"/> + <desc>Exit from the file you are using.</desc> + <revision pkgversion="3.8" date="2013-03-07" status="final"/> + <revision pkgversion="3.24" date="2017-09-17" status="final"/> + <credit type="author"> + <name>Jim Campbell</name> + <email>jcampbell@gnome.org</email> + </credit> + + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> +</info> + + <title>Close a file</title> + + <p>To close a file in <app>gedit</app>, click the <gui style="button">×</gui> + that appears on the right-side of the file's tab, or press + <keyseq><key>Ctrl</key><key>W</key></keyseq>.</p> + <p>Any one of these actions will close a file in <app>gedit</app>. If your + file contains changes that have not been saved, <app>gedit</app> will prompt + you to save those changes before closing the file.</p> + +</page> diff --git a/help/C/gedit-create-new-file.page b/help/C/gedit-create-new-file.page new file mode 100644 index 0000000..a2a0799 --- /dev/null +++ b/help/C/gedit-create-new-file.page @@ -0,0 +1,32 @@ +<page xmlns="http://projectmallard.org/1.0/" + xmlns:its="http://www.w3.org/2005/11/its" + type="topic" style="task" + id="gedit-create-new-file"> + + <info> + <link type="guide" xref="gedit-files-basic" group="first"/> + <desc>Open a new file for editing.</desc> + <revision pkgversion="3.8" date="2013-03-07" status="final"/> + <revision pkgversion="3.12" date="2014-02-12" status="review"/> + <credit type="author"> + <name>Jim Campbell</name> + <email>jcampbell@gnome.org</email> + </credit> + <credit type="editor"> + <name>Shobha Tyagi</name> + <email its:translate="no">tyagishobha@gmail.com</email> + </credit> + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> + </info> + + <title>Create a new file</title> + + <p>The easiest way to create a new file in <app>gedit</app>, is to click the + <gui>Create a new document</gui> button on the left side of the header bar, + or press <keyseq><key>Ctrl</key><key>T</key></keyseq>.</p> + + <p>Any one of these actions will create a new file in the <app>gedit</app> + window. If you have other files open in <app>gedit</app>, the new file that + you create will appear as a new tab to the right of those files.</p> + +</page> diff --git a/help/C/gedit-edit-as-root.page b/help/C/gedit-edit-as-root.page new file mode 100644 index 0000000..972bbc9 --- /dev/null +++ b/help/C/gedit-edit-as-root.page @@ -0,0 +1,43 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="topic" style="task" + id="gedit-edit-as-root"> + + <info> + <link type="guide" xref="index#gedit-working-with-files"/> + <desc>Use administrative privileges to edit a file.</desc> + <revision pkgversion="3.8" date="2013-03-07" status="final"/> + <credit type="author"> + <name>Jim Campbell</name> + <email>jcampbell@gnome.org</email> + </credit> + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> + </info> + + <title>Edit a file as the root user</title> + + <note style="warning"> + <p>Editing files as the root user is potentially dangerous, and may break + your system in bad ways. Take great care when editing files as the root + user.</p> + </note> + + <p>To edit files as the root user, launch <app>gedit</app> from the terminal + by entering:</p> + <code>sudo gedit</code> + + <p>Using the <cmd>sudo</cmd> command, you will need to successfully enter + your password before <app>gedit</app> will open.</p> + + <p>As an alternative to the <cmd>sudo</cmd> command, you may obtain + administrative privileges by entering:</p> + <code>su -</code> + + <p>You would then launch <app>gedit</app> using the <cmd>gedit</cmd> + command.</p> + + <note style="tip"> + <p>Once you have opened <app>gedit</app> with administrative privileges, + <app>gedit</app> will keep those privileges until you close it.</p> + </note> + +</page> diff --git a/help/C/gedit-files-basic.page b/help/C/gedit-files-basic.page new file mode 100644 index 0000000..bf2e7b1 --- /dev/null +++ b/help/C/gedit-files-basic.page @@ -0,0 +1,21 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="guide" style="task 2column" + id="gedit-files-basic"> + + <info> + <link type="guide" xref="index#gedit-working-with-files" group="first"/> + <desc>Learn the basics of how to work with files in gedit.</desc> + <revision pkgversion="3.8" date="2013-03-07" status="final"/> + <credit type="author"> + <name>Jim Campbell</name> + <email>jcampbell@gnome.org</email> + </credit> + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> + </info> + + <title>File basics: Open, close, and save files</title> + + <p>If you are new to <app>gedit</app>, these topics will help you with + creating, saving, opening and closing files.</p> + <links type="topic" groups="first second third fourth fifth sixth" style="2column"/> +</page> diff --git a/help/C/gedit-full-screen.page b/help/C/gedit-full-screen.page new file mode 100644 index 0000000..d1bb0b2 --- /dev/null +++ b/help/C/gedit-full-screen.page @@ -0,0 +1,58 @@ +<page xmlns="http://projectmallard.org/1.0/" + xmlns:its="http://www.w3.org/2005/11/its" + type="guide" style="task" + id="gedit-full-screen"> + + <info> + <link type="guide" xref="index#configure-gedit"/> + <desc>Set gedit to use the entire screen.</desc> + <revision pkgversion="3.8" date="2013-03-07" status="final"/> + <revision pkgversion="3.12" date="2014-02-17" status="review"/> + <revision pkgversion="3.24" date="2017-09-17" status="review"/> + <credit type="author"> + <name>Jim Campbell</name> + <email>jcampbell@gnome.org</email> + </credit> + <credit type="editor"> + <name>Shobha Tyagi</name> + <email its:translate="no">tyagishobha@gmail.com</email> + </credit> + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> + </info> + + <title>Use fullscreen mode</title> + + <p>When working with a large document, you may find it helpful to work in + <app>gedit's</app> fullscreen mode. Using fullscreen mode will hide the + <gui>menu bar</gui>, <gui>tab bar</gui> and the <gui>tool bar</gui>, + presenting you with more of your text and allowing you to better focus on + your tasks.</p> + + <section id="turn-on-full-screen"> + <title>Turn on fullscreen mode</title> + <p>To turn on fullscreen mode, press <key>F11</key>. <app>gedit's</app> + menu, title, and tab-bars will hide, and you will only be presented with + the text of your current file.</p> + <p>If you need to perform an action from the <app>gedit</app> menu while + working in fullscreen mode, move your mouse pointer to the top of the + screen. The <app>gedit</app> menu bar will reappear, and you can select + your desired action.</p> + + <note> + <p>To switch between open tabs while in fullscreen mode, press either + <keyseq><key>Ctrl</key><key>Alt</key><key>PgUp</key></keyseq> or + <keyseq><key>Ctrl</key><key>Alt</key><key>PgDn</key></keyseq>.</p> + </note> + + </section> + + <section id="turn-off-full-screen"> + <title>Turn off fullscreen mode</title> + <p>To turn off fullscreen mode and return to the standard <app>gedit</app> + window, press <key>F11</key>.</p> + <p>You can also move your mouse cursor to the top of the screen, and wait + for the <gui>menu bar</gui> to appear. When the <gui>menu bar</gui> + appears, select the <gui>Leave Fullscreen</gui> button.</p> + </section> + +</page> diff --git a/help/C/gedit-open-files-from-sidepane.page b/help/C/gedit-open-files-from-sidepane.page new file mode 100644 index 0000000..6b9ac73 --- /dev/null +++ b/help/C/gedit-open-files-from-sidepane.page @@ -0,0 +1,69 @@ +<page xmlns="http://projectmallard.org/1.0/" + xmlns:its="http://www.w3.org/2005/11/its" + type="topic" style="task" + id="gedit-open-files-from-sidepane"> + + <info> + <link type="guide" xref="index#configure-gedit"/> + <desc>Use gedit's side pane as a file browser.</desc> + <revision pkgversion="3.8" date="2013-03-13" status="final"/> + <credit type="author"> + <name>Jim Campbell</name> + <email its:translate="no">jcampbell@gnome.org</email> + </credit> + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> + </info> + + <title>View and open files from the side panel</title> + <p> + The most common way to switch between files in <app>gedit</app> is by using + the tabs at the top of the <app>gedit</app> window. In some cases, though, + particularly when you are working with a large number of open files, you + may find it easier to use the side panel. + </p> + + <p> + To activate the side panel, select <guiseq><gui>View</gui> + <gui>Side Panel</gui></guiseq>, or just press the <key>F9</key> key. + </p> + + <note style="note"> + <p> + You can toggle the side panel open or closed by pressing + <key>F9</key> at any time. + </p> + </note> + +<!-- TODO: This section is duplicated from gedit-plugins-file-browser.page; does it make sense here? --> + <section id="sidepane-open"> + <title>Opening files from the side panel</title> + <p> + To open files from the side panel, first open the + side panel by selecting <guiseq><gui>View</gui> + <gui>Side Panel</gui></guiseq> (or just press + <key>F9</key>), and then choose <gui>File Browser</gui> from the dropdown + at the top of the panel. + </p> + + <p> + This will activate the <em>File Browser</em> mode of the + side panel. You can then use the navigation buttons at the top + of the panel to locate and open your desired files. + </p> + </section> + + <section id="sidepane-switch"> + <title>Using the side panel to switch between open files</title> + <p> + Once you have several files open, you can use the side panel to switch + between open files. To list open files, choose <gui>Documents</gui> + from the dropdown at the top of the panel. + </p> + + <p> + Clicking on any file name in the side panel will open that file + for editing. + </p> + </section> + + </page> diff --git a/help/C/gedit-open-files.page b/help/C/gedit-open-files.page new file mode 100644 index 0000000..2aeb1bc --- /dev/null +++ b/help/C/gedit-open-files.page @@ -0,0 +1,50 @@ +<page xmlns="http://projectmallard.org/1.0/" + xmlns:its="http://www.w3.org/2005/11/its" + type="topic" style="task" + id="gedit-open-files"> + + <info> + <link type="guide" xref="gedit-files-basic" group="second"/> + <link type="seealso" xref="gedit-open-on-server"/> + <link type="seealso" xref="gedit-close-file"/> + <link type="seealso" xref="gedit-open-recent"/> + <link type="seealso" xref="gedit-quickstart"/> + <desc>Open files to start working on them.</desc> + <revision pkgversion="3.8" date="2013-03-07" status="final"/> + <revision pkgversion="3.12" date="2014-02-12" status="review"/> + + <credit type="author"> + <name>Jim Campbell</name> + <email>jcampbell@gnome.org</email> + </credit> + <credit type="editor"> + <name>Shobha Tyagi</name> + <email its:translate="no">tyagishobha@gmail.com</email> + </credit> + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> + </info> + + <title>Open a file or set of files</title> + + <p>To open a file in <app>gedit</app>, click the <gui>Open</gui> button, or + press <keyseq><key>Ctrl</key><key>O</key></keyseq>.</p> + <p>This will cause the <gui>Open</gui> dialog to appear. Use your mouse + or keyboard to select the file that you wish to open, and then click + <gui>Open</gui>. The file that you've selected will open in a new tab.</p> + <p>To close the <gui>Open</gui> dialog without opening a file, click + <gui>Cancel</gui>.</p> + + <note style="tip"><p>You can use the <key>Ctrl</key> and <key>Shift</key> + keys to open more than one file at a time. If you hold down the + <key>Ctrl</key> key while you select multiple files, clicking <gui>Open</gui> + will open each of the files that you have selected.</p> + + <!-- Insert Image Here --> + + <p>Holding down the <key>Shift</key> while you select multiple files will + open the first file that you select, the last file that you select, and all + of the files in between.</p></note> + + <!-- Insert Image Here --> + +</page> diff --git a/help/C/gedit-open-on-server.page b/help/C/gedit-open-on-server.page new file mode 100644 index 0000000..1b1055f --- /dev/null +++ b/help/C/gedit-open-on-server.page @@ -0,0 +1,52 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="topic" style="task" + id="gedit-open-on-server"> + + <info> + <link type="guide" xref="gedit-files-basic" group="sixth"/> + <desc>Access files that are stored on a different computer.</desc> + <revision pkgversion="3.24" date="2017-09-14" status="review"/> + <credit type="author"> + <name>Jim Campbell</name> + <email>jcampbell@gnome.org</email> + </credit> + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> + </info> + + <title>Open a file that is located on a server</title> + + <p>Prior to opening a file on a server from within <app>gedit</app>, you need + to know some technical information about the server. For example, you will + need to know the IP Address or URL of the server, and may need to know what + kind of server it is (e.g., HTTP, FTP, etc.).</p> + + <p>Also, some types of servers impose restrictions on what you can do with + files stored on the server. For example, you may be able to open a file from + a server, but may need to save any changes to the file locally, on your own + computer.</p> + + <p>With these caveats in mind, perform the following steps to open a file + from a server using <app>gedit</app>:</p> + + <steps> + <item><p>In the header bar, click on <gui>Open</gui>.</p></item> + <item><p>Click <gui>Other Locations</gui>.</p></item> + <item><p>Enter the IP Address or URL of the appropriate + server.</p></item> + <item><p>Find and select the file that you wish to open.</p></item> + <item><p>Use the Character Encoding drop-down list to select the + appropriate character coding.</p></item> + <item><p>Click <gui>Open</gui>.</p></item> + </steps> + + <p>Valid types of URI include http:, ftp:, file:, and all of the methods + supported by <app>GVfs</app>.</p> + + <note> + <p>Files from some types of URI are opened as read-only, and any changes + you make must be saved to a different location. For example, HTTP only + allows files to be read. Files opened from FTP are read-only because not + all FTP servers may correctly work with saving remote files.</p> + </note> + +</page> diff --git a/help/C/gedit-open-recent.page b/help/C/gedit-open-recent.page new file mode 100644 index 0000000..086ef77 --- /dev/null +++ b/help/C/gedit-open-recent.page @@ -0,0 +1,35 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="topic" style="task" + id="gedit-open-recent"> + + <info> + <link type="guide" xref="gedit-files-basic" group="fifth"/> + <desc>Access files that you have previously opened in <app>gedit</app>.</desc> + <revision pkgversion="3.8" date="2013-02-24" status="review"/> + <revision pkgversion="3.24" date="2017-09-17" status="review"/> + <revision pkgversion="3.35.90" date="2020-03-02" status="review"/> + <credit type="author"> + <name>Jim Campbell</name> + <email>jcampbell@gnome.org</email> + </credit> + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> + </info> + + <title>Reopen a recently-used file</title> + + <p><app>gedit</app> provides easy access to your ten most recently-used + files, that have been previously opened in <app>gedit</app>. Here is how you + can open a recently-used file:</p> + <list type="numbered"> + <item><p>Click the arrow button next to the <gui>Open</gui> button in the + header bar.</p></item> + <item><p><app>gedit</app> will display a menu with the ten most + recently-used files.</p></item> + <item><p>Select the desired file, and it will open in a new tab.</p></item> + </list> + + <note><p>When hovering with the mouse over a recently-used file from the + menu, the full path to the file is displayed in the status bar at the bottom + of the <app>gedit</app> window.</p></note> + +</page> diff --git a/help/C/gedit-plugin-guide.page b/help/C/gedit-plugin-guide.page new file mode 100644 index 0000000..904a977 --- /dev/null +++ b/help/C/gedit-plugin-guide.page @@ -0,0 +1,48 @@ +<page xmlns="http://projectmallard.org/1.0/" + xmlns:e="http://projectmallard.org/experimental/" + xmlns:if="http://projectmallard.org/if/1.0/" + type="guide" style="task" + id="gedit-plugin-guide"> + + <info> + <link type="guide" xref="index#gedit-plugins"/> + <desc>Use plugins to customize how gedit works for you.</desc> + <revision pkgversion="3.8" date="2013-02-24" status="review"/> + <revision pkgversion="3.24" date="2017-09-17" status="review"/> + <credit type="author"> + <name>Jim Campbell</name> + <email>jcampbell@gnome.org</email> + </credit> + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> + </info> + + <title>Configure and use gedit plugins</title> + <p>You can do more with <app>gedit</app> by using plugins. Several plugins + are installed by default, but a large number of other plugins are available + separately.</p> + + <note><p>Many Linux distributions make a group of these plugins available as + a <app>gedit-plugins</app> package. Install the <app>gedit-plugins</app> + package to make these extra plugins available to <app>gedit</app>.</p> + + <if:choose xmlns:if="http://projectmallard.org/if/1.0/"> + <if:when test="action:install"> + <p><link action="install:gedit-plugins" href="ftp://ftp.gnome.org/pub/gnome/sources/gedit-plugins/" style="button">Install gedit-plugins</link></p> + </if:when> + </if:choose> + </note> + + <section id="gedit-default-plugins" style="2column"> + <title>Default gedit Plugins</title> + </section> + + <section id="gedit-additional-plugins" style="2column"> + <title>Additional gedit Plugins</title> + </section> + +<!-- TODO document how to create gedit plugins + <section id="gedit-create-plugins"> + <title>Create your own gedit Plugins</title> + </section> +--> +</page> diff --git a/help/C/gedit-plugins-change-case.page b/help/C/gedit-plugins-change-case.page new file mode 100644 index 0000000..edc8d9d --- /dev/null +++ b/help/C/gedit-plugins-change-case.page @@ -0,0 +1,54 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="topic" style="task" + id="gedit-plugins-change-case"> + +<info> + <link type="guide" xref="gedit-plugin-guide#gedit-default-plugins"/> + <revision pkgversion="3.8" date="2013-02-24" status="review"/> + <credit type="author"> + <name>Daniel Neel</name> + <email>dneelyep@gmail.com</email> + </credit> + + <credit type="author"> + <name>Jim Campbell</name> + <email>jcampbell@gnome.org</email> + </credit> + <desc>Change the case of selected text.</desc> +</info> + +<title>Change case</title> + + <p>This plugin helps you to change the case of selected portions of text. You + can use it to change text to be all lower case, all upper case, to invert the + case, or apply title case. To enable this plugin, select + <guiseq><gui style="menu">gedit</gui><gui style="menuitem">Preferences</gui> + <gui>Plugins</gui><gui>Change Case</gui></guiseq>.</p> + + <p>Once the <em>Change Case</em> plugin is enabled, you can use it by + completing the following steps:</p> + + <steps> + <item><p>Highlight the portion of text that you want to change.</p></item> + <item><p>Select <guiseq><gui style="menu">gedit</gui><gui>Change Case</gui></guiseq></p> + </item> + <item><p>Choose your desired text-formatting option.</p></item> + </steps> + + <p>The updates to the text formatting will take place immediately.</p> + + <note style="tip"> + <p>The <gui>Invert Case</gui> option will convert all lower case letters to + upper case, and will convert all upper case letters to lower case.</p> + <p>The <gui>Title Case</gui> option will convert the first letter of each + word to upper case. All other letters will be converted to lower + case.</p> + </note> + + <note> + <p>If you have not highlighted any text, the <em>Change Case</em> feature + will be grayed-out. You need to select a portion of text before you use the + <em>Change Case</em> feature.</p> + </note> + +</page> diff --git a/help/C/gedit-plugins-doc-stats.page b/help/C/gedit-plugins-doc-stats.page new file mode 100644 index 0000000..6b0bd05 --- /dev/null +++ b/help/C/gedit-plugins-doc-stats.page @@ -0,0 +1,44 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="topic" style="task" + id="gedit-plugins-doc-stats"> + +<info> + <link type="guide" xref="gedit-plugin-guide#gedit-default-plugins"/> + <revision pkgversion="3.8" date="2013-02-24" + status="review"/> + <credit type="author"> + <name>Daniel Neel</name> + <email>dneelyep@gmail.com</email> + </credit> + <credit type="author"> + <name>Jim Campbell</name> + <email>jcampbell@gnome.org</email> + </credit> + <desc>View document statistics.</desc> +</info> + +<title>Document statistics</title> + + <p>The <em>Document Statistics</em> plugin shows you various statistics about + your current document. To enable this plugin, select + <guiseq><gui style="menu">gedit</gui><gui style="menuitem">Preferences</gui> + <gui>Plugins</gui><gui>Document Statistics</gui></guiseq>.</p> + +<section id="using-doc-stats"> + <title>Using Document Statistics</title> + + <p>Once the plugin is enabled, use it by selecting <guiseq><gui>Tools</gui> + <gui>Document Statistics</gui></guiseq>. A window will display the + statistical information of your document, including the number of words, + lines, characters, non-space characters, and the size of your file in + bytes.</p> + + <p>You can also use <em>Document Statistics</em> to show you information about + just a portion of your document. To do this, use the mouse pointer to select + the portion of text that you want to examine, and then select + <guiseq><gui>Tools</gui><gui>Document Statistics</gui></guiseq>. + <app>Gedit</app> will display information for both your entire document, and + for the portion of text that you highlighted.</p> +</section> + +</page> diff --git a/help/C/gedit-plugins-external-tools.page b/help/C/gedit-plugins-external-tools.page new file mode 100644 index 0000000..c30c66d --- /dev/null +++ b/help/C/gedit-plugins-external-tools.page @@ -0,0 +1,46 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="topic" style="task" + id="gedit-plugins-external-tools"> + +<!-- TODO: Provide an example or two about using external tools --> + +<info> + <link type="guide" xref="gedit-plugin-guide#gedit-default-plugins"/> + <revision pkgversion="3.8" date="2013-02-24" status="review"/> + <credit type="author"> + <name>Daniel Neel</name> + <email>dneelyep@gmail.com</email> + </credit> + <credit type="author"> + <name>Jim Campbell</name> + <email>jcampbell@gnome.org</email> + </credit> + <desc>Run scripts on your current files, and interact with other applications.</desc> + <!--INFOAT: https://wiki.gnome.org/Apps/Gedit/Plugins/ExternalTools --> +</info> + +<title>External tools</title> + + <p>The <em>External Tools</em> plugin can help simplify repetitive tasks. + Specifically, it extends <app>gedit</app> by helping you to run scripts on + your working files, and by allowing <app>gedit</app> to interact with other + programs on your computer. To enable the <app>External Tools</app> plugin, + select <guiseq><gui style="menu">gedit</gui> + <gui style="menuitem">Preferences</gui><gui>Plugins</gui> + <gui>External Tools</gui></guiseq>.</p> + + <section id="plugin-config-external-tools"> + <title>Configure the external tools plugin</title> + + <p>Once you have enabled the plugin, you will need to configure it to suit + your needs. The configuration options are available by selecting + <guiseq><gui>Tools</gui><gui>Manage External Tools</gui></guiseq>.</p> + + <note style="caution"> + <p>This plugin is for advanced users, and requires knowledge of scripting + to be used effectively. Use this plugin with care, as mistakes with your + scripts can affect your work in unintended ways.</p> + </note> + </section> + +</page> diff --git a/help/C/gedit-plugins-file-browser.page b/help/C/gedit-plugins-file-browser.page new file mode 100644 index 0000000..62d84f4 --- /dev/null +++ b/help/C/gedit-plugins-file-browser.page @@ -0,0 +1,49 @@ +<page xmlns="http://projectmallard.org/1.0/" + xmlns:its="http://www.w3.org/2005/11/its" + type="topic" style="task" + id="gedit-plugins-file-browser"> + +<info> + <link type="guide" xref="gedit-plugin-guide#gedit-default-plugins"/> + <revision pkgversion="3.8" date="2011-08-17" status="review"/> + <revision pkgversion="3.24" date="2017-09-17" status="review"/> + <credit type="author"> + <name>Daniel Neel</name> + <email its:translate="no">dneelyep@gmail.com</email> + </credit> + <credit type="author"> + <name>Jim Campbell</name> + <email its:translate="no">jcampbell@gnome.org</email> + </credit> + <desc>Use the side panel to browse and open files.</desc> +</info> + +<title>File browser panel</title> + + <p>Depending on how you use <app>gedit</app>, you may find it helpful to use + the <app>File Browser panel</app> plugin. This plugin embeds a + <app>file browser</app> in the side panel, giving you easy access to your + frequently-used files.</p> + + <p>You can enable the side panel by selecting + <guiseq><gui style="menu">gedit</gui><gui style="menuitem">Preferences</gui> + <gui>Plugins</gui><gui>File Browser Panel</gui></guiseq>.</p> + + <section id="sidepane-open"> + <title>Opening files from the side panel</title> + <p> + To open files from the side panel, first open the + side panel by selecting <guiseq><gui>View</gui> + <gui>Side Panel</gui></guiseq> (or just press + <key>F9</key>), and then choose <gui>File Browser</gui> from the dropdown + at the top of the panel. + </p> + + <p> + This will activate the <em>File Browser</em> mode of the + side panel. You can then use the navigation buttons at the top + of the panel to locate and open your desired files. + </p> + </section> + +</page> diff --git a/help/C/gedit-plugins-insert-date-time.page b/help/C/gedit-plugins-insert-date-time.page new file mode 100644 index 0000000..8acfcda --- /dev/null +++ b/help/C/gedit-plugins-insert-date-time.page @@ -0,0 +1,50 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="topic" style="task" + id="gedit-plugins-insert-date-time"> + +<info> + <link type="guide" xref="gedit-plugin-guide#gedit-default-plugins"/> + <revision pkgversion="3.8" date="2013-02-24" status="review"/> + <revision pkgversion="3.34" date="2020-02-10" status="review"/> + <credit type="author"> + <name>Daniel Neel</name> + <email>dneelyep@gmail.com</email> + </credit> + + <credit type="author"> + <name>Jim Campbell</name> + <email>jcampbell@gnome.org</email> + </credit> + <desc>Insert the current date/time at the cursor position.</desc> +</info> + +<title>Insert date/time</title> + + <p>As this name of this plugin suggests, the <gui>Insert Date/Time</gui> + plugin allows you to insert the date and/or time at the current cursor + position.</p> + + <steps> + <title>To enable the plugin:</title> + <item> + <p>Press the menu button in the top-right corner of the window and select + <guiseq><gui style="menuitem">Preferences</gui> + <gui style="tab">Plugins</gui></guiseq>.</p> + </item> + <item> + <p>Select <gui style="menuitem">Insert Date/Time</gui> to enable the plugin.</p> + </item> + </steps> + + <p>To use the plugin, press the menu button in the top-right corner of the + window and select <guiseq><gui style="menuitem">Tools</gui> + <gui style="menuitem">Insert Date and Time…</gui></guiseq>.</p> + + <p>By default, the <gui>Insert Date/Time</gui> plugin will prompt you to + choose your preferred date/time format each time that you use the plugin. + However, you can choose your own default date and time format by pressing the + menu button in the top-right corner of the window and selecting <guiseq> + <gui style="menuitem">Preferences</gui><gui style="tab">Plugins</gui><gui> + Insert Date/Time</gui><gui style="button">Preferences</gui></guiseq>.</p> + +</page> diff --git a/help/C/gedit-plugins-install.page b/help/C/gedit-plugins-install.page new file mode 100644 index 0000000..81f9160 --- /dev/null +++ b/help/C/gedit-plugins-install.page @@ -0,0 +1,64 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="topic" style="task" + id="gedit-plugins-install"> + <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>jcampbell@gnome.org</email> + </credit> + <credit type="author"> + <name>Daniel Neel</name> + <email>dneelyep@gmail.com</email> + </credit> + <desc>How to install third-party plugins.</desc> + </info> + + <title>Additional gedit plugins</title> + + <p>Installing third-party plugins gives you extra functionality that isn't + available in default <app>gedit</app> plugins, or even the extra plugins that + are part of the <app>gedit-plugins</app> package. An online list of + third-party plugins is + <link href="https://wiki.gnome.org/Apps/Gedit">kept here</link>. + </p> + + <p>Installing a third-party plugin involves downloading the plugin, placing + the plugin files in the right directory, and activating the plugin.</p> + + <steps> + <item><p>You can usually download a plugin from the plugin's website, but + may need to use a revision-control program like <app>git</app>, <app> + bazaar</app>, or <app>subversion</app> to copy a plugin's software + repository from the internet. Refer to the plugin's documentation for + information on getting the plugin.</p></item> + <item><p>Place the plugin files into the + <file>/home/<var>username</var>/.local/share/gedit/plugins</file> directory. + </p> + <p>Of course, replace the word <var>username</var> with your own username. + </p></item> + <item><p>After you have placed the plugin files into the correct directory, + the plugin will appear in the Preferences menu. Press the menu button in the + top-right corner of the window and select <guiseq><gui style="menuitem"> + Preferences</gui><gui style="tab">Plugins</gui><gui>[Name of Plugin]</gui> + </guiseq> to enable the plugin.</p></item> + <item><p>Click <gui>Close</gui>.</p></item> + </steps> + + <p>After you have enabled the plugin, it should be available for you to use. + </p> + + <note style="tip"> + <p>The <file>.local</file> directory is hidden by default. To view it and + other hidden files, select <guiseq><gui>View</gui><gui>Show Hidden + Files</gui></guiseq>, or press <keyseq><key>Ctrl</key><key>H</key></keyseq>. + </p> + </note> + + <note style="tip"> + <p>If the directory <file>.local/share/gedit/plugins/</file> is not + present on your system, you will need to create it.</p> + </note> + +</page> diff --git a/help/C/gedit-plugins-modelines.page b/help/C/gedit-plugins-modelines.page new file mode 100644 index 0000000..5da7b97 --- /dev/null +++ b/help/C/gedit-plugins-modelines.page @@ -0,0 +1,100 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="topic" style="task" + id="gedit-plugins-modelines"> + +<info> + <link type="guide" xref="gedit-plugin-guide#gedit-default-plugins"/> + <revision pkgversion="3.8" date="2013-02-24" status="review"/> + <credit type="author"> + <name>Daniel Neel</name> + <email>dneelyep@gmail.com</email> + </credit> + <credit type="author"> + <name>Jim Campbell</name> + <email>jcampbell@gnome.org</email> + </credit> + <desc>Emacs, Kate and Vim-style modelines support for gedit.</desc> +</info> + +<title>Modelines</title> + + <p>The <app>Modelines</app> plugin allows <app>gedit</app> to analyze the + lines of text at the start and end of a file, and then apply a set of + document preferences to the file. The <app>Modelines</app> plugin supports a + subset of the options used by the <app>Emacs</app>, <app>Kate</app> and + <app>Vim</app> text editors.</p> + + <p>To enable the <app>Modelines</app> plugin, select <guiseq><gui style="menu">gedit</gui> + <gui style="menuitem">Preferences</gui><gui>Plugins</gui><gui>Modelines</gui></guiseq>.</p> + +<section id="modelines-general"> + <title>General Modeline Options</title> + <p>The following options can be set using <app>gedit</app> modelines:</p> + <list> + <item><p>Tab width</p></item> + <item><p>Indent width</p></item> + <item><p>Inserting spaces instead of tabs</p></item> + <item><p>Text Wrapping</p></item> + <item><p>Right margin width</p></item> + </list> + + <note> + <p>Preferences set using modelines take precedence over the ones specified + in the preference dialog.</p> + </note> +</section> + +<section id="modelines-emacs"> + <title>Emacs Modelines</title> + + <p>The first two lines of a document are scanned for <app>Emacs</app> + modelines, and <app>gedit</app> supports the following <app>Emacs</app> + modeline options:</p> + <list> + <item><p>Tab-width</p></item> + <item><p>Indent-offset</p></item> + <item><p>Indent-tabs-mode</p></item> + <item><p>Text auto-wrap</p></item> + </list> + <p>For more information on <app>Emacs</app> modelines, visit the + <link href="https://www.gnu.org/software/emacs/manual/emacs.html">GNU Emacs + Manual</link>.</p> +</section> + +<section id="modelines-kate"> + <title>Kate Modelines</title> + + <p>The first and last ten lines a document are scanned for <app>Kate</app> + modelines, and <app>gedit</app> supports the following <app>Kate</app> + modeline options:</p> + + <list> + <item><p>tab-width</p></item> + <item><p>indent-width</p></item> + <item><p>space-indent</p></item> + <item><p>word-wrap</p></item> + <item><p>word-wrap-column</p></item> + </list> + + <p>For more information about <app>Kate</app> modelines, visit the + <link href="https://kate-editor.org/">Kate website</link>.</p> +</section> + +<section id="modelines-vim"> + <title>Vim Modelines</title> + <p>The first and last three lines a document are scanned for <app>Vim</app> + modelines, and <app>gedit</app> supports the following <app>Vim</app> + modeline options:</p> + + <list> + <item><p>et (expandtab)</p></item> + <item><p>ts (tabstop)</p></item> + <item><p>sw (shiftwidth)</p></item> + <item><p>wrap</p></item> + <item><p>textwidth</p></item> + </list> + + <p>For more information on <app>Vim</app> modelines, visit the + <link href="https://www.vim.org/">Vim website</link>.</p> +</section> +</page> diff --git a/help/C/gedit-plugins-pyconsole.page b/help/C/gedit-plugins-pyconsole.page new file mode 100644 index 0000000..c7c43a5 --- /dev/null +++ b/help/C/gedit-plugins-pyconsole.page @@ -0,0 +1,31 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="topic" style="task" + id="gedit-plugins-pyconsole"> + +<info> + <link type="guide" xref="gedit-plugin-guide#gedit-default-plugins"/> + <revision pkgversion="3.8" date="2013-02-24" status="review"/> + <revision pkgversion="3.24" date="2017-09-17" status="review"/> + <credit type="author"> + <name>Jim Campbell</name> + <email>jcampbell@gnome.org</email> + </credit> + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> + <desc>Add an interactive Python console to the bottom pane.</desc> +</info> + + <title>Python console</title> + + <p>You can add a Python console to the bottom pane, allowing you to test + Python scripts without leaving <app>gedit</app>. To enable the Python + console, select <guiseq><gui style="menu">gedit</gui> + <gui style="menuitem">Preferences</gui><gui>Plugins</gui> + <gui>Python Console</gui></guiseq>.</p> + + <p>Once the Python console is enabled, you can open it by selecting + <guiseq><gui>View</gui><gui>Bottom Panel</gui></guiseq>.</p> + + <note style="tip"><p>If you have also enabled the <gui>Embeded Terminal</gui> + plugin, the <gui>Python Console</gui> will appear as a separate tab in the + bottom pane.</p></note> +</page> diff --git a/help/C/gedit-plugins-quick-open.page b/help/C/gedit-plugins-quick-open.page new file mode 100644 index 0000000..8ae68f9 --- /dev/null +++ b/help/C/gedit-plugins-quick-open.page @@ -0,0 +1,67 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="topic" style="task" + id="gedit-plugins-quick-open"> + <info> + <link type="guide" xref="gedit-plugin-guide#gedit-default-plugins"/> + <revision version="3.4" date="2013-02-24" status="review"/> + <revision version="3.8" date="2013-04-23" status="review"/> + <revision version="3.24" date="2017-09-17" status="review"/> + + <credit type="author"> + <name>Jim Campbell</name> + <email>jcampbell@gnome.org</email> + </credit> + <credit type="editor"> + <name>Shobha Tyagi</name> + <email>tyagishobha@gmail.com</email> + </credit> + + <desc>Quickly open a file or set of files.</desc> + </info> + + <title>Quick open</title> + + <p>As the name of this plugin would imply, the <app>Quick Open</app> plugin + helps you to open files more quickly than using the usual ways of opening + files. To enable this plugin, select <guiseq><gui style="menu">gedit</gui> + <gui>Preferences</gui><gui>Plugins</gui><gui>Quick Open</gui></guiseq>.</p> + + <p>Once you have enabled the <app>Quick Open</app> plugin you can use it as + follows:</p> + + <steps> + <item><p>Open the <app>Quick Open</app> dialog box by pressing + <keyseq><key>Ctrl</key><key>Alt</key><key>O</key></keyseq>, or by selecting + <gui style="menuitem">Quick Open…</gui>.</p> + <p>The <gui>Quick Open</gui> file dialog will appear.</p></item> + <item><p>Use your mouse to select the file or files that you want to + open.</p> + <p>To select several individual files, hold down your <key>Ctrl</key> key + while you click on the files that you want to open.</p> + <p>To select a group of files, click on the first file that you want to + open, hold down the <key>Shift</key> key, and then click on the last file + in the list that you want to open.</p></item> + <item><p>Click <gui>Open</gui>.</p></item> + </steps> + + <p><app>Quick Open</app> will look for files in:</p> + + <list> + <item><p>The directory of the currently opened document</p></item> + <item><p>The root directory of the + <app xref="gedit-plugins-file-browser">File Browser Panel</app> + plugin</p></item> + <item><p>Recent documents which are also shown in the <file>Recent</file> + folder in <app>Files</app></p></item> + <item><p>Directories which you have bookmarked in + <app>Files</app></p></item> + <item><p>Your <file>Desktop</file> directory</p></item> + <item><p>Your <file>Home</file> directory</p></item> + </list> + + <note style="tip"> + <p><app>Quick Open</app> displays files in any of the above locations + regardless of whether or not you have opened them previously.</p> + </note> + +</page> diff --git a/help/C/gedit-plugins-snippets.page b/help/C/gedit-plugins-snippets.page new file mode 100644 index 0000000..3e56245 --- /dev/null +++ b/help/C/gedit-plugins-snippets.page @@ -0,0 +1,187 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="guide" style="task 2column" + id="gedit-plugins-snippets"> + <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>Jim Campbell</name> + <email>jcampbell@gnome.org</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>Use snippets to quickly insert often-used pieces of text.</desc> + </info> + + <title>Snippets</title> + + <p><app>Snippets</app> provide a convenient way of inserting repetitive + portions of code into your files. For example, an HTML snippet for the + <code><![CDATA[<img>]]></code> tag would insert the opening and closing + portions of the tag, as well as fixed places where you can enter image + attributes. This can make writing code easier and faster.</p> + + <section id="enable-snippets"> + <title>Enable Snippets Plugin</title> + + <p>To enable the <gui>Snippets</gui> 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">Snippets</gui> to enable the + plugin.</p> + </item> + </steps> + </section> + + <section id="browse-snippets"> + <title>Browse Snippets</title> + + <p>To browse available snippets:</p> + <steps> + <item> + <p>Select <guiseq><gui style="menu">Tools</gui> + <gui style="menuitem">Manage Snippets</gui></guiseq>.</p> + <note style="important"> + <p>Make sure the syntax is set appropriately. The status bar at the + bottom of the <app>gedit</app> window will show the current language + setting. This language setting is what allows gedit to insert the + proper snippets. <app>Gedit</app> will normally detect the language or + syntax of the file that you're using, but sometimes you may need to + set it.</p> + <figure> + <desc>In this example, the language is set to HTML.</desc> + <media type="image" mime="image/png" + src="figures/gedit-html-snippet.png"></media> + </figure> + </note> + </item> + <item> + <p>Browse the snippets that are available for your language or + syntax.</p> + </item> + </steps> + </section> + + <section id="using-snippets"> + <title>Using Snippets</title> + + <p>To insert a snippet into your current document:</p> + + <steps> + <item> + <p>Type the desired snippet name anywhere in your current document.</p> + </item> + <item> + <p>Press <key>Tab</key> to insert the snippet associated with the input + term.</p> + </item> + </steps> + </section> + + <section id="example-insert-snippet"> + <title>Snippet Example Usage</title> + + <p>For example, if you have set the syntax to <em>HTML</em>, type + <code>head </code>, and press the <key>Tab</key> key. The text would have + auto completed into a snippet as:</p> + + <code> + <![CDATA[<head> + <meta http-equiv="Content-type" content="text/html; charset=utf-8" /> + <title>Page Title</title> + </head>]]> + </code> + + </section> + + <section id="adding-snippets"> + <title>Adding Snippets</title> + + <p>You can add new Snippets that work either globally (that is, they are + language agnostic) or only in a particular syntax.</p> + + <steps> + <item> + <p>Select <guiseq style="menu"><gui style="menuitem">Tools</gui> + <gui style="menuitem">Manage Snippets</gui></guiseq>.</p> + </item> + <item> + <p>From the <gui>Manage Snippets</gui> sidebar select the desired syntax + and click on the "+" button to list existing snippets for the selected + syntax.</p> + <note style="tip"> + <p>To add a snippet that works globally (that is, when no particular + syntax or language has been set for the document), select + <gui>Global</gui> from the <gui>Manage Snippets</gui> sidebar.</p> + </note> + </item> + <item> + <p>To add a new snippet, click on the "plus" icon in the + <gui>Manage Snippets</gui> sidebar.</p> + </item> + <item> + <p>Input a name for the new snippet. The name of the snippet can be + different from the snippet you want to add.</p> + </item> + <item> + <p>Under the <gui style="group">Activation</gui> section, you must + input a term for the <gui style="input">Tab trigger:</gui> textarea. + You will be using this term to insert your snippet.</p> + <note style="tip"> + <p>If you wish to insert a snippet with a keyboard shortcut, then + click your mouse pointer on <gui style="input">Shortcut key:</gui> + textarea and press the desired combination of keys. Once you have + pressed and released the keys, the keyboard shortcut will be set.</p> + </note> + </item> + <item> + <p>Under the textarea for <gui style="input">Edit:</gui>, input the + desired text for the snippet. You may use <code>${n}</code> to indicate + variables, where <em>n</em> is replaced with a number that + represents the numerical order of variables included.</p> + </item> + </steps> + + </section> + + <section id="example-add-snippet"> + <title>New Snippet Example</title> + + <p>Consider you have created a snippet with the term <var>greetings</var> + in <gui style="input">Tab trigger:</gui>. The + <gui style="input">Edit:</gui> textarea contains:</p> + + <code> + <![CDATA[<greetings>Hello ${1:wonderful}${2:amazing} world! + </greetings>]]> + </code> + + <p>You can insert this snippet by typing <var>greetings</var> in the + document and pressing the <key>Tab</key> key. The following text snippet + will be inserted:</p> + + <code> + <![CDATA[<greetings>Hello wonderfulamazing world!</greetings>]]> + </code> + + <p>The words "wonderful" and "amazing" can be retained or deleted depending + on your choice of usage. To do so, press <key>Tab</key> to choose between + "wonderful" and "amazing" and press <key>Del</key> to delete the least + preferred option.</p> + </section> + + <!--TODO: <section id="modifying-snippets"> + <title>Modifying Existing Snippets</title> + + </section>--> +</page> diff --git a/help/C/gedit-plugins-sort.page b/help/C/gedit-plugins-sort.page new file mode 100644 index 0000000..042a44a --- /dev/null +++ b/help/C/gedit-plugins-sort.page @@ -0,0 +1,89 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="topic" style="task" + id="gedit-plugins-sort"> + +<info> + <link type="guide" xref="gedit-plugin-guide#gedit-default-plugins"/> + <revision pkgversion="3.8" date="2013-02-24" status="review"/> + <revision version="3.24" date="2017-09-17" status="review"/> + <credit type="author"> + <name>Daniel Neel</name> + <email>dneelyep@gmail.com</email> + </credit> + <credit type="author"> + <name>Jim Campbell</name> + <email>jcampbell@gnome.org</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>Sort lines of text into alphabetical order.</desc> +</info> + +<title>Sort</title> + + <p>The Sort plugin arranges selected lines of text into alphabetical + order.</p> + + <section id="enable-sort"> + <title>Enable Sort Plugin</title> + + <p>To enable the <app>Sort</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">Sort</gui> to enable the plugin.</p> + </item> + </steps> + + </section> + + <section id="using-sort"> + <title>Using Sort Plugin</title> + + <p>To use the <gui>Sort</gui> plugin:</p> + + <steps> + <item> + <p>Select the desired lines of text.</p> + </item> + <item> + <p>Select <guiseq><gui style="menu">Tools</gui> + <gui style="menuitem">Sort…</gui></guiseq>.</p> + </item> + <item> + <p>The <gui>Sort</gui> dialog will open, allowing you to choose between + several sorting options:</p> + <list> + <item> + <p><gui>Reverse order</gui> will arrange the text in reverse + alphabetical order.</p> + </item> + <item> + <p><gui>Remove duplicates</gui> will remove duplicate values from + the list.</p> + </item> + <item> + <p><gui>Ignore case</gui> will ignore case sensitivity.</p> + <note style="tip"> + <p>To have the sort ignore the characters at the start of the + lines, set the first character that should be used for sorting in + the <gui>Start at</gui> column spin box.</p> + </note> + </item> + </list> + </item> + <item> + <p>To perform the sort operation, click <gui>Sort</gui>.</p> + </item> + </steps> + </section> + +</page> diff --git a/help/C/gedit-printing-order.page b/help/C/gedit-printing-order.page new file mode 100644 index 0000000..f0aeadf --- /dev/null +++ b/help/C/gedit-printing-order.page @@ -0,0 +1,69 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="topic" style="task" + id="gedit-printing-order"> + + <info> + <link type="guide" xref="gedit-printing#printing-order-select"/> + <desc>Set the pages to print in a certain order.</desc> + <revision pkgversion="3.8" date="2013-02-24" status="review"/> + <revision pkgversion="3.8" date="2013-03-21" status="review"/> + <credit type="author"> + <name>Phil Bull</name> + <email>philbull@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" /> + </info> + +<title>Getting Copies To Print In The Correct Order</title> + + <section id="printing-reverse"> + <title>Reverse</title> + + <p>Printers usually print the first page first, and the last page last, so + the pages end up in reverse order when you pick them up. To reverse the + order:</p> + + <steps> + <item> + <p>Select <guiseq><gui style="menu">File</gui> + <gui style="menuitem">Print</gui></guiseq>.</p> + </item> + <item> + <p>In the <gui style="tab">General</gui> tab of the Print dialog under + <gui style="group">Copies</gui>, check + <gui style="checkbox">Reverse</gui>.</p> + </item> + </steps> + + <p>The last page will be printed first, and so on.</p> +</section> + + <section id="printing-collate"> + <title>Collate</title> + + <p>If you are printing more than one copy of the document, the print outs + will be grouped by page number by default. (e.g. The copies of page one come + out, then the copies of page two, etc.) Collating will make each copy come + out with its pages grouped together.</p> + + <p>To Collate:</p> + <steps> + <item> + <p>Click <guiseq><gui style="menu">File</gui> + <gui style="menuitem">Print</gui></guiseq>.</p> + </item> + <item> + <p>In the <gui style="tab">General</gui> tab of the Print dialog under + <gui style="group">Copies</gui> check + <gui style="checkbox">Collate</gui>.</p> + </item> + </steps> + +<!--TODO: Fix image <media type="image" src="reverse-collate.png"/> --> +</section> + +</page> diff --git a/help/C/gedit-printing-select.page b/help/C/gedit-printing-select.page new file mode 100644 index 0000000..3aa4f1f --- /dev/null +++ b/help/C/gedit-printing-select.page @@ -0,0 +1,42 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="topic" style="task" + id="gedit-printing-select"> + + <info> + <link type="guide" xref="gedit-printing#printing-order-select"/> + <desc>Choose the pages that you want to print.</desc> + <revision pkgversion="3.8" date="2013-02-24" status="review"/> + <credit type="author"> + <name>Phil Bull</name> + <email>philbull@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"/> + </info> + + <title>Only print certain pages</title> + + <p>You can selectively print only certain pages from the document. For + example, if you enter the page numbers "1,3,5-7,9", then only pages 1, 3, + 5, 6, 7 and 9 will be printed. To print pages of your choice:</p> + + <steps> + <item> + <p>Select <guiseq><gui style="menu">File</gui> + <gui style="menuitem">Print…</gui></guiseq>.</p> + </item> + <item> + <p>In the <gui style="tab">General</gui> tab in the Print dialog choose + <gui style="radiobutton">Pages</gui> from the + <gui style="group">Range</gui> section.</p></item> + <item> + <p>Type the numbers of the pages you want to print from the document, + separated by commas. Use a dash to specify a range of pages.</p> + </item> + </steps> + + <!--TODO: Fix this <media type="image" src="print-select.png"/> --> +</page> diff --git a/help/C/gedit-printing.page b/help/C/gedit-printing.page new file mode 100644 index 0000000..b5d8753 --- /dev/null +++ b/help/C/gedit-printing.page @@ -0,0 +1,126 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="guide" style="task" + id="gedit-printing"> + + <info> + <link type="guide" xref="index#gedit-printing-guide"/> + <desc>Print the files that you create with gedit.</desc> + <revision pkgversion="3.8" date="2013-02-24" status="review"/> + <credit type="author"> + <name>Jim Campbell</name> + <email>jcampbell@gnome.org</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"/> + </info> + + <title>Printing documents</title> + + <note style="important"> + <p>Printing with <app>gedit</app> requires that you have connected and + configured your printer. If you have not done this, please consult the + <link href="help:gnome-help/printing">printing help for GNOME</link>.</p> + </note> + + <p><app>gedit</app> allows you to print both to a file and to paper.</p> + + <section id="print-preview"> + <title>Print Preview</title> + + <p>Prior to printing your document, you can preview how the printed document + will look by using <gui>Print Preview</gui>. To preview the document:</p> + + <steps> + <item> + <p>Select <guiseq><gui style="menu">File</gui> + <gui style="menuitem">Print Preview</gui></guiseq>. Alternatively, you + can press <keyseq><key>Shift</key><key>Ctrl</key> + <key>P</key></keyseq>.</p> + </item> + </steps> + + <p>A preview of your document will open in the same tab as the file. You can + browse this preview with help of navigation buttons and tools in the toolbar + at the top of the document preview tab. To close and return to the document + click <gui style="button">Close Preview</gui>.</p> + + </section> + + <section id="printing-to-paper"> + <title>Printing To Paper</title> + + <p>You can print your documents to paper using a local or remote printer. To + print a file:</p> + + <steps> + <item> + <p>Select <guiseq><gui style="menu">File</gui> + <gui style="menuitem">Print</gui> + <gui style="tab">General</gui></guiseq>.</p> + </item> + <item> + <p>Select the desired printer from the list of printers available.</p> + </item> + <item> + <p>You can preview the file using <gui style="button">Print Preview</gui> + and once you are satisfied with the settings, click + <gui style="button">Print</gui> to send the file to printer.</p> + </item> + </steps> + + <p>Additionally, from <gui style="tab">Page Setup</gui> tab: you can choose + <gui style="group">Layout</gui> and <gui style="group">Paper</gui> options. As + these settings are available throughout <app>GNOME</app> programs, please + consult + <link href="help:gnome-help/printing#paper">Layout and Paper options</link> + help.</p> + + </section> + + <section id="printing-order-select"> + <title>Print Multiple Copies And Between Specified Ranges</title> + + <p>You can set <gui style="group">Range</gui> and + <gui style="group">Copies</gui> options to help you:</p> + + </section> + + <section id="printing-to-file"> + <title>Printing To File</title> + + <p>You can also use <app>gedit</app> to print to a file. To print your + document to file of a different format:</p> + + <steps> + <item> + <p>Select <guiseq><gui style="menu">File</gui> + <gui style="menuitem">Print</gui> + <gui style="menuitem">Print to File</gui></guiseq>.</p> + </item> + <item> + <p>Printing is enabled for the following file formats, you may select + from:</p> + <list> + <item> + <p>Portable Document Format (.pdf)</p> + </item> + <item> + <p>PostScript (.ps)</p> + </item> + <item> + <p>Scalable Vector Graphic (.svg)</p> + </item> + </list> + </item> + <item> + <p>To print the document to file, click + <gui style="button">Print</gui>.</p> + </item> + </steps> + + </section> + +</page> diff --git a/help/C/gedit-quickstart.page b/help/C/gedit-quickstart.page new file mode 100644 index 0000000..7ec9ba2 --- /dev/null +++ b/help/C/gedit-quickstart.page @@ -0,0 +1,38 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="topic" style="task" + id="gedit-quickstart"> + + <info> + <link type="guide" xref="index"/> + <link type="seealso" xref="gedit-open-files"/> + <link type="seealso" xref="gedit-close-file"/> + <desc>A brief introduction to gedit.</desc> + <revision pkgversion="3.8" date="2013-02-24" status="review"/> + <credit type="author"> + <name>Jim Campbell</name> + <email>jcampbell@gnome.org</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"/> + </info> + + <title>Get started with gedit</title> + <p><app>gedit</app> is a full-featured text editor for the GNOME desktop + environment. You can use it to prepare simple notes and documents, or you + can use some of its advanced features, making it your own software + development environment.</p> + + <media type="image" mime="image/png" src="figures/gedit3-screenshot.png"/> + + <p>Once <app>gedit</app> launches, you can start writing right away. To save + your text, just click the <gui>Save</gui> button in the <app>gedit</app> + header bar.</p> + + <p>To learn about additional <app>gedit</app> features and to get assistance + with performing additional tasks, explore <link xref="index">the other + portions</link> of the <app>gedit</app> help.</p> + +</page> diff --git a/help/C/gedit-replace.page b/help/C/gedit-replace.page new file mode 100644 index 0000000..527943f --- /dev/null +++ b/help/C/gedit-replace.page @@ -0,0 +1,153 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="topic" style="task" + id="gedit-replace"> + + <info> + <link type="guide" xref="index#gedit-working-with-files" /> + <link type="seealso" xref="gedit-search" /> + <desc>Replace portions of text in a file.</desc> + <revision pkgversion="3.8" date="2013-02-24" status="review"/> + <revision pkgversion="3.10" date="2013-11-05" status="candidate"/> + <revision pkgversion="3.14" date="2014-11-28" status="review"/> + <revision pkgversion="3.24" date="2017-09-17" status="review"/> + <credit type="author"> + <name>Jim Campbell</name> + <email>jcampbell@gnome.org</email> + </credit> + <credit type="author"> + <name>Daniel Neel</name> + <email>dneelyep@gmail.com</email> + </credit> + <credit type="editor"> + <name>Sindhu S</name> + <email>sindhus@live.in</email> + </credit> + <credit type="editor"> + <name>Ekaterina Gerasimova</name> + <email>kittykat3756@gmail.com</email> + </credit> + <credit type="editor"> + <name>Shobha Tyagi</name> + <email>tyagishobha@gmail.com</email> + </credit> + <credit type="editor"> + <name>Young Li</name> + <email>li.young1618@gmail.com</email> + </credit> + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> + </info> + + <title>Replace text</title> + + <p>Editing text can be time consuming. To save time, <app>gedit</app> + includes a <app>Replace</app> function that helps you to find and replace + portions of text.</p> + + <steps> + <title>Replace text in <app>gedit</app></title> + <item> + <p>Open the <gui>Replace</gui> tool by clicking + <guiseq><gui style="button">Menu button</gui><gui style="menuitem">Find + and Replace…</gui></guiseq> or press + <keyseq><key>Ctrl</key><key>H</key></keyseq>.</p> + </item> + <item> + <p>Enter the text that you wish to replace into the <gui>Find</gui> + field.</p> + </item> + <item> + <p>Enter the new, replacement text into the <gui>Replace with</gui> + field.</p> + </item> + <item> + <p>Once you have entered the original and replacement text, you can add + extra parameters to the search. You can also choose what you want to + replace:</p> + <list> + <item> + <p>To replace <em>only</em> the next match, click + <gui>Replace</gui>.</p> + </item> + <item> + <p>To replace <em>all occurrences</em> of the searched-for text, + click <gui>Replace All</gui>.</p> + </item> + </list> + </item> + </steps> + + <note style="warning"> + <p>Use the <gui>Replace All</gui> function with care. <gui>Replace + All</gui> works on the entirety of your text file, and does not allow you + to highlight portions of text where the replace function will be + performed.</p> + </note> + +<section id="replace-options"> + <title>More options</title> + + <p>If you wish, you can add some extra parameters to your search:</p> + + <terms> + <item> + <title>Match case</title> + <p>The <em>Match case</em> option allows you to specify whether you want + your search to be case-sensitive. If this option is selected, searches + will be case-sensitive. If not, searches will not be case-sensitive.</p> + </item> + <item> + <title>Match entire word only</title> + <p>Use this option to search for a specific word without including + fragments of other words. For example, if you searched for the word + 'and' with this option selected, the word 'and' would be matched, but + the words 's<em>and</em>' and 'comm<em>and</em>er' would not be + matched.</p> + </item> + <item> + <title>Search backwards</title> + <p>This command behaves identically to the Find Previous command. If you + wish to step through search results from end to beginning, select this + option.</p> + </item> + <item> + <title>Wrap around</title> + <p>With the <app>wrap around</app> option enabled, <app>gedit</app> will + re-start the search/replace action at the top of the file after it has + reached the bottom of the file. This ensures that your search/replace + action is made across your entire file.</p> + </item> + </terms> + +</section> + +<section id="escape-sequences"> + <title>Using escape sequences</title> + + <p>You can use <em>escape sequences</em> to search for line breaks, carriage + returns, and tabs.</p> + + <terms> + <item> + <title>\n</title> + <p>Newline</p> + </item> + <item> + <title>\r</title> + <p>Carriage return</p> + </item> + <item> + <title>\t</title> + <p>Tab</p> + </item> + </terms> + + <p>If you actually want to search for a <output>\</output> (backslash) or one + of the escape sequences in the text, you need to escape the backslash with an + extra backslash. For example, to search for <input>\</input>, you need to + enter <input>\\</input> into the search or replace field. You can search for + escape sequences in the same way: to search for or replace with a + <input>\n</input>, use the <input>\\n</input> term.</p> + +</section> + +</page> diff --git a/help/C/gedit-save-file.page b/help/C/gedit-save-file.page new file mode 100644 index 0000000..34f2992 --- /dev/null +++ b/help/C/gedit-save-file.page @@ -0,0 +1,37 @@ +<page xmlns="http://projectmallard.org/1.0/" + xmlns:its="http://www.w3.org/2005/11/its" + type="topic" style="task" + id="gedit-save-file"> + + <info> + <link type="guide" xref="gedit-files-basic" group="third"/> + <desc>Save your file to work on it later.</desc> + <revision pkgversion="3.8" date="2013-02-24" status="review"/> + <revision pkgversion="3.12" date="2014-02-13" status="review"/> + <revision pkgversion="3.22" date="2014-02-13" status="review"/> + <credit type="author"> + <name>Jim Campbell</name> + <email>jcampbell@gnome.org</email> + </credit> + <credit type="editor"> + <name>Sindhu S</name> + <email>sindhus@live.in</email> + </credit> + <credit type="editor"> + <name>Shobha Tyagi</name> + <email its:translate="no">tyagishobha@gmail.com</email> + </credit> + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> + + </info> + + <title>Save a file</title> + + <p>To save a file in <app>gedit</app>, click on the + <gui style="button">Save</gui> button on the right side of the header bar or + just press <keyseq><key>Ctrl</key><key>S</key></keyseq>.</p> + <p>If you are saving a new file, a dialog will appear, and you can select a + name for the file, as well as the directory where you would like the file to + be saved.</p> + +</page> diff --git a/help/C/gedit-search.page b/help/C/gedit-search.page new file mode 100644 index 0000000..63e4c5b --- /dev/null +++ b/help/C/gedit-search.page @@ -0,0 +1,110 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="topic" style="task" + id="gedit-search"> + + <info> + <link type="guide" xref="index#gedit-working-with-files" /> + <link type="seealso" xref="gedit-replace" /> + <desc>Find a portion of text within a file.</desc> + <revision pkgversion="3.14" date="2014-12-04" status="review"/> + <revision pkgversion="3.24" date="2017-09-17" status="review"/> + <credit type="author"> + <name>Jim Campbell</name> + <email>jcampbell@gnome.org</email> + </credit> + <credit type="author"> + <name>Daniel Neel</name> + <email>dneelyep@gmail.com</email> + </credit> + <credit type="editor"> + <name>Sindhu S</name> + <email>sindhus@live.in</email> + </credit> + <credit type="editor"> + <name>Shobha Tyagi</name> + <email>tyagishobha@gmail.com</email> + </credit> + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> + </info> + + <title>Search for text</title> + + <p>The Find tool can help you find specific sequences of text within in your + file.</p> + + <steps> + <title>Finding text</title> + <item> + <p>Open the <gui>search window</gui> by clicking + <guiseq><gui style="menu">Menu Button</gui> + <gui style="menuitem">Find…</gui> </guiseq> or + pressing <keyseq><key>Ctrl</key><key>F</key></keyseq>. This will move + your cursor to the start of the <gui>search window</gui>.</p> + </item> + <item> + <p>Type the text you wish to search for in the + <gui>search window</gui>.</p> + </item> + <item> + <p>As you type, <app>gedit</app> will begin highlighting the portions of + text that match what you have entered.</p> + </item> + </steps> + + <p>To scroll through the search results, do any of the following:</p> + <list> + <item> + <p>Click on the <gui style="button">up</gui> or + <gui style="button">down</gui> facing arrows next to the + <gui>search window</gui>.</p> + </item> + <item> + <p>Press the <key>up arrow</key> or <key>down arrow</key> keys on your + keyboard.</p> + </item> + <item> + <p>Press <keyseq><key>Ctrl</key><key>G</key></keyseq> or + <keyseq><key>Ctrl</key><key>Shift</key><key>G</key></keyseq>.</p> + </item> + </list> + + <p>To close the <gui>search window</gui>, press either <key>Esc</key> or + <key>Enter</key>. Pressing <key>Esc</key> will return the cursor to where it + was before you began your search. Pressing <key>Enter</key> will return the + cursor to the current position in the search results.</p> + + <list> + <title>Search tips</title> + <item> + <p>If you highlight a portion of text with your mouse, and then press + <keyseq><key>Ctrl</key><key>F</key></keyseq>, the text you've highlighted + will appear in the search window.</p> + </item> + <item> + <p>For more search options, click on the + <gui style="button">Magnifying Glass</gui> icon in the search window, + or right-click anywhere in the search window. You can select one or more + of the following search options:</p> + <list> + <item> + <p>Select <gui>Match Case</gui> to make the search case sensitive.</p> + </item> + <item> + <p>Select <gui>Match Entire Word Only</gui> to search only complete + words.</p> + </item> + <item> + <p>Select <gui>Wrap Around</gui> to search text from top to bottom + and cycle back again.</p> + </item> + </list> + </item> + <item> + <p>The text that you've searched for will remain highlighted by gedit, + even after you have completed your search. To remove the highlight, + click <gui style="menuitem">Clear Highlight</gui>, or + press <keyseq><key>Ctrl</key><key>Shift</key><key>K</key></keyseq>.</p> + </item> + </list> + +</page> diff --git a/help/C/gedit-spellcheck.page b/help/C/gedit-spellcheck.page new file mode 100644 index 0000000..063fe59 --- /dev/null +++ b/help/C/gedit-spellcheck.page @@ -0,0 +1,135 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="topic" style="task" + id="gedit-spellcheck"> + + <info> + <link type="guide" xref="gedit-plugin-guide#gedit-default-plugins" /> + <desc>Check your files for spelling errors.</desc> + <revision pkgversion="3.8" date="2013-02-24" status="review"/> + <revision pkgversion="3.8" date="2013-03-21" status="review"/> + + <credit type="author"> + <name>Jim Campbell</name> + <email>jcampbell@gnome.org</email> + </credit> + <credit type="author"> + <name>Baptiste Mille-Mathias</name> + <email>baptistem@gnome.org</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"/> + + </info> + + <title>Spell-check your document</title> + <section id="enable-spell-check"> + <title>Enable the spell checker</title> + <p>The Spell-check feature is provided as a plugin in <app>gedit</app> which + can be enabled as required. To enable the 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">Spell Checker</gui> to enable the + plugin.</p> + </item> + </steps> + + </section> + + <section id="spell-check"> + <title>Spell-check your document</title> + + <p>To check for misspelt words in your document:</p> + + <steps> + <item> + <p>Select <guiseq><gui style="menu">Tools</gui> + <gui style="menuitem">Check Spelling</gui></guiseq>.</p> + </item> + </steps> + + <note style="tip"> + <p>To have <app>gedit</app> automatically highlight misspelt words in your + document as you type, select <guiseq><gui style="menu">Tools</gui><gui + style="menuitem">Highlight Misspelled Words</gui></guiseq>.</p> + </note> + </section> + + <section id="use-spell-check"> + <title>Using spell-check</title> + + <p>You can choose the right substitution for misspelt words using the Check + Spelling dialog. The misspelt word being checked by the spell-checker is + displayed in bold style next to <gui>Misspelled word:</gui>. + You can choose from the following corrective actions:</p> + + <list> + <item> + <p><gui style="input">Change to:</gui> allows you to input a word and + use <gui style="button">Check Word</gui> to check the validity of the + spelling.</p> + </item> + <item> + <p><gui style="menu">Suggestions:</gui> lists the available + substitutions for the word.</p> + </item> + <item> + <p><gui style="button">Ignore</gui> allows you to bypass spell check for + <em>a</em> instance of current word.</p> + </item> + <item> + <p><gui style="button">Ignore All</gui> allows you to bypass spell check + for <em>all</em> instances of the current word.</p> + </item> + <item> + <p><gui style="button">Change</gui> substitutes the misspelt or + unrecognized word with <em>a</em> chosen substitute from the + <gui style="menuitem">Suggestions:</gui> list.</p> + </item> + <item> + <p><gui style="button">Change all</gui> substitutes <em>all</em> + misspelt or unrecognized words with the chosen substitute from the + <gui style="menuitem">Suggestions:</gui> list.</p> + </item> + <item> + <p><gui style="button">Add word</gui> allows you to add the current word + to the <app>gedit</app> <gui>User dictionary</gui>. Adding custom words + to the <gui>User dictionary</gui> will allow <app>gedit</app> to + recognize the word in documents and thus will not be highlighted as a + misspelt word.</p> + </item> + </list> + + </section> + + <section id="define-spell-check-language"> + <title>Define the language to use for spell checking</title> + <p>By default, <app>gedit</app> will use your current language to spell + check your document. If you need to use another language, choose + <guiseq><gui style="menu">Tools</gui><gui style="menuitem">Set + Language…</gui></guiseq>, then choose the language you want to use.</p> + </section> + + <section id="dict"> + <title>Dictionaries</title> + + <p><app>gedit</app> uses + <link href="https://www.abisource.com/projects/enchant/">Enchant</link>, + a small system utility, for spell checking. Enchant can use + several different dictionaries to check your spelling. Two such + dictionary back-ends are <em>Hunspell</em> and <em>Aspell</em>.</p> + + <p>If the language you want to use is not available in <app>gedit</app>, + use your computer's software installer or package manager to install the + dictionary back-end that you want.</p> + </section> +</page> diff --git a/help/C/gedit-syntax-highlighting.page b/help/C/gedit-syntax-highlighting.page new file mode 100644 index 0000000..b65f6b4 --- /dev/null +++ b/help/C/gedit-syntax-highlighting.page @@ -0,0 +1,37 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="topic" style="task" + id="gedit-syntax-highlighting"> + + <info> + <link type="guide" xref="index#configure-gedit"/> + <desc>Highlight your text to make it easier to read.</desc> + <revision pkgversion="3.8" date="2013-02-24" status="review"/> + <credit type="author"> + <name>Jim Campbell</name> + <email>jcampbell@gnome.org</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"/> + </info> + + <title>Turn on syntax highlighting</title> + + <section id="gedit-syntax-highlighting-section"> + <title>Syntax highlighting</title> + <p><app>gedit</app> provides syntax highlighting for a wide range of markup, + programming, and scientific languages. If <app>gedit</app> recognizes the + syntax being used when you open a file, it will automatically highlight the + text.</p> + + <p>If your syntax or language is not highlighted upon startup, you can + select the appropriate syntax or language by clicking + <guiseq><gui style="menu">View</gui> + <gui style="menuitem">Highlight Mode</gui></guiseq>, + and then choosing the desired syntax. Alternately, you can select the syntax + name from a list at the bottom of the <app>gedit</app> window.</p> + </section> + +</page> diff --git a/help/C/gedit-tab-groups.page b/help/C/gedit-tab-groups.page new file mode 100644 index 0000000..d7ed84e --- /dev/null +++ b/help/C/gedit-tab-groups.page @@ -0,0 +1,104 @@ +<page xmlns="http://projectmallard.org/1.0/" + xmlns:its="http://www.w3.org/2005/11/its" + type="topic" style="task" + id="gedit-tab-groups"> + + <info> + <link type="guide" xref="index#gedit-working-with-files" group="last"/> + <link type="seealso" xref="gedit-tabs"/> + <link type="seealso" xref="gedit-tabs-moving"/> + <desc>Group similar tabs together.</desc> + <revision pkgversion="3.8" date="2013-06-19" status="draft"/> + + <credit type="author copyright"> + <name>Radina Matic</name> + <email its:translate="no">radina.matic@gmail.com</email> + <years>2013</years> + </credit> + + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> + </info> + + <title>Organize files in grouped tabs</title> + + <p>If you are working with multiple tabs in <app>gedit</app> you can group + them, making it easier to keep your opened files organized. Adding a new tab + group will divide the <app>gedit</app> window in two panes, open a new + “Untitled Document” in the new pane, and make it active. You can open files + into that tab group and move tabs from one tab group to another.</p> + +<section id="open-new-tab-group"> + <title>Open a new tab group in the gedit window</title> + + <p>To open a new tab group you can:</p> + + <list> + <item> + <p>Right click on a tab and select <gui>Move to New Tab Group</gui>.</p> + </item> + <item> + <p>Use the <keyseq><key>Ctrl</key><key>Alt</key><key>N</key></keyseq> + shortcut.</p> + </item> + </list> + + <p>This action will divide the <app>gedit</app> window in two panes, and the + pane with the new tab group will be placed on the right of the active tab. + You can move the handle right or left assigning more or less space of the + <app>gedit</app> window between panes according to your needs.</p> + + <p>You can open as much tab groups in a <app>gedit</app> window as your screen + allows, but you will have to move the handle in order to see them + correctly.</p> + + <p>To close a tab group pane just close all the tabs that are opened inside + it.</p> +</section> + +<!-- +FIXME: These shortcuts don't work. +<section id="moving-through-tab-groups"> + <title>Move through tab groups</title> + + <p>To move forward (on the next) tab group:</p> + + <list> + <item> + <p>Use the <keyseq><key>Shift</key><key>Ctrl</key><key>Alt</key><key>Page + down</key></keyseq> shortcut.</p> + </item> + </list> + + <p>To move backward (on the previous) tab group:</p> + + <list> + <item> + <p>Use the <keyseq><key>Shift</key><key>Ctrl</key><key>Alt</key><key>Page + up</key></keyseq> shortcut.</p> + </item> + </list> +</section> +--> + +<section id="moving-tabs-among-groups"> + <title>Move a tab to another tab group</title> + + <p>If you want to move a tab from one tab group to another:</p> + + <steps> + <item> + <p>Click and hold the mouse button on the tab.</p> + </item> + <item> + <p>Drag the tab to another tab group pane.</p> + </item> + <item> + <p>Place it beside other tabs in the tab group.</p> + </item> + <item> + <p>Release the mouse button.</p> + </item> + </steps> + +</section> +</page> diff --git a/help/C/gedit-tabs-moving.page b/help/C/gedit-tabs-moving.page new file mode 100644 index 0000000..644268f --- /dev/null +++ b/help/C/gedit-tabs-moving.page @@ -0,0 +1,112 @@ +<page xmlns="http://projectmallard.org/1.0/" + xmlns:its="http://www.w3.org/2005/11/its" + type="topic" style="task" + id="gedit-tabs-moving"> + + <info> + <link type="guide" xref="index#gedit-working-with-files" group="last"/> + <link type="seealso" xref="gedit-tabs"/> + <link type="seealso" xref="gedit-tab-groups"/> + <desc>Change the position of a tab in the gedit window.</desc> + <revision pkgversion="3.8" date="2013-02-24" status="review"/> + <credit type="author"> + <name>Jim Campbell</name> + <email>jcampbell@gnome.org</email> + </credit> + <credit type="collaborator"> + <name>Daniel Neel</name> + <email>dneelyep@gmail.com</email> + </credit> + <credit type="editor"> + <name>Sindhu S</name> + <email>sindhus@live.in</email> + </credit> + <credit type="editor"> + <name>Radina Matic</name> + <email its:translate="no">radina.matic@gmail.com</email> + <years>2013</years> + </credit> + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> + </info> + + <title>Move and re-order tabs</title> + <p>Tabs in <app>gedit</app> can be moved, making it easier to work with your + files. Tabs can be can re-ordered within the same window, moved outside of + <app>gedit</app> (creating a new <app>gedit</app> window), and moved from one + window to another.</p> + + <section id="tabs-change-order"> + <title>Change the order of tabs in the gedit window</title> + + <p>To change the ordering of tabs in a window:</p> + + <steps> + <item> + <p>Click and hold the mouse button on the tab.</p> + </item> + <item> + <p>Move the tab to the desired position among the other tabs.</p> + </item> + <item> + <p>Release the mouse button.</p> + </item> + </steps> + + <p>The tab will be placed in the position closest to where you release the + tab, immediately beside other opened tabs.</p> + </section> + + <section id="tabs-moving-new-window"> + <title>Move a tab, creating a new gedit window</title> + <p>To create a new window from an existing tab:</p> + + <steps> + <item> + <p>Click and hold the mouse button on the tab.</p> + </item> + <item> + <p>Drag the tab out of the <app>gedit</app> window.</p> + </item> + <item> + <p>Release the mouse button.</p> + </item> + </steps> + + <note style="tip"> + <p>To move a tab into a new window when <app>gedit</app> is maximized, + drag the tab onto the top bar at the top of the screen.</p> + </note> + </section> + + <section id="tabs-moving-other-window"> + <title>Move a tab to another gedit window</title> + + <p>If you want to move a tab from one window to another:</p> + + <steps> + <item> + <p>Click and hold the mouse button on the tab.</p> + </item> + <item> + <p>Drag the tab to the new window.</p> + </item> + <item> + <p>Place it beside other tabs in the new window.</p> + </item> + <item> + <p>Release the mouse button.</p> + </item> + </steps> + + + <note style="tip"> + <p>You may find it easier to move a tab from one window to another by + dragging the tab to the <gui>Activities</gui> hot-corner of + <gui>GNOME Shell</gui>. This will reveal each of the open + <app>gedit</app> windows. You can then release the tab on the + desired <app>gedit</app> window.</p> + </note> + + </section> + +</page> diff --git a/help/C/gedit-tabs.page b/help/C/gedit-tabs.page new file mode 100644 index 0000000..52e5d68 --- /dev/null +++ b/help/C/gedit-tabs.page @@ -0,0 +1,58 @@ +<page xmlns="http://projectmallard.org/1.0/" + xmlns:its="http://www.w3.org/2005/11/its" + type="topic" style="task" + id="gedit-tabs"> + + <info> + <link type="guide" xref="index#gedit-working-with-files" group="second"/> + <link type="seealso" xref="gedit-tabs-moving"/> + <link type="seealso" xref="gedit-tab-groups"/> + <desc>Create or close tabs in the gedit window.</desc> + <revision pkgversion="3.8" date="2013-02-24" status="review"/> + <revision pkgversion="3.12" date="2014-02-12" status="review"/> + <credit type="author"> + <name>Jim Campbell</name> + <email>jcampbell@gnome.org</email> + </credit> + <credit type="collaborator"> + <name>Daniel Neel</name> + <email>dneelyep@gmail.com</email> + </credit> + <credit type="editor"> + <name>Sindhu S</name> + <email>sindhus@live.in</email> + </credit> + <credit type="editor"> + <name>Radina Matic</name> + <email its:translate="no">radina.matic@gmail.com</email> + <years>2013</years> + </credit> + <credit type="editor"> + <name>Shobha Tyagi</name> + <email its:translate="no">tyagishobha@gmail.com</email> + </credit> + + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> + </info> + + <title>Add and remove tabs</title> + <p>Working with tabs in <app>gedit</app> allows you to keep an eye on several + files in a single window.</p> + + <section id="gedit-adding-tabs"> + <title>Adding tabs</title> + <p>To add a new tab to create a new file, click the <gui>Create a new + document</gui> button on the left side of the header bar, or press + <keyseq><key>Ctrl</key><key>T</key></keyseq>. The tab will be added to the + right side of any other tabs.</p> + </section> + + <section id="gedit-removing-tabs"> + <title>Removing tabs</title> + <p>To remove a tab, click the <gui style="button">×</gui> on the tab's + right side, or press <keyseq><key>Ctrl</key><key>W</key></keyseq>. To + remove all open tabs, press <keyseq><key>Ctrl</key> + <key>Shift</key><key>W</key></keyseq>.</p> + </section> + +</page> diff --git a/help/C/gedit-undo-redo.page b/help/C/gedit-undo-redo.page new file mode 100644 index 0000000..93f3c1d --- /dev/null +++ b/help/C/gedit-undo-redo.page @@ -0,0 +1,42 @@ +<page xmlns="http://projectmallard.org/1.0/" + xmlns:its="http://www.w3.org/2005/11/its" + type="topic" style="task" + id="gedit-undo-redo"> + + <info> + <link type="guide" xref="index#gedit-working-with-files"/> + <desc>Revert a recent change to one of your files.</desc> + <revision pkgversion="3.8" date="2013-02-24" status="review"/> + <revision pkgversion="3.12" date="2014-02-17" status="review"/> + <credit type="author"> + <name>Jim Campbell</name> + <email>jcampbell@gnome.org</email> + </credit> + <credit type="author"> + <name>Daniel Neel</name> + <email>dneelyep@gmail.com</email> + </credit> + <credit type="editor"> + <name>Sindhu S</name> + <email>sindhus@live.in</email> + </credit> + <credit type="editor"> + <name>Shobha Tyagi</name> + <email its:translate="no">tyagishobha@gmail.com</email> + </credit> + + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> + </info> + + <title>Undo/redo a recent action</title> + + <p>If you make a mistake while editing a document in <app>gedit</app>, you can + undo the change by pressing <keyseq><key>Ctrl</key><key>Z</key></keyseq>.</p> + + <note style="important"> + <p>You cannot undo a change after you have closed a <app>gedit</app> file.</p> + </note> + + <p>To redo the change that was undone, press + <keyseq><key>Ctrl</key><key>Shift</key><key>Z</key></keyseq>.</p> +</page> diff --git a/help/C/gnome-help.sct b/help/C/gnome-help.sct new file mode 100644 index 0000000..0c1e623 --- /dev/null +++ b/help/C/gnome-help.sct @@ -0,0 +1,22 @@ +<schema xmlns="http://www.ascc.net/xml/schematron" > + <title>Some sanity checks for the GNOME desktop help</title> + <ns prefix="mal" uri="http://projectmallard.org/1.0/"/> + <ns prefix="xi" uri="http://www.w3.org/2001/XInclude"/> + <pattern name="Info element checks"> + <rule context="mal:page/mal:info"> + <assert test="not(mal:license)">Must not include license directly</assert> + <assert test="xi:include[@href='legal.xml']">Must include legal.xml</assert> + </rule> + </pattern> + <pattern name="Desc checks"> + <rule context="mal:page/mal:info"> + <assert test="normalize-space(mal:desc) != ''">Must have non-empty desc</assert> + </rule> + <rule context="mal:page/mal:info/mal:desc"> + <assert test="substring(normalize-space(.), string-length(normalize-space(.))) = '.'">Desc must end with a period</assert> + </rule> + <rule context="mal:page/mal:info/mal:desc/mal:link"> + <assert test="substring(normalize-space(..), string-length(normalize-space(..)) - 2) = '...'">Desc with links must end with an ellipsis</assert> + </rule> + </pattern> +</schema> diff --git a/help/C/index.page b/help/C/index.page new file mode 100644 index 0000000..d66861b --- /dev/null +++ b/help/C/index.page @@ -0,0 +1,54 @@ +<page xmlns="http://projectmallard.org/1.0/" + xmlns:its="http://www.w3.org/2005/11/its" + xmlns:e="http://projectmallard.org/experimental/" + type="guide" style="2column task" + id="index"> + + <info> + <title type="link">gedit Text Editor</title> + <title type="text">gedit Text Editor</title> + + <desc>Home page of the gedit help guide.</desc> + <revision pkgversion="3.8" date="2013-02-24" status="review"/> + <credit type="author"> + <name>Jim Campbell</name> + <email its:translate="no">jcampbell@gnome.org</email> + </credit> + <credit type="editor"> + <name>Sindhu S</name> + <email its:translate="no">sindhus@live.in</email> + </credit> + + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude" /> + + </info> + + <title> + <media type="image" mime="image/png" src="figures/gedit-icon.png" its:translate="no" /> + gedit Text Editor + </title> + <p>Welcome to the <app>gedit</app> help guide. For a quick introduction into + <app>gedit's</app> most basic features, visit the + <link xref="gedit-quickstart">Get started with gedit</link> page.</p> + + <p>Other help topics are grouped together into sections below. Enjoy using + <app>gedit</app>!</p> + + <section id="gedit-working-with-files"> + <title>Working With Files</title> + <links type="topic" groups="first second third fourth fifth sixth last" style="2column"/> + </section> + + <section id="configure-gedit" style="2column"> + <title>Configure gedit</title> + </section> + + <section id="gedit-plugins" style="2column"> + <title>gedit Plugins</title> + </section> + + <section id="gedit-printing-guide" style="2column"> + <title>Printing with gedit</title> + </section> + +</page> diff --git a/help/C/legal.xml b/help/C/legal.xml new file mode 100644 index 0000000..2a5cd29 --- /dev/null +++ b/help/C/legal.xml @@ -0,0 +1,6 @@ +<license xmlns="http://projectmallard.org/1.0/" + href="http://creativecommons.org/licenses/by-sa/3.0/"> + <p>This work is licensed under a <link href="https://creativecommons.org/licenses/by-sa/3.0/">Creative + Commons Attribution-ShareAlike 3.0 Unported License</link>.</p> +</license> + diff --git a/help/C/schematron.sh b/help/C/schematron.sh new file mode 100755 index 0000000..dc69b43 --- /dev/null +++ b/help/C/schematron.sh @@ -0,0 +1 @@ +xmllint --noout --schematron gnome-help.sct ./*.page 2>&1 | grep -v validates |
