Re: Automatic Menu Substitution In Gnome Help Documentation
- From: Matt Keenan <Matt Keenan Sun COM>
- To: Danilo Šegan <danilo gnome org>
- Cc: gnome-doc-devel-list gnome org
- Subject: Re: Automatic Menu Substitution In Gnome Help Documentation
- Date: Thu, 23 Feb 2006 17:38:06 +0000
Danilo Šegan wrote:
Actually, it might be simpler to do the replacing in xml2po docbook
mode (basically, that's where there is currently a crude hack to try
to add translators credits and to get messages for images and such).
Basically, you have entire XML tree there on your disposal (look how I
try to find articleinfo section to add <copyright> for translators)
I'll take a look at this over the next few days, certainly would
possibly make life
easier of all the work was being done in the one place, correct me if I
am wrong
but by running xml2po, this proceses C/<module>.xml to generate the various
<lang>/<module>.xml files, however I want to introduce a step prior to this
which will generate C/<module>.xml from C/<module>.xml.in.
Do you think performing this processing within xml2po is the right way
to do
this ? I know the entire XML tree being available within here is a
definite plus.
postProcessXmlTranslation() is what you need to extend for this. If
you need help, feel free to let me know :)
As I said I have a gander into xml2po source over the next few days to
see if
I can decipher what's going on. Python, another new language to learn :)
There is a good chance I will be calling on you for help thanks...
OTOH, if we do it this way, it might be even easier to extend xml2po
to have <guimenu>s, <guibutton>s etc. automatically translated using a
PO or MO file with their app translation (which would have the same
effect, but it still wouldn't be that cool :), or at least put those
translations as comments for translators.
Any other approach (the one you are suggesting) is much more
complicated: instead of dealing only with simple XML, xml2po would
have to handle semi-translated XML as well where some snippets would
stay as they are and some would need to be extracted. And xml2po
already has quite some knowledge about what's it doing regarding
languages, so it's probably best to put such handling there.
Currently xml2po deals directly with the hard coded menu path within
C/<module>.xml
the step I am suggesting is replaceing the hard coded bit... Are you
saying that the newly
generated menu path may not be translatable.. as these strings may not
be in the po files ?
- Amend utility gnome-menu-spec-test, delivered by gnome-menus to
output complete menu line.
At the moment it only outputs the lower level menu structure, a very
quick change would
output the complete menu structure (patch attached). This utility
uses libmenu in the exact same manner
as gnome-panel does to determine menu location for applications.
We might still want to make use of this part in xml2po: simply having
menupath's replaced in postProcessXmlTranslation() is by far the
simplest thing to do (at least IMHO).
What do you think of this approach instead?
I Will definitely take a look at this, it may indeed make perfect sense...
Basically, the only difference is that I'd replace your:
- Actual conversion from xml.in -> xml. This is the part I have yet to
decide upon. I could
- Simply write a script similar to xml2po that would just substitute
the menu in the menu locations
e.g. Changing :
<gnome:menupath for="gedit">
To
<term> <guimenu>Applications</guimenu></term>
<listitem>
<para>Choose <menuchoice>
<guisubmenu>Accessories</guisubmenu>
<guimenuitem>Text
Editor. </guimenuitem></menuchoice></para>
</listitem>
with "let xml2po DocBook mode do that for us" (or create
docbook-extended mode extending on docbook mode :).
What is xml2po DocBook mode ? just one of the many questions that I will
have to answer as I investigate into xml2po further.
Sure, it's probably the better way ahead. The only thing that bothers
me is handling of translated menu paths: gnome-menu-spec-test doesn't
seem to set the locale correctly, since it outputs "????" instead of
Cyrillic translations for me. ;)
gnome-menu-spec-test does not need to handle locales correctly, well I don't
think it does, it is just giving me the menu path for the C locale,
xml2po then
would perform the translations, unless I am completely misunderstaning
things :)
I've re-worked my patches for my first attempt solution e.g. not using
xml2po.
Changes would be made to gnome-menus, gnome-doc-utils, and of course
each individual module that is going to use these. If all/most of this
processing
can be done directly within xml2po then great, e.g. I know python has C
bindings
so I could directly call the libmenu API's and this not have to use
gnome-menu-spec-test
and not have the need for the new script get-menu-location. I still
think that I will
need to have the new stylesheet menusub.xsl and call this from within
xml2po, and
also the Makefile variable DOC_DESKTOP_FILE will still need to be defined
and used. but would definitley minimize changes that would have to be
made to
gnome-doc-utils.make and gnome-menus aswell..
Either way I've attached my current patches. Now to go off and
investigate xml2po
gnome-doc-utils.diff
Necessary changes to gnome-doc-utils, involves following changes :
- gnome-doc-utils.make
Performs the necessary processing from
C/<module>xml.in to C/<module>.xml
Using new Makefile var DOC_DESKTOP_FILE, and new
stylesheet menusub.xsl
and new utility get-menu-location (supplied by
gnome-menus)
- gnome-doc-utils.pc.in
Inclusion of definition for new xslt stylesheet menusub.xsl
- xslt/docbook/util/menusub.xsl
New xsl stylesheet which takes output from
get-menu-location and automatically substitutes
<menupath/> within C/<module>.xml.in
- xslt/docbook/util/Makefile.am
modified to install new menusub.xsl stylesheet.
gnome-menus.diff
Changes for gnome-menus which include :
- util/test-menu-spec.c
Modified to output complete menu path, at the moment it
does not ouput main menu, just submenus.
- util/get-menu-location
New bash script that uses gnome-menu-spec-test to determine
the menu location for a specific .desktop
file. This will output the menu location in xml format as
follows :
<menu>
<mainmenu>
<item>MAIN MENU TEXT</item>
</mainmenu>
<submenu>
<item>SUB MENU TEXT</item>
</submenu>
.
.
<menuitem>
<item>MENU ITEM TEXT</item>
</menuitem>
</menu>
There may be more than one submenu's depending on how
nested the menus are. This file is used in
menusub.xml to replace the node <menupath/>
- util/Makefile.am
Changes to install new script get-menu-location
gedit.diff
Changes I would make to gedit as an example. Includes :
- help/Makefile.am
Addition of new Variable DOC_DESKTOP_FILE
- Makefile.am
Changes to ensure gedit.desktop is generated before help is
processed, e.g. process data dir before help :)
- help/C/gedit.xml.in
new file basically the same as help/C/gedit.xml, except
replaced all menu specific information with just one
new node <menupath/>
- help/C/legal.xml.in
Exactly the same as help/C/legal.xml.in
If applying this patch you need to remove help/C/*.xml, don't
know now you would do this in a diff file ?
--- ../gnome-doc-utils/gnome-doc-utils.make 2006-02-18 22:47:21.000000000 +0000
+++ ./gnome-doc-utils.make 2006-02-23 16:04:37.544023000 +0000
@@ -128,6 +128,7 @@
_chunks ?= `$(PKG_CONFIG) --variable xmldir gnome-doc-utils`/gnome/xslt/docbook/utils/chunks.xsl
_credits ?= `$(PKG_CONFIG) --variable xmldir gnome-doc-utils`/gnome/xslt/docbook/utils/credits.xsl
_ids ?= `$(PKG_CONFIG) --variable xmldir gnome-doc-utils`/gnome/xslt/docbook/utils/ids.xsl
+_menusub ?= `$(PKG_CONFIG) --variable menusub gnome-doc-utils`
_sklocalstatedir ?= `scrollkeeper-config --pkglocalstatedir`
@@ -342,6 +343,10 @@
## The top-level documentation file in the C locale
_DOC_C_MODULE = $(if $(DOC_MODULE),C/$(DOC_MODULE).xml)
+## @ _DOC_C_MODULE_IN
+## The top-level input documentation file in the C locale
+_DOC_C_MODULE_IN = $(if $(DOC_MODULE),C/$(DOC_MODULE).xml.in)
+
## @ _DOC_C_ENTITIES
## Files included with a SYSTEM entity in the C locale
_DOC_C_ENTITIES = $(foreach ent,$(DOC_ENTITIES),C/$(ent))
@@ -350,6 +355,10 @@
## Files included with XInclude in the C locale
_DOC_C_INCLUDES = $(foreach inc,$(DOC_INCLUDES),C/$(inc))
+## @ _DOC_C_INCLUDES_IN
+## Input Files included with a SYSTEM entity in the C locale
+_DOC_C_INCLUDES_IN = $(foreach ent,$(DOC_INCLUDES),C/$(ent).in)
+
## @ _DOC_C_DOCS
## All documentation files in the C locale
_DOC_C_DOCS = \
@@ -357,6 +366,16 @@
$(_RNGDOC_C_DOCS) $(_XSLDOC_C_DOCS) \
$(_DOC_C_MODULE)
+## @ _DOC_C_DOCS_IN
+## All documentation files in the C locale
+_DOC_C_DOCS_IN = \
+ $(_DOC_C_INCLUDES_IN) $(_DOC_C_MODULE_IN)
+
+## @ _DOC_C_DOCS_XML
+## All xml documentation files in the C locale
+_DOC_C_DOCS_XML = \
+ $(_DOC_C_INCLUDES) $(_DOC_C_MODULE) C/menu-location.xml
+
## @ _DOC_C_DOCS_NOENT
## All documentation files in the C locale,
## except files included with a SYSTEM entity
@@ -434,7 +453,7 @@
$(foreach fig,$(_DOC_C_FIGURES), $(foreach lc,C $(DOC_LINGUAS), \
$(wildcard $(srcdir)/$(lc)/$(patsubst C/%,%,$(fig))) ))
-$(_DOC_POFILES):
+$(_DOC_POFILES): $(_DOC_C_DOCS)
@if ! test -d $(dir $@); then \
echo "mkdir $(dir $@)"; \
mkdir "$(dir $@)"; \
@@ -465,6 +484,23 @@
$(_xml2po) -e -u $(notdir $@) $$docs); \
fi
+# Conversion of C/*.xml.in to C/*.xml
+# DOC_DESKTOP_FILE Needs to be defined !
+$(_DOC_C_DOCS) : $(_DOC_C_DOCS_IN)
+ @if ! test x$(DOC_DESKTOP_FILE) = x; then \
+ if ! test -f C/menu-location.xml; then \
+ get-menu-location $(DOC_DESKTOP_FILE) C/menu-location.xml; \
+ fi; \
+ sed -e "s/&/XXXAMPXXX/g" -e "s/^<!DOCTYPE /<!--DOCTYPE /" -e "s/^]>/]-->/" C/$(notdir $@).in > $$.tmp1; \
+ xsltproc -o $$.tmp2 --stringparam menu-location "`pwd`/C/menu-location.xml" $(_menusub) $$.tmp1; \
+ sed -e "s/XXXAMPXXX/\&/g" -e "s/^<!--DOCTYPE /<!DOCTYPE /" -e "s/^]-->/]>/" $$.tmp2 > C/$(notdir $@); \
+ rm -f $$.tmp1 $$.tmp2; \
+ else \
+ if [ -f C/$(notdir $@).in ]; then \
+ cp -f C/$(notdir $@).in C/$(notdir $@); \
+ fi; \
+ fi
+
# FIXME: fix the dependancy
# FIXME: hook xml2po up
$(_DOC_LC_DOCS) : $(_DOC_POFILES)
@@ -510,12 +546,13 @@
endif
all: \
+ $(_DOC_C_DOCS_IN) \
$(_DOC_C_DOCS) $(_DOC_LC_DOCS) \
$(_DOC_OMF_ALL) $(_DOC_DSK_ALL) \
$(_DOC_HTML_ALL) $(_DOC_POFILES)
-.PHONY: clean-doc-rngdoc clean-doc-xsldoc clean-doc-omf clean-doc-dsk clean-doc-lc clean-doc-dir
+.PHONY: clean-doc-rngdoc clean-doc-xsldoc clean-doc-omf clean-doc-dsk clean-doc-lc clean-doc-dir clean-doc-xml
clean-doc-rngdoc: ; rm -f $(_RNGDOC_C_DOCS) $(_RNGDOC_LC_DOCS)
clean-doc-xsldoc: ; rm -f $(_XSLDOC_C_DOCS) $(_XSLDOC_LC_DOCS)
@@ -535,6 +572,8 @@
rm -f "$$lc/.xml2po.mo"; \
fi; \
done
+clean-doc-xml:
+ rm -f $(_DOC_C_DOCS_XML)
clean-doc-dir:
@for lc in C $(DOC_LINGUAS); do \
for dir in `find $$lc -depth -type d`; do \
@@ -550,25 +589,29 @@
_clean_omf = $(if $(_DOC_OMF_IN),clean-doc-omf)
_clean_dsk = $(if $(_DOC_DSK_IN),clean-doc-dsk)
_clean_lc = $(if $(DOC_LINGUAS),clean-doc-lc)
+_clean_xml = $(if $(DOC_MODULE),clean-doc-xml)
_clean_dir = $(if $(DOC_MODULE),clean-doc-dir)
clean-local: \
$(_clean_rngdoc) $(_clean_xsldoc) \
$(_clean_omf) $(_clean_dsk) \
- $(_clean_lc) $(_clean_dir)
+ $(_clean_lc) $(_clean_xml) \
+ $(_clean_dir)
distclean-local: \
$(_clean_rngdoc) $(_clean_xsldoc) \
$(_clean_omf) $(_clean_dsk) \
- $(_clean_lc) $(_clean_dir)
+ $(_clean_lc) $(_clean_xml) \
+ $(_clean_dir)
mostlyclean-local: \
$(_clean_rngdoc) $(_clean_xsldoc) \
$(_clean_omf) $(_clean_dsk) \
- $(_clean_lc) $(_clean_dir)
+ $(_clean_lc) $(_clean_xml) \
+ $(_clean_dir)
maintainer-clean-local: \
$(_clean_rngdoc) $(_clean_xsldoc) \
$(_clean_omf) $(_clean_dsk) \
- $(_clean_lc) $(_clean_dir)
-
+ $(_clean_lc) $(_clean_xml) \
+ $(_clean_dir)
.PHONY: dist-doc-docs dist-doc-figs dist-doc-omf dist-doc-dsk
doc-dist-hook: \
@@ -705,7 +748,7 @@
uninstall-local: \
$(if $(DOC_MODULE),uninstall-doc-docs) \
$(if $(_DOC_HTML_ALL),uninstall-doc-html) \
- $(if $(_DOC_C_FIGURES),uninstall-doc-figs) \
+ $(if $(_DOC_FIGURES),uninstall-doc-figs) \
$(if $(_DOC_OMF_IN),uninstall-doc-omf)
# $(if $(_DOC_DSK_IN),uninstall-doc-dsk)
--- ../gnome-doc-utils/gnome-doc-utils.pc.in 2005-09-13 14:40:59.000000000 +0100
+++ ./gnome-doc-utils.pc.in 2006-02-22 16:22:33.408877000 +0000
@@ -8,6 +8,7 @@
db2omf=${xsltdir}/docbook/omf/db2omf.xsl
rngdoc=${xsltdir}/rngdoc/rngdoc.xsl
xsldoc=${xsltdir}/xsldoc/xsldoc.xsl
+menusub=${xsltdir}/docbook/utils/menusub.xsl
Name: gnome-doc-utils
Description: GNOME Documentation Utilities
--- ../gnome-doc-utils/xslt/docbook/utils/Makefile.am 2005-01-16 23:42:57.000000000 +0000
+++ ./xslt/docbook/utils/Makefile.am 2006-02-22 16:28:23.523717000 +0000
@@ -1,6 +1,6 @@
xsldir=$(datadir)/xml/gnome/xslt/docbook/utils
-xsl_DATA = chunks.xsl credits.xsl ids.xsl
+xsl_DATA = chunks.xsl credits.xsl ids.xsl menusub.xsl
EXTRA_DIST=$(xsl_DATA)
--- ../gnome-doc-utils/xslt/docbook/utils/menusub.xsl 1970-01-01 01:00:00.000000000 +0100
+++ ./xslt/docbook/utils/menusub.xsl 2006-02-22 16:28:23.523863000 +0000
@@ -0,0 +1,63 @@
+<?xml version='1.0' encoding='UTF-8'?><!-- -*- indent-tabs-mode: nil -*- -->
+<!--
+This program is free software; you can redistribute it and/or modify it under
+the terms of the GNU Lesser General Public License as published by the Free
+Software Foundation; either version 2 of the License, or (at your option) any
+later version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with this program; see the file COPYING.LGPL. If not, write to the
+Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
+02111-1307, USA.
+-->
+
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform";
+ version="1.0">
+
+<xsl:output method="xml"/>
+
+<xsl:param name="menu-location">default</xsl:param>
+
+<xsl:template match="*">
+ <xsl:copy>
+ <xsl:copy-of select="@*"/>
+ <xsl:apply-templates/>
+ </xsl:copy>
+</xsl:template>
+
+<xsl:template match="comment()|processing-instruction()">
+ <xsl:copy/>
+</xsl:template>
+
+<xsl:template match="menupath">
+ <term>
+ <guimenu>
+ <xsl:for-each select="document($menu-location)//mainmenu">
+ <xsl:value-of select="item"/>
+ </xsl:for-each>
+ </guimenu>
+ </term>
+ <listitem>
+ <para>Choose
+ <menuchoice>
+ <xsl:for-each select="document($menu-location)//submenu">
+ <guisubmenu>
+ <xsl:value-of select="item"/>
+ </guisubmenu>
+ </xsl:for-each>
+ <guimenuitem>
+ <xsl:for-each select="document($menu-location)//menuitem">
+ <xsl:value-of select="item"/>
+ </xsl:for-each>
+ </guimenuitem>
+ </menuchoice>
+ </para>
+ </listitem>
+</xsl:template>
+
+</xsl:stylesheet>
--- ../gnome-menus/util/test-menu-spec.c 2005-12-08 08:35:39.000000000 +0000
+++ ./util/test-menu-spec.c 2006-02-22 18:04:33.018605000 +0000
@@ -42,12 +42,15 @@
GString *path)
{
GMenuTreeDirectory *parent;
+ static gchar *name;
parent = gmenu_tree_item_get_parent (GMENU_TREE_ITEM (directory));
if (!parent)
{
g_string_append_c (path, '/');
+ g_string_append (path, gmenu_tree_directory_get_name(directory));
+ g_string_append_c (path, '/');
return;
}
@@ -86,8 +89,8 @@
utf8_file_id = g_filename_to_utf8 (gmenu_tree_entry_get_desktop_file_id (entry),
-1, NULL, NULL, NULL);
- g_print ("%s\t%s\t%s%s\n",
- path,
+ g_print ("%s%s\t%s\t%s%s\n",
+ path, gmenu_tree_entry_get_name(entry),
utf8_file_id ? utf8_file_id : _("Invalid desktop file ID"),
utf8_path ? utf8_path : _("[Invalid Filename]"),
gmenu_tree_entry_get_is_excluded (entry) ? _(" <excluded>") : "");
@@ -113,6 +116,7 @@
items = gmenu_tree_directory_get_contents (directory);
tmp = items;
+
while (tmp != NULL)
{
GMenuTreeItem *item = tmp->data;
--- ../gnome-menus/util/get-menu-location 1970-01-01 01:00:00.000000000 +0100
+++ ./util/get-menu-location 2006-02-23 11:08:12.163927000 +0000
@@ -0,0 +1,151 @@
+#! /bin/bash
+# Assumes gnome-menu-spec-test is on your PATH
+# Generates a simply menu location xml file of the format :
+# <menu>
+# <mainmenu>
+# <item>TEXT</item>
+# </mainmenu>
+# <submneu>
+# <item>TEXT</item>
+# </submneu>
+# <menuitem>
+# <item>TEXT</item>
+# </menuitem>
+#</menu>
+#
+# There my be numerous submenu elements depending on how nested the menu is
+#
+# TODO :
+# - Proces XDG_DATA_DIRS if set.......
+
+
+Usage() {
+ echo "Usage : get-menu-location dot_desktop_file [output_file]"
+ echo " : Must Supply dot_desktop_file"
+ echo " : output_file is optional, if not supplied output is to stdout"
+}
+
+HeadToXml() {
+ head -1 $1 | awk ' BEGIN {FS="/"; } \
+ { \
+ print "<menu>"; \
+ print " <mainmenu>"; \
+ print " <item>" $1 "</item>"; \
+ print " </mainmenu>"; \
+ for (i=2; i<NF; i++) { \
+ print " <submenu>"; \
+ print " <item>" $i "</item>"; \
+ print " </submenu>"; \
+ } \
+ print " <menuitem>"; \
+ print " <item>" $NF "</item>"; \
+ print " </menuitem>"; \
+ print "</menu>"; \
+ }' > $2
+}
+
+TestMenuIncluded() {
+ menufile=`basename $1`
+ dir=`dirname $1`
+ grep $menufile $dir/*.menu > /dev/null
+ return $?
+}
+
+
+# Main Processing
+case $# in
+ 1) # Only supplied desktop file name, output goes to stdout
+ dot_desktop_file=$1
+ output_file=/dev/stdout
+ ;;
+ 2) # Supplied both desktop file and file to output to
+ dot_desktop_file=$1
+ output_file=$2
+ ;;
+ *) # Error..
+ Usage
+ exit 1
+ ;;
+esac
+
+# Ensure desktop file exists
+if ! test -f $dot_desktop_file; then
+ echo "$dot_desktop_file : Invalid .desktop file"
+ Usage
+ exit 1
+fi
+
+# Place desktop file into redefined XDG_DATA_DIR path so that it is picked up first.
+export XDG_DATA_DIRS=/tmp
+
+if ! test -d /tmp/applications ; then
+ mkdir /tmp/applications
+fi
+
+cp -f $dot_desktop_file /tmp/applications
+
+desktop_file=`basename $dot_desktop_file`
+
+# Attempt default applications.menu first so run gnome-menu-spec-test without any
+# Paramaters
+gnome-menu-spec-test | grep $desktop_file | awk 'BEGIN {FS=" ";}{print $1}' > /tmp/$$.menu
+
+if [ -s /tmp/$$.menu ]; then
+ # Presuming we found something, make sure we only have one line, use the first occurence
+ HeadToXml /tmp/$$.menu $output_file
+else
+ # Nothing found, so either not on menu or simply not in the default applications menu.
+ # Attempt to process other menu files in $XDG_CONFIG_DIRS/menus/*
+
+ # Check if XDG_CONFIG_DIRS is set, if not set to default of /etc/xdg
+ if ! test "${XDG_CONFIG_DIRS+set}" = "set"; then
+ export XDG_CONFIG_DIRS=/etc/xdg
+ fi
+
+ let xdg_path_process=1
+ orig_IFS=$IFS
+
+ IFS=:
+ set xdg_tmp_path $XDG_CONFIG_DIRS
+ shift
+
+ while [ $xdg_path_process -eq 1 ]; do
+ # Need to process all directories in XDG_COFIG_DIRS
+ for i in $1/menus/*.menu; do
+ if ! test -f $i; then
+ break
+ fi
+
+ # List of menu files to process could be definable somewhere in gnome-menus ?
+ # Already tried applications.menu so skip it.
+
+ # Don't process this menu if included in another menu file, we want to get the
+ # the full path !!
+
+ TestMenuIncluded $i
+ if [ $? == 0 ]; then
+ continue
+ fi
+
+ if ! test "`basename $i`" = "applications.menu"; then
+ # Process this menu
+ gnome-menu-spec-test --file $i | grep $desktop_file | awk 'BEGIN {FS=" ";}{print $1}' > /tmp/$$.menu
+
+ if [ -s /tmp/$$.menu ]; then
+ # Presuming we found something, make sure we only have one line, use the first occurence
+ HeadToXml /tmp/$$.menu $output_file
+ break
+ fi
+ fi
+ done
+
+ shift
+ if ! test "${1+set}" = "set"; then
+ let xdg_path_process=0
+ fi
+ done
+fi
+
+# Clean up tmp stuff
+rm -rf /tmp/applications /tmp/$$.menu
+
--- ../gnome-menus/util/Makefile.am 2005-07-20 16:31:15.000000000 +0100
+++ ./util/Makefile.am 2006-02-23 13:25:00.232624000 +0000
@@ -14,6 +14,8 @@
gnome-menu-spec-test \
$(NULL)
+bin_SCRIPTS = get-menu-location
+
gnome_menu_spec_test_SOURCES = \
test-menu-spec.c \
$(NULL)
--- ../gedit/help/Makefile.am 2006-01-03 01:19:13.000000000 +0000
+++ ./help/Makefile.am 2006-02-23 11:43:48.338507000 +0000
@@ -13,6 +13,7 @@
figures/gedit_window.png
DOC_LINGUAS = de es fr it ja zh_CN zh_HK zh_TW
+DOC_DESKTOP_FILE = ../data/gedit.desktop
# These languages aren't yet converted to gnome-doc-utils
SUBDIRS = eu ko ro sv
--- ../gedit/help/C/legal.xml.in 1970-01-01 01:00:00.000000000 +0100
+++ ./help/C/legal.xml.in 2006-02-23 11:43:20.551298000 +0000
@@ -0,0 +1,73 @@
+ <legalnotice id="legalnotice">
+ <para>
+ Permission is granted to copy, distribute and/or modify this
+ document under the terms of the GNU Free Documentation
+ License (GFDL), Version 1.1 or any later version published
+ by the Free Software Foundation with no Invariant Sections,
+ no Front-Cover Texts, and no Back-Cover Texts. You can find
+ a copy of the GFDL at this <ulink type="help"
+ url="ghelp:fdl">link</ulink> or in the file COPYING-DOCS
+ distributed with this manual.
+ </para>
+ <para> This manual is part of a collection of GNOME manuals
+ distributed under the GFDL. If you want to distribute this
+ manual separately from the collection, you can do so by
+ adding a copy of the license to the manual, as described in
+ section 6 of the license.
+ </para>
+
+ <para>
+ Many of the names used by companies to distinguish their
+ products and services are claimed as trademarks. Where those
+ names appear in any GNOME documentation, and the members of
+ the GNOME Documentation Project are made aware of those
+ trademarks, then the names are in capital letters or initial
+ capital letters.
+ </para>
+
+ <para>
+ DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT ARE PROVIDED
+ UNDER THE TERMS OF THE GNU FREE DOCUMENTATION LICENSE
+ WITH THE FURTHER UNDERSTANDING THAT:
+
+ <orderedlist>
+ <listitem>
+ <para>DOCUMENT IS PROVIDED ON AN "AS IS" BASIS,
+ WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR
+ IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES
+ THAT THE DOCUMENT OR MODIFIED VERSION OF THE
+ DOCUMENT IS FREE OF DEFECTS MERCHANTABLE, FIT FOR
+ A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE
+ RISK AS TO THE QUALITY, ACCURACY, AND PERFORMANCE
+ OF THE DOCUMENT OR MODIFIED VERSION OF THE
+ DOCUMENT IS WITH YOU. SHOULD ANY DOCUMENT OR
+ MODIFIED VERSION PROVE DEFECTIVE IN ANY RESPECT,
+ YOU (NOT THE INITIAL WRITER, AUTHOR OR ANY
+ CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY
+ SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER
+ OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS
+ LICENSE. NO USE OF ANY DOCUMENT OR MODIFIED
+ VERSION OF THE DOCUMENT IS AUTHORIZED HEREUNDER
+ EXCEPT UNDER THIS DISCLAIMER; AND
+ UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL
+ THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE),
+ CONTRACT, OR OTHERWISE, SHALL THE AUTHOR,
+ INITIAL WRITER, ANY CONTRIBUTOR, OR ANY
+ DISTRIBUTOR OF THE DOCUMENT OR MODIFIED VERSION
+ OF THE DOCUMENT, OR ANY SUPPLIER OF ANY OF SUCH
+ PARTIES, BE LIABLE TO ANY PERSON FOR ANY
+ DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR
+ CONSEQUENTIAL DAMAGES OF ANY CHARACTER
+ INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS
+ OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR
+ MALFUNCTION, OR ANY AND ALL OTHER DAMAGES OR
+ LOSSES ARISING OUT OF OR RELATING TO USE OF THE
+ DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT,
+ EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF
+ THE POSSIBILITY OF SUCH DAMAGES.
+ </para>
+ </listitem>
+ </orderedlist>
+ </para>
+ </legalnotice>
+
--- ../gedit/help/C/gedit.xml.in 1970-01-01 01:00:00.000000000 +0100
+++ ./help/C/gedit.xml.in 2006-02-23 13:31:20.391127000 +0000
@@ -0,0 +1,1579 @@
+<?xml version="1.0"?>
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"; [
+ <!ENTITY appversion "2.7.91">
+ <!ENTITY manrevision "2.8">
+ <!ENTITY date "August 2004">
+ <!ENTITY app "gedit">
+]>
+<!--
+ (Do not remove this comment block.)
+ Maintained by the GNOME Documentation Project
+ http://developer.GNOME.org/projects/gdp
+ Template version: 2.0 beta
+ Template last modified Jan 30, 2002
+
+-->
+<!-- =============Document Header ============================= -->
+<article id="index" lang="en">
+<!-- please do not change the id; for translations, change lang to -->
+<!-- appropriate code -->
+ <articleinfo>
+ <title>&app; Manual V&manrevision;</title>
+ <copyright>
+ <year>2002</year>
+ <year>2003</year>
+ <year>2004</year>
+ <holder>Sun Microsystems</holder> </copyright>
+ <copyright>
+ <year>2000</year>
+ <holder>Eric Baudais</holder> </copyright>
+
+<!-- translators: uncomment this:
+
+ <copyright>
+ <year>2003</year>
+ <holder>ME-THE-TRANSLATOR (Latin translation)</holder>
+ </copyright>
+
+ -->
+ <publisher>
+ <publishername>GNOME Documentation Project</publishername>
+ </publisher>
+
+ <xi:include href="legal.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+
+ <authorgroup>
+ <author role="maintainer">
+ <firstname>Sun Java Desktop System Documentation Team</firstname>
+ <surname></surname>
+ <affiliation>
+ <orgname>Sun Microsystems</orgname>
+ <address><email>gdocteam sun com</email></address>
+ </affiliation>
+ </author>
+ <author>
+ <firstname>Eric</firstname>
+ <surname>Baudais</surname>
+ <affiliation>
+ <orgname>GNOME Documentation Project</orgname>
+ <address> <email>baudais okstate edu</email> </address>
+ </affiliation>
+ </author>
+ <othercredit role="reviewer">
+ <firstname>Baris</firstname>
+ <surname>Cicek provided information from earlier revisions of the gedit application.</surname>
+ <contrib>Acknowledgements</contrib>
+ </othercredit>
+ <othercredit role="reviewer">
+ <firstname>Ajit</firstname>
+ <surname>George provided information about plugins.</surname>
+ <contrib>Acknowledgements</contrib>
+ </othercredit>
+
+
+<!-- This is appropriate place for other contributors: translators,
+ maintainers, etc. Commented out by default.
+ <othercredit role="translator">
+ <firstname>Latin</firstname>
+ <surname>Translator 1</surname>
+ <affiliation>
+ <orgname>Latin Translation Team</orgname>
+ <address> <email>translator gnome org</email> </address>
+ </affiliation>
+ <contrib>Latin translation</contrib>
+ </othercredit>
+-->
+ </authorgroup>
+
+<!-- According to GNU FDL, revision history is mandatory if you are -->
+<!-- modifying/reusing someone else's document. If not, you can omit it. -->
+ <revhistory>
+<!-- Remember to remove the &manrevision; entity from the revision entries other
+ than the current revision. -->
+ <revision>
+ <revnumber>gedit V1.0</revnumber>
+ <date>2000</date>
+ <revdescription>
+ <para role="author">Eric Baudais <email>baudais okstate edu</email>
+ </para>
+ <para role="publisher">GNOME Documentation Project</para>
+ </revdescription>
+ </revision>
+ <revision>
+ <revnumber>gedit Manual V2.0</revnumber>
+ <date>March 2002</date>
+ <revdescription>
+ <para role="author">Sun GNOME Documentation Team</para>
+ <para role="publisher">GNOME Documentation Project</para>
+ </revdescription>
+ </revision>
+ <revision>
+ <revnumber>gedit Manual V2.1</revnumber>
+ <date>June 2002</date>
+ <revdescription>
+ <para role="author">Sun GNOME Documentation Team</para>
+ <para role="publisher">GNOME Documentation Project</para>
+ </revdescription>
+ </revision>
+ <revision>
+ <revnumber>gedit Manual V2.2</revnumber>
+ <date>August 2002</date>
+ <revdescription>
+ <para role="author">Sun GNOME Documentation Team</para>
+ <para role="publisher">GNOME Documentation Project</para>
+ </revdescription>
+ </revision>
+ <revision>
+ <revnumber>gedit Manual V2.3</revnumber>
+ <date>September 2002</date>
+ <revdescription>
+ <para role="author">Sun GNOME Documentation Team</para>
+ <para role="publisher">GNOME Documentation Project</para>
+ </revdescription>
+ </revision>
+ <revision>
+ <revnumber>gedit Manual V2.4</revnumber>
+ <date>January 2003</date>
+ <revdescription>
+ <para role="author">Sun GNOME Documentation Team</para>
+ <para role="publisher">GNOME Documentation Project</para>
+ </revdescription>
+ </revision>
+ <revision>
+ <revnumber>gedit Manual V2.5</revnumber>
+ <date>March 2003</date>
+ <revdescription>
+ <para role="author">Sun GNOME Documentation Team</para>
+ <para role="publisher">GNOME Documentation Project</para>
+ </revdescription>
+ </revision>
+ <revision>
+ <revnumber>gedit Manual V2.6</revnumber>
+ <date>September 2003</date>
+ <revdescription>
+ <para role="author">Sun GNOME Documentation Team</para>
+ <para role="publisher">GNOME Documentation Project</para>
+ </revdescription>
+ </revision>
+ <revision>
+ <revnumber>gedit Manual V2.7</revnumber>
+ <date>March 2004</date>
+ <revdescription>
+ <para role="author">Sun GNOME Documentation Team</para>
+ <para role="publisher">GNOME Documentation Project</para>
+ </revdescription>
+ </revision>
+ <revision>
+ <revnumber>&app; Manual V&manrevision;</revnumber>
+ <date>&date;</date>
+ <revdescription>
+ <para role="author">Sun Java Desktop System Documentation Team</para>
+ <para role="publisher">GNOME Documentation Project</para>
+ </revdescription>
+ </revision>
+ </revhistory>
+ <releaseinfo> This manual describes version &appversion; of &app;.
+ </releaseinfo>
+ <legalnotice>
+ <title>Feedback</title>
+ <para>To report a bug or make a suggestion regarding the <application>&app;</application> application or this manual, follow the directions in the <ulink url="ghelp:gnome-feedback" type="help">GNOME Feedback Page</ulink>.
+ </para>
+<!-- Translators may also add here feedback address for translations -->
+ </legalnotice>
+ <abstract role="description">
+ <para>User manual for the gedit text editor.</para>
+ </abstract>
+ </articleinfo>
+ <indexterm><primary>gedit</primary></indexterm>
+ <indexterm><primary>text editor</primary></indexterm>
+
+<!-- ============= Document Body ============================= -->
+<!-- ============= Introduction ============================== -->
+ <sect1 id="gedit-intro">
+ <title>Introduction</title>
+ <para>The <application>&app;</application> application enables you to create and edit text files. You can use <application>&app;</application> plugins to perform a variety of tasks related to text-editing from within the <application>&app;</application> window.</para>
+ </sect1>
+<!-- ============= Getting Started =========================== -->
+ <sect1 id="gedit-getting-started">
+ <title>Getting Started</title>
+
+<!-- ============= To Start gedit ============================ -->
+ <sect2 id="gedit-to-start">
+ <title>To Start &app;</title>
+ <para>You can start <application>&app;</application> in the following ways:</para>
+ <variablelist>
+ <varlistentry>
+ <menupath/>
+ </varlistentry>
+ <varlistentry>
+ <term>Command line</term>
+ <listitem>
+ <para>Execute the following command: <command>gedit</command></para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect2>
+
+ <sect2 id="gedit-when-you-start">
+
+ <title>When You Start &app;</title>
+ <para>When you start <application>&app;</application>, the following window is displayed:</para>
+
+ <figure id="gedit-window">
+ <title>&app; Window</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/gedit_window.png" format="PNG"/>
+ </imageobject>
+ <textobject> <phrase>Shows gedit main window.</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ </figure>
+
+ <para>The <application>&app;</application> window contains the following
+ elements: </para>
+ <variablelist>
+ <varlistentry> <term>Menubar</term>
+ <listitem>
+ <para>The menus on the menubar contain all of the commands you need to work with files in <application>&app;</application>.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry> <term>Toolbar</term>
+ <listitem>
+ <para> The toolbar contains a subset of the commands that you can access from the menubar.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry> <term>Display area</term>
+ <listitem>
+ <para> The display area contains the text of the file that you are editing. </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry> <term>Output window</term>
+ <listitem>
+ <para>The output window displays the output returned by the Shell command plugin. </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry> <term>Statusbar</term>
+ <listitem>
+ <para>The statusbar displays information about current <application>&app;</application> activity and contextual information about the menu items. The statusbar also displays the following information:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Cursor position: the line number and column number where the cursor is located.</para>
+ </listitem>
+ <listitem>
+ <para>Edit mode: If the editor is in insert mode, the statusbar contains the text <guilabel>INS</guilabel>. If the editor is in overwrite mode, the statusbar contains the text <guilabel>OVR</guilabel>. Press the <keycap>Insert</keycap> key to change edit mode.</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <para>When you right-click in the <application>&app;</application> window, the application displays a popup menu. The popup menu contains the most common text editing commands. </para>
+
+ <para>
+ In <application>&app;</application>, you can perform the same action in several ways. For example, you can open a file in the following ways:
+ <informaltable frame="all">
+ <tgroup cols="2" colsep="1" rowsep="1">
+ <colspec colname="COLSPEC0" colwidth="50*"/>
+ <colspec colname="COLSPEC1" colwidth="50*"/>
+ <thead>
+ <row valign="top">
+ <entry colname="COLSPEC0">
+ <para>UI Component</para></entry>
+ <entry colname="COLSPEC1" align="left">
+ <para>Action</para></entry>
+ </row>
+ </thead>
+ <tbody>
+ <row valign="top">
+ <entry><para>Window</para></entry>
+ <entry><para>Drag a file into the <application>&app;</application> window from another application such as a file manager.</para></entry>
+ </row>
+ <row valign="top">
+ <entry><para>Menubar</para></entry>
+ <entry><para>Choose <menuchoice><guimenu>File</guimenu><guimenuitem>Open</guimenuitem></menuchoice>.</para>
+ <para>If you have recently opened the file, choose <menuchoice><guimenu>File</guimenu><guimenuitem>Open Recent</guimenuitem></menuchoice>.</para>
+</entry>
+ </row>
+ <row valign="top">
+ <entry><para>Toolbar</para></entry>
+ <entry><para>Click on the <guibutton>Open</guibutton> toolbar button.</para></entry>
+ </row>
+ <row valign="top">
+ <entry><para>Right-click popup menu</para></entry>
+ <entry><para>Right-click on the file in a file manager window, then choose <guilabel>Open With</guilabel> from the popup menu. </para></entry>
+ </row>
+ <row valign="top">
+ <entry><para>Shortcut keys</para></entry>
+ <entry><para>Press <keycombo><keycap>Ctrl</keycap><keycap>O</keycap></keycombo>.</para></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+ <para>
+ This manual documents functionality from the menubar.
+ </para>
+ </sect2>
+<!-- ============= To Open a File ============================= -->
+ <sect2 id="gedit-open-file">
+ <title>To Open a File</title>
+ <para>To open a file, choose <menuchoice><guimenu>File</guimenu><guimenuitem>Open</guimenuitem></menuchoice> to display the <guilabel>Open File</guilabel> dialog. Select the file that you want to open, then click <guibutton>Open</guibutton>. The file is displayed in the <application>&app;</application> window. </para>
+ <para>You can open multiple files in <application>&app;</application>. The application displays one file at a time in the application window. The application adds a tab for each open file to the window. To display another open file, click on the tab that corresponds to the file. To create a new <application> &app;</application> window for each file that is open, drag the tab corresponding to each file to the desktop background. </para>
+ <para>You can also use the <guimenu>Documents</guimenu> menu to move between the open files. You can choose <menuchoice> <guimenu>Documents</guimenu> <guimenuitem>Move to New Window</guimenuitem> </menuchoice> to move a document to a new <application> &app;</application> window.
+</para>
+ <para>The application records the paths and filenames of the five most recent files that you edited and displays the files as menu items on the <menuchoice><guimenu>File</guimenu></menuchoice> menu. You can also click on the <inlinemediaobject><imageobject><imagedata fileref="figures/gedit_recent_files_menu_icon.png" format="PNG"/></imageobject><textobject><phrase>Shows Recent Files menu icon.</phrase></textobject></inlinemediaobject> icon on the toolbar to display the list of recent files. </para>
+ </sect2>
+<!-- ============= To Open Multiple Files from the Command Line ========= -->
+ <sect2 id="gedit-run-from-cmd-line">
+ <title>To Open Multiple Files from a Command Line</title>
+ <para>You can run <application>&app;</application> from a command line and open a single file or multiple files. To open multiple files from a command line, type the following command, then press <keycap>Return</keycap>:</para>
+ <para><command>gedit <replaceable>file1.txt file2.txt file3.txt</replaceable></command></para>
+ <para>When the application starts, the files that you specify are displayed in the <application>&app;</application> window.</para>
+ <para>For more information on how to run <application>&app;</application> from a command line, see <ulink url="man:gedit" type="man"><citerefentry><refentrytitle>&app;</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink>.</para>
+ </sect2>
+ </sect1>
+<!-- ================ Usage ================================ -->
+ <sect1 id="gedit-usage">
+ <title>Usage</title>
+
+<!-- ============= To Create a New File ======================== -->
+ <sect2 id="gedit-create-new-file">
+ <title>To Create a New File</title>
+ <para>To create a new file, choose <menuchoice><guimenu>File</guimenu><guimenuitem>New</guimenuitem></menuchoice>. The application displays a new file in the <application>&app;</application> window.</para>
+ </sect2>
+<!-- ============= To Save a File ============================== -->
+ <sect2 id="gedit-save-file">
+ <title>To Save a File</title>
+ <para>You can save files in the following ways:</para>
+ <itemizedlist>
+ <listitem><para>To save changes to an existing file, choose <menuchoice><guimenu>File</guimenu><guimenuitem>Save</guimenuitem></menuchoice>. </para>
+ </listitem>
+ <listitem><para>To save a new file or to save an existing file under a new filename, choose <menuchoice> <guimenu>File</guimenu> <guimenuitem>Save As</guimenuitem> </menuchoice>. Enter a name for the file in the <guilabel>Save As</guilabel> dialog, then click <guibutton>Save</guibutton>. </para>
+ </listitem>
+ <listitem><para>To save all of the files that are currently open in <application>&app;</application>, choose <menuchoice> <guimenu>Documents</guimenu> <guimenuitem>Save All</guimenuitem> </menuchoice>.</para>
+ </listitem>
+ </itemizedlist>
+ <para>To close all of the files that are currently open in <application>&app;</application>, choose <menuchoice> <guimenu>Documents</guimenu> <guimenuitem>Close All</guimenuitem> </menuchoice>.</para>
+ </sect2>
+<!-- ============= To Edit Text ================================ -->
+ <sect2 id="gedit-edit-text">
+ <title>To Edit Text</title>
+ <para>You can edit the text of a file in the following ways:</para>
+ <itemizedlist>
+ <listitem><para>Type new text from the keyboard. </para>
+ </listitem>
+ <listitem><para>To copy the selected text to a buffer, choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Copy</guimenuitem> </menuchoice>.</para>
+ </listitem>
+ <listitem><para>To delete the selected text from the file and move the selected text to a buffer, choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Cut</guimenuitem> </menuchoice>.</para>
+ </listitem>
+ <listitem><para>To permanently delete the selected text from the file, choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Delete</guimenuitem> </menuchoice>.</para>
+ </listitem>
+ <listitem><para>To insert the contents of the buffer at the cursor position, choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Paste</guimenuitem> </menuchoice>. You must cut or copy text before you can paste text into the file.</para>
+ </listitem>
+ <listitem><para>To select all of the text in a file, choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Select All</guimenuitem> </menuchoice>. </para>
+ </listitem>
+ </itemizedlist>
+ </sect2>
+<!-- ============== To Undo or Redo Edits ====================== -->
+ <sect2 id="gedit-undo-redo-edits">
+ <title>To Undo or Redo Edits</title>
+ <para>To undo an edit, choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Undo</guimenuitem> </menuchoice>. To redo an edit, choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Redo</guimenuitem> </menuchoice>. The number of previous edits that you can undo is determined by the <guilabel>Undo</guilabel> limit setting in the <xref linkend="gedit-prefs-editor"/> tabbed section of the <guilabel>Preferences</guilabel> dialog. </para>
+ </sect2>
+<!-- ============= To Find Text ================================ -->
+ <sect2 id="gedit-find-text">
+ <title>To Find Text</title>
+ <para>To search a file for a string, perform the following steps:</para>
+ <orderedlist>
+ <listitem><para>Choose <menuchoice> <guimenu>Search</guimenu> <guimenuitem>Find</guimenuitem> </menuchoice> to display the <guilabel>Find</guilabel> dialog.</para>
+ </listitem>
+ <listitem><para>Type the string that you want to find, in the <guilabel>Search for</guilabel> field.</para>
+ <para>You can include the following escape sequences:</para>
+ <itemizedlist>
+ <listitem>
+ <para><literal>\n</literal></para>
+ <para>Use this escape sequence to specify a new line.</para>
+ </listitem>
+ <listitem>
+ <para><literal>\t</literal></para>
+ <para>Use this escape sequence to specify a tab character.</para>
+ </listitem>
+ <listitem>
+ <para><literal>\r</literal></para>
+ <para>Use this escape sequence to specify a carriage return.</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem><para>Select the <guilabel>Match case</guilabel> option to only find occurrences of the string that match the case of the text that you type. </para>
+ </listitem>
+ <listitem><para>Select the <guilabel>Match entire word only</guilabel> option to only find occurrences of the string that match the entire words of the text that you type. </para>
+ </listitem>
+ <listitem><para>Select the <guilabel>Search backwards</guilabel> option to search backwards to the beginning of the file. </para>
+ </listitem>
+ <listitem><para>Select the <guilabel>Wrap around</guilabel> option to search to one end of the file and then continue the search from the other end of the file. </para>
+ </listitem>
+ <listitem><para>Click <guibutton>Find</guibutton> to search the file for the first occurrence of the string. If <application>&app;</application> finds the string, the application moves the cursor to the string, and selects the string.</para>
+ </listitem>
+ <listitem><para>To find the next occurrence of the string, click <guibutton>Find</guibutton> or choose <menuchoice> <guimenu>Search</guimenu> <guimenuitem>Find Next</guimenuitem> </menuchoice>. To find the previous occurrence of the string, choose <menuchoice> <guimenu>Search</guimenu> <guimenuitem>Find Previous</guimenuitem> </menuchoice>.</para>
+ </listitem>
+ <listitem><para>To finish the search, click <guibutton>Close</guibutton>. </para>
+ </listitem>
+ </orderedlist>
+ </sect2>
+<!-- ============= To Find and Replace Text =================== -->
+ <sect2 id="gedit-find-replace-text">
+ <title>To Find and Replace Text</title>
+ <para>To search a file for a string, and replace the string with an alternative string, perform the following steps:</para>
+ <orderedlist>
+ <listitem><para>Choose <menuchoice> <guimenu>Search</guimenu> <guimenuitem>Replace</guimenuitem> </menuchoice> to display the <guilabel>Replace</guilabel> dialog.</para>
+ </listitem>
+ <listitem><para>Type the string that you want to find, in the <guilabel>Search for</guilabel> field. </para>
+ <para>You can include the following escape sequences:</para>
+ <itemizedlist>
+ <listitem>
+ <para><literal>\n</literal></para>
+ <para>Use this escape sequence to specify a new line.</para>
+ </listitem>
+ <listitem>
+ <para><literal>\t</literal></para>
+ <para>Use this escape sequence to specify a tab character.</para>
+ </listitem>
+ <listitem>
+ <para><literal>\r</literal></para>
+ <para>Use this escape sequence to specify a carriage return.</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem><para>Type the string that you want to use to replace the string that you find, in the <guilabel>Replace with</guilabel> field.</para>
+ </listitem>
+ <listitem><para>Select the <guilabel>Match case</guilabel> option to only find occurrences of the string that match the case of the text that you enter. </para>
+ </listitem>
+ <listitem><para>Select the <guilabel>Match entire word only</guilabel> option to only find occurrences of the string that match the entire words of the text that you type. </para>
+ </listitem>
+ <listitem><para>Select the <guilabel>Search backwards</guilabel> option to search backwards to the beginning of the file. </para>
+ </listitem>
+ <listitem><para>Select the <guilabel>Wrap around</guilabel> option to search to one end of the file and then continue the search from the other end of the file. </para>
+ </listitem>
+ <listitem><para>Click <guibutton>Find</guibutton> to search the file for the first occurrence of the string. If <application>&app;</application> finds the string, the application moves the cursor to the string, and selects the string. </para>
+ </listitem>
+ <listitem><para>Click <guibutton>Replace</guibutton> to replace the occurrence of the string with the text in the <guilabel>Replace with</guilabel> field. Click <guibutton>Replace All</guibutton> to replace all occurrences of the string.</para>
+ </listitem>
+ <listitem><para>To find the next occurrence of the string, click <guibutton>Find</guibutton>.</para>
+ </listitem>
+ <listitem><para>To finish the search, click <guibutton>Close</guibutton>. </para>
+ </listitem>
+ </orderedlist>
+ </sect2>
+<!-- ============= To Open a File from a URI ======================= -->
+ <sect2 id="gedit-open-from-uri">
+ <title>To Open a File from a URI</title>
+ <para>To open a file from a Uniform Resource Identifier (URI), perform the following steps:</para>
+ <orderedlist>
+ <listitem>
+ <para>Choose <menuchoice> <guimenu>File</guimenu> <guimenuitem>Open Location</guimenuitem> </menuchoice> to display the <guilabel>Open Location</guilabel> dialog. </para>
+ </listitem>
+ <listitem>
+ <para>Enter the URI of the file that you want to open.</para>
+ </listitem>
+ <listitem>
+ <para>Use the <guilabel>Character coding</guilabel> drop-down list to select the appropriate character coding. </para>
+ </listitem>
+ <listitem>
+ <para>Click <guibutton>Open</guibutton>.</para>
+ </listitem>
+ </orderedlist>
+ <para>Alternatively, type <command>gedit <replaceable>URI</replaceable></command> at a command line, where <replaceable>URI</replaceable> is the URI of the file that you want to open, then press <keycap>Return</keycap>. Valid types of <replaceable>URI</replaceable> include <literal>http:</literal>, <literal>ftp:</literal>, <literal>file:</literal>, and all of the methods supported by <literal>gnome-vfs</literal>.</para>
+ <para>The application opens the file located at the URI in read-only mode.</para>
+ </sect2>
+<!-- ============= To Pipe the Output of a Command to a File ======= -->
+ <sect2 id="gedit-pipe-output">
+ <title>To Pipe the Output of a Command to a File</title>
+ <para>You can use <application>&app;</application> to pipe the output of a command to a text file. For example, to pipe the output of an <command>ls</command> command to a text file, type <command>ls | gedit</command>, then press <keycap>Return</keycap>.</para>
+ <para>The output of the <command>ls</command> command is displayed in a new text file in the <application>&app;</application> window.</para>
+ <para>Alternatively, you can use the Shell command plugin to pipe command output to the current file. For information about how to use the Shell command plugin, see <xref linkend="gedit-shell-command-plugin"/>.</para>
+ </sect2>
+<!-- ============= To Position the Cursor on a Specific Line ======================= -->
+ <sect2 id="gedit-goto-line">
+ <title>To Position the Cursor on a Specific Line</title>
+ <para>To position the cursor on a specific line in the current file, perform the following steps:</para>
+ <orderedlist>
+ <listitem><para>Choose <menuchoice> <guimenu>Search</guimenu> <guimenuitem>Go to Line</guimenuitem> </menuchoice> to display the <guilabel>Go to Line</guilabel> dialog.</para>
+ </listitem>
+ <listitem><para>Type the number of the line that you want to move the cursor to in the <guilabel>Line number</guilabel> field.</para>
+ </listitem>
+ <listitem><para>Click <guibutton>Go to Line</guibutton>. The application moves the cursor to the line number that you specify.</para>
+ </listitem>
+ <listitem><para>To close the <guilabel>Go to Line</guilabel> dialog, click <guibutton>Close</guibutton>.</para>
+ </listitem>
+ </orderedlist>
+ </sect2>
+<!-- ============= To Set the Page Options ============================ -->
+ <sect2 id="gedit-page-setup">
+ <title>To Set the Page Options</title>
+
+ <para>To set the page options, choose <menuchoice> <guimenu>File</guimenu> <guimenuitem>Page Setup</guimenuitem> </menuchoice> to display the <guilabel>Page Setup</guilabel> dialog.</para>
+
+ <para>The <guilabel>Page Setup</guilabel> dialog enables you to specify the following print options:</para>
+
+ <sect3 id="gedit-page-setup-general">
+ <title>General Tabbed Section</title>
+ <variablelist>
+ <varlistentry> <term><guilabel>Print syntax highlighting</guilabel> </term>
+ <listitem>
+ <para>Select this option to print syntax highlighting. For more information about syntax highlighting, see <xref linkend="gedit-set-highlightmode"/>. </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry> <term><guilabel>Print page headers</guilabel> </term>
+ <listitem>
+ <para>Select this option to include a header on each page that you print. You cannot configure the header. </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry> <term><guilabel>Line Numbers</guilabel>
+ </term>
+ <listitem>
+ <para>Select the <guilabel>Print line numbers</guilabel> option to include line numbers when you print a file. </para>
+ <para>Use the <guilabel>Number every ... lines </guilabel> spin box to specify how often to print the line numbers, for example every 5 lines, every 10 lines, and so on. </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry> <term><guilabel>Text Wrapping</guilabel> </term>
+ <listitem>
+ <para>Select the <guilabel>Enable text wrapping</guilabel> option to wrap text onto the next line, at a character level, when you print a file. The application counts wrapped lines as one line for line numbering purposes.
+ </para>
+ <para>Select the <guilabel>Do not split words over two lines</guilabel> option to wrap text onto the next line, at a word level, when you print a file.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect3>
+
+ <sect3 id="gedit-page-setup-fonts">
+ <title>Fonts</title>
+ <variablelist>
+ <varlistentry> <term><guilabel>Body</guilabel> </term>
+ <listitem>
+ <para>Click on this button to select the font to use to print the body text of a file.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry> <term><guilabel>Line numbers</guilabel>
+ </term>
+ <listitem>
+ <para>Click on this button to select the font to use to print line numbers.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry> <term><guilabel>Headers and footers</guilabel> </term>
+ <listitem>
+ <para>Click on this button to select the font to use to print the headers and footers in a file. </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <para>To reset the fonts to the default fonts for printing a file from <application>&app;</application>, click <guibutton>Restore Default Fonts</guibutton>.</para>
+ </sect3>
+
+ </sect2>
+
+<!-- ============= To Print a File ============================ -->
+ <sect2 id="gedit-print-file">
+ <title>To Print a File</title>
+ <para>You can use <application>&app;</application> to perform the following print operations:</para>
+ <itemizedlist>
+ <listitem><para>Print a file to a printer. </para>
+ </listitem>
+ <listitem><para>Print the output of the print command to a file.</para>
+ </listitem>
+ </itemizedlist>
+ <para>If you print to a file, <application>&app;</application> sends the output of the file to a pre-press format file. The most common pre-press formats are PostScript and Portable Document Format (PDF).</para>
+
+ <para>To preview the pages that you want to print, choose <menuchoice> <guimenu>File</guimenu> <guimenuitem>Print Preview</guimenuitem> </menuchoice>.</para>
+
+ <para>To print the current file to a printer or a file, choose <menuchoice> <guimenu>File</guimenu> <guimenuitem>Print</guimenuitem> </menuchoice> to display the <guilabel>Print</guilabel> dialog.</para>
+
+ <para>The <guilabel>Print</guilabel> dialog enables you to specify the following print options:</para>
+
+ <sect3 id="print-dialog-job">
+ <title>Job Tabbed Section</title>
+ <variablelist>
+ <varlistentry> <term><guilabel>Print range</guilabel> </term>
+ <listitem>
+ <para>Select one of the following options to determine how many pages to print:</para>
+ <itemizedlist>
+ <listitem>
+ <para><guilabel>All</guilabel></para>
+ <para>Select this option to print all of the pages in the file.</para>
+ </listitem>
+ <listitem>
+ <para><guilabel>Lines</guilabel></para>
+ <para>Select this option to print the specified lines only. Use the <guilabel>From</guilabel> and <guilabel>To</guilabel> spin boxes to specify the line range.</para>
+ </listitem>
+ <listitem>
+ <para><guilabel>Selection</guilabel></para>
+ <para>Select this option to print the selected text only. This option is only available if you select text.</para>
+ </listitem>
+
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+ <varlistentry> <term><guilabel>Copies</guilabel> </term>
+ <listitem>
+ <para>Use the <guilabel>Number of copies</guilabel> spin box to specify the number of copies of the file that you want to print.</para>
+ <para>If you print multiple copies of the file, select the <guilabel>Collate</guilabel> option to collate the printed copies.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect3>
+
+ <sect3 id="print-dialog-printer">
+ <title>Printer Tabbed Section</title>
+ <variablelist>
+ <varlistentry> <term><guilabel>Printer</guilabel> </term>
+ <listitem>
+ <para>Use this drop-down list to select the printer to which you want to print the file.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry> <term><guilabel>Settings</guilabel> </term>
+ <listitem>
+ <para>Use this drop-down list to select the printer settings.
+ </para>
+ <para>To configure the printer, click <guibutton>Configure</guibutton>. For example, you can enable or disable duplex printing, or schedule delayed printing, if this functionality is supported by the printer.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry> <term><guilabel>Location</guilabel> </term>
+ <listitem>
+ <para>
+ Use this drop-down list to select one of the following print destinations:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><guilabel>CUPS</guilabel></term>
+ <listitem>
+ <para>
+ Print the file to a CUPS printer.
+ </para>
+ <note>
+ <para>
+ If the selected printer is a CUPS printer, <guilabel>CUPS</guilabel> is the only entry in this drop-down list.
+ </para>
+ </note>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guilabel>lpr</guilabel></term>
+ <listitem>
+ <para>
+ Print the file to a printer.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guilabel>File</guilabel></term>
+ <listitem>
+ <para>
+ Print the file to a PostScript file.
+ </para>
+ <para>
+ Click <guibutton>Save As</guibutton> to display a dialog where you specify the name and location of the PostScript file.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guilabel>Custom</guilabel></term>
+ <listitem>
+ <para>
+ Use the specified command to print the file.
+ </para>
+ <para>
+ Type the name of the command in the text box. Include all command-line arguments.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry> <term><guilabel>State</guilabel> </term>
+ <listitem>
+ <para>This functionality is not supported in this version of &app;.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry> <term><guilabel>Type</guilabel> </term>
+ <listitem>
+ <para>This functionality is not supported in this version of &app;.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry> <term><guilabel>Comment</guilabel> </term>
+ <listitem>
+ <para>This functionality is not supported in this version of &app;.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect3>
+
+ <sect3 id="print-dialog-paper">
+ <title>Paper Tabbed Section</title>
+ <variablelist>
+ <varlistentry> <term><guilabel>Paper size</guilabel> </term>
+ <listitem>
+ <para>Use this drop-down list to select the size of the paper to which you want to print the file.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry> <term><guilabel>Width</guilabel> </term>
+ <listitem>
+ <para>Use this spin box to specify the width of the paper. Use the adjacent drop-down list to change the measurement unit.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry> <term><guilabel>Height</guilabel> </term>
+ <listitem>
+ <para>Use this spin box to specify the height of the paper.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry> <term><guilabel>Feed orientation</guilabel> </term>
+ <listitem>
+ <para>Use this drop-down list to select the orientation of the paper in the printer.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry> <term><guilabel>Page orientation</guilabel> </term>
+ <listitem>
+ <para>Use this drop-down list to select the page orientation.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry> <term><guilabel>Layout</guilabel> </term>
+ <listitem>
+ <para>Use this drop-down list to select the page layout. A preview of each layout that you select is displayed in the <guilabel>Preview</guilabel> area.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry> <term><guilabel>Paper tray</guilabel> </term>
+ <listitem>
+ <para>Use this drop-down list to select the paper tray.
+ </para> </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect3>
+
+ </sect2>
+
+ <sect2 id="gedit-customize-toolbar">
+ <title>To Customize the Toolbar</title>
+ <para>To display or hide the toolbar, choose <menuchoice> <guimenu>View</guimenu> <guimenuitem>Toolbar</guimenuitem> </menuchoice>. To customize how <application>&app;</application> displays the toolbar, choose <menuchoice> <guimenu>View</guimenu> <guisubmenu>Customize Toolbar</guisubmenu> </menuchoice>, then select one of the following menu items:</para>
+ <itemizedlist>
+ <listitem>
+ <para><guimenuitem>Desktop Default</guimenuitem></para>
+ <para>Display the default toolbar.</para>
+ </listitem>
+ <listitem>
+ <para><guimenuitem>Icons Only</guimenuitem></para>
+ <para>Display icons only.</para>
+ </listitem>
+ <listitem>
+ <para><guimenuitem>Text for All Icons</guimenuitem></para>
+ <para>Display icons, and display text for all icons.</para>
+ </listitem>
+ <listitem>
+ <para><guimenuitem>Text for Important Icons</guimenuitem></para>
+ <para>Display icons, and display text for the important icons.</para>
+ </listitem>
+ </itemizedlist>
+ <para>To display or hide the output window, choose <menuchoice> <guimenu>View</guimenu> <guimenuitem>Output Window</guimenuitem> </menuchoice>.</para>
+
+ </sect2>
+
+ <sect2 id="gedit-set-highlightmode">
+ <title>To Set the Syntax Highlighting Mode</title>
+ <para>To set the syntax highlighting mode, choose <menuchoice> <guimenu>View</guimenu> <guimenuitem>Highlight Mode</guimenuitem> </menuchoice>, then select one of the following menu items:</para>
+ <variablelist>
+ <varlistentry>
+ <term><guimenuitem>Normal</guimenuitem></term>
+ <listitem>
+ <para>Do not display any syntax highlighting.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guisubmenu>Sources</guisubmenu></term>
+ <listitem>
+ <para>Display syntax highlighting to edit source code. Use the <guisubmenu>Sources</guisubmenu> submenu to select the source code type.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guisubmenu>Markup</guisubmenu></term>
+ <listitem>
+ <para>Display syntax highlighting to edit markup code. Use the <guisubmenu>Markup</guisubmenu> submenu to select the markup code type.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guisubmenu>Scripts</guisubmenu></term>
+ <listitem>
+ <para>Display syntax highlighting to edit script code. Use the <guisubmenu>Scripts</guisubmenu> submenu to select the script code type.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guisubmenu>Others</guisubmenu></term>
+ <listitem>
+ <para>Display syntax highlighting to edit other types of code. Use the <guisubmenu>Others</guisubmenu> submenu to select the code type.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <para>For more information about how to configure syntax highlighting, see <xref linkend="gedit-prefs-syntax"/>.
+</para>
+ </sect2>
+
+ </sect1>
+<!-- ============= Preferences ============================= -->
+ <sect1 id="gedit-prefs">
+ <title>Preferences</title>
+
+ <para>To configure <application>&app;</application>, choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Preferences</guimenuitem> </menuchoice>. The <guilabel>Preferences</guilabel> dialog contains the following categories:</para>
+ <itemizedlist>
+ <listitem><para><xref linkend="gedit-prefs-editor"/></para></listitem>
+ <listitem><para><xref linkend="gedit-prefs-view"/></para></listitem>
+ <listitem><para><xref linkend="gedit-prefs-fontsandcolors"/></para></listitem>
+ <listitem><para><xref linkend="gedit-prefs-syntax"/></para></listitem>
+ <listitem><para><xref linkend="gedit-prefs-plugins"/></para></listitem>
+ </itemizedlist>
+
+ <sect2 id="gedit-prefs-editor">
+ <title>Editor</title>
+ <variablelist>
+ <varlistentry> <term><guilabel>Tabs</guilabel> </term>
+ <listitem>
+ <para>Use the <guilabel>Tabs width</guilabel> spin box to specify the width of the space that <application> &app;</application> inserts when you press the <keycap>Tab</keycap> key. </para>
+ <para>Select the <guilabel>Insert spaces instead of tabs</guilabel> option to specify that <application> &app;</application> inserts spaces instead of a tab character when you press the <keycap>Tab</keycap> key. </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry> <term><guilabel>Auto Indentation</guilabel> </term>
+ <listitem> <para>Select the <guilabel>Enable auto indentation</guilabel> option to specify that the next line starts at the indentation level of the current line. </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry> <term><guilabel>File Saving</guilabel> </term>
+ <listitem>
+ <para>Select the <guilabel>Create a backup copy of files before saving</guilabel> option to create a backup copy of a file each time you save the file. The backup copy of the file contains a ~ at the end of the filename.</para>
+ <para>Select the <guilabel>Autosave files every ... minutes</guilabel> option to automatically save the current file at regular intervals. Use the spin box to specify how often you want to save the file.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry> <term><guilabel>Undo</guilabel> </term>
+ <listitem>
+ <para>Select the <guilabel>Limit to ... actions</guilabel> option to set a limit on the number of editing actions that you can undo. Use the spin box to specify the maximum number of actions that you can undo. </para>
+ <para>Select the <guilabel>Unlimited undo</guilabel> option to set no limit on the number of editing actions that you can undo. </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect2>
+
+ <sect2 id="gedit-prefs-view">
+ <title>View</title>
+ <variablelist>
+ <varlistentry> <term><guilabel>Text Wrapping</guilabel> </term>
+ <listitem>
+ <para>Select the <guilabel>Enable text wrapping</guilabel> option to wrap text onto the next line, at a character level, when you reach the text window boundary. </para>
+ <para>Select the <guilabel>Do not split words over two lines</guilabel> option to wrap text onto the next line, at a word level, when you reach the text window boundary. </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guilabel>Line Numbers</guilabel></term>
+ <listitem>
+ <para>Select the <guilabel>Display line numbers</guilabel> option to display line numbers on the left side of the <application>&app;</application> window. </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guilabel>Right Margin</guilabel></term>
+ <listitem>
+ <para>Select the <guilabel>Display right margin</guilabel> option to display a vertical line that indicates the right margin. </para>
+ <para>Use the <guilabel>Right margin at column</guilabel> spin box to specify the location of the vertical line. </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect2>
+
+ <sect2 id="gedit-prefs-fontsandcolors">
+ <title>Font & Colors</title>
+ <variablelist>
+ <varlistentry> <term><guilabel>Font</guilabel> </term>
+ <listitem>
+ <para>Select the <guilabel>Use default theme font</guilabel> option to use the default system font for the text in the <application>&app;</application> text window. </para>
+ <para>The <guilabel>Editor font</guilabel> field displays the font that <application>&app;</application> uses to display text. Click on the button to specify the font type, style, and size to use for text. </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry> <term><guilabel>Colors</guilabel> </term>
+ <listitem>
+ <para>Select the <guilabel>Use default theme colors</guilabel> option to use the default theme colors in the <application>&app;</application> text window. </para>
+ <para>Click on the <guibutton>Normal text color</guibutton> color button to display the color selector dialog. Select a color to use to display normal text in the <application>&app;</application> text window. </para>
+ <para>Click on the <guibutton>Background color</guibutton> color button to display the color selector dialog. Select a background color for the <application>&app;</application> text window. </para>
+ <para>Click on the <guibutton>Selected text color</guibutton> color button to display the color selector dialog. Select a color to use to display selected text.
+ </para>
+ <para>Click on the <guibutton>Selection color</guibutton> color button to display the color selector dialog. Select a background color to use to highlight a text selection. </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect2>
+
+ <sect2 id="gedit-prefs-syntax">
+ <title>Syntax Highlighting</title>
+ <variablelist>
+ <varlistentry> <term><guilabel>Enable syntax highlighting</guilabel> </term>
+ <listitem>
+ <para>Select this option to highlight the syntax of the text that you edit. </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry> <term><guilabel>Highlight mode</guilabel> </term>
+ <listitem>
+ <para>Use this drop-down list to select a syntax mode to configure. </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry> <term><guilabel>Elements</guilabel> </term>
+ <listitem>
+ <para>Use this list box to select a syntax element to configure. </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry> <term>Format buttons </term>
+ <listitem>
+ <para>Use the following buttons to change the format of the selected syntax element: </para>
+ <informaltable frame="all">
+ <tgroup cols="2" colsep="1" rowsep="1">
+ <colspec colname="COLSPEC0" colwidth="50*"/>
+ <colspec colname="COLSPEC1" colwidth="50*"/>
+ <thead>
+ <row valign="top">
+ <entry colname="COLSPEC0">
+ <para>Button</para></entry>
+ <entry colname="COLSPEC1">
+ <para>Format</para></entry>
+ </row>
+ </thead>
+ <tbody>
+ <row valign="top">
+ <entry>
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="figures/gedit_format_bold.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Shows icon for bold format.</phrase>
+ </textobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry>
+ <para>
+ Bold
+ </para>
+ </entry>
+ </row>
+ <row valign="top">
+ <entry>
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="figures/gedit_format_italic.png" format="PNG"/> </imageobject>
+ <textobject>
+ <phrase>Shows icon for italic format.</phrase>
+ </textobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry>
+ <para>
+ Italic
+ </para>
+ </entry>
+ </row>
+ <row valign="top">
+ <entry>
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="figures/gedit_format_underline.png" format="PNG"/> </imageobject>
+ <textobject>
+ <phrase>Shows icon for underline.</phrase>
+ </textobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry>
+ <para>
+ Underline
+ </para>
+ </entry>
+ </row>
+ <row valign="top">
+ <entry>
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="figures/gedit_format_strikethrough.png" format="PNG"/> </imageobject>
+ <textobject>
+ <phrase>Shows icon for strikethrough.</phrase>
+ </textobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry>
+ <para>
+ Strikethrough
+ </para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </listitem>
+ </varlistentry>
+ <varlistentry> <term><guilabel>Foreground</guilabel> </term>
+ <listitem>
+ <para>Select this option to change the font color of the selected syntax element. Click on the color button to display the color selector dialog, then select the font color.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry> <term><guilabel>Background</guilabel> </term>
+ <listitem>
+ <para>Select this option to change the background color of the selected syntax element. Click on the color button to display the color selector dialog, then select the background color.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry> <term><guibutton>Reset to Default</guibutton> </term>
+ <listitem>
+ <para>Click on this button to reset the foreground color and background color of the selected syntax element to the default values.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect2>
+
+ <sect2 id="gedit-prefs-plugins">
+ <title>Plugins</title>
+ <para>For information about how to use the <guilabel>Plugins</guilabel> category of the <guilabel>Preferences</guilabel> dialog, see <xref linkend="gedit-install-plugins"/>. </para>
+ </sect2>
+
+ </sect1>
+<!-- ============= To Use the gedit Plugins ========================= -->
+ <sect1 id="gedit-plugins">
+ <title>Working with Plugins</title>
+ <para>A plugin is a supplementary program that enhances the functionality of an application. The <application>&app;</application> plugins enable you to perform a variety of functions related to text editing from within the <application> &app;</application> window. The following table lists the <application> &app;</application> plugins.</para>
+ <informaltable frame="topbot">
+ <tgroup cols="2">
+ <colspec colname="col1"/>
+ <colspec colname="col2"/>
+ <thead>
+ <row valign="top">
+ <entry colname="col1" colsep="0" valign="top"><para>Plugin Name</para></entry>
+ <entry colname="col2" valign="top"><para>Purpose</para></entry>
+ </row>
+ </thead>
+ <tbody>
+ <row valign="top">
+ <entry><para>ChangeCase</para></entry>
+ <entry><para>Changes the case of the selected text.</para></entry>
+ </row>
+ <row valign="top">
+ <entry><para>Document Statistics</para></entry>
+ <entry><para>Counts the number of lines, words, characters with spaces, characters without spaces, and bytes in the current file. The plugin displays the results in a <guilabel>Document Statistics</guilabel> dialog. </para></entry>
+ </row>
+ <row valign="top">
+ <entry><para>Indent lines</para></entry>
+ <entry><para>Indents the selected lines, or removes the indentation from the selected lines.</para></entry>
+ </row>
+ <row valign="top">
+ <entry><para>Insert Date/Time</para></entry>
+ <entry><para>Inserts the current date and time into a file.</para></entry>
+ </row>
+ <row valign="top">
+ <entry><para>Shell command</para></entry>
+ <entry><para>Displays the text output of a shell command in the output window. </para></entry>
+ </row>
+ <row valign="top">
+ <entry><para>Sort</para></entry>
+ <entry><para>Sorts the selected text. </para></entry>
+ </row>
+ <row valign="top">
+ <entry><para>Spell checker</para></entry>
+ <entry><para>Checks the spelling in the selected text. You can configure <application>&app;</application> to check the spelling automatically, or you can check the spelling manually, in the specified language.</para></entry>
+ </row>
+
+ <row valign="top">
+ <entry><para>Tag list</para></entry>
+ <entry><para>Displays a window that contains a list of common tags. You can use the window to insert a tag into a file. </para></entry>
+ </row>
+ <row valign="top">
+ <entry><para>User name</para></entry>
+ <entry><para>Inserts the username of the current user into the file. </para></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ <para>When you choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Preferences</guimenuitem> </menuchoice>, the <guilabel>Plugins</guilabel> tabbed section displays the following information:</para>
+ <itemizedlist>
+ <listitem><para>A table that contains two columns: </para>
+ <variablelist>
+ <varlistentry>
+ <term><guilabel>Enabled</guilabel></term>
+ <listitem>
+ <para>Displays check boxes that you select to load the plugins.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guilabel>Plugin</guilabel></term>
+ <listitem>
+ <para>Displays a list of the plugins that you can use with <application>&app;</application>.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ <listitem><para>An <guibutton>About Plugin</guibutton> button: use this button to display a brief description of the selected plugin, including details about the author of the plugin. </para>
+ </listitem>
+ <listitem><para>A <guibutton>Configure Plugin</guibutton> button: use this button to open a configuration dialog for the selected plugin, if that plugin is configurable. For example, see <xref linkend="gedit-date-time-configure"/>.</para>
+ </listitem>
+ </itemizedlist>
+ <para>When you load a plugin, <application>&app;</application> adds the plugin to the appropriate <application>&app;</application> menu, as described in the following table.</para>
+ <informaltable frame="topbot">
+ <tgroup cols="2">
+ <colspec colname="col1"/>
+ <colspec colname="col2"/>
+ <thead>
+ <row valign="top">
+ <entry colname="col1" colsep="0" valign="top"><para>Plugin Name</para></entry>
+ <entry colname="col2" valign="top"><para>Added to Menu</para></entry>
+ </row>
+ </thead>
+ <tbody>
+ <row valign="top">
+ <entry><para>ChangeCase</para></entry>
+ <entry><para><menuchoice><guimenu>Edit</guimenu>
+ <guisubmenu>Change Case</guisubmenu>
+ <guimenuitem>All Upper Case</guimenuitem></menuchoice></para>
+ <para><menuchoice><guimenu>Edit</guimenu>
+ <guisubmenu>Change Case</guisubmenu>
+ <guimenuitem>All Lower Case</guimenuitem></menuchoice></para>
+ <para><menuchoice><guimenu>Edit</guimenu>
+ <guisubmenu>Change Case</guisubmenu>
+ <guimenuitem>Invert Case</guimenuitem></menuchoice></para>
+ <para><menuchoice><guimenu>Edit</guimenu>
+ <guisubmenu>Change Case</guisubmenu>
+ <guimenuitem>Title Case</guimenuitem></menuchoice></para></entry>
+ </row>
+ <row valign="top">
+ <entry><para>Document Statistics</para></entry>
+ <entry><para><menuchoice><guimenu>Tools</guimenu>
+ <guimenuitem>Document Statistics</guimenuitem></menuchoice></para></entry>
+ </row>
+ <row valign="top">
+ <entry><para>Indent lines</para></entry>
+ <entry><para><menuchoice><guimenu>Edit</guimenu>
+ <guimenuitem>Indent</guimenuitem></menuchoice></para>
+ <para><menuchoice><guimenu>Edit</guimenu>
+ <guimenuitem>Unindent</guimenuitem></menuchoice></para></entry>
+ </row>
+ <row valign="top">
+ <entry><para>Insert Date/Time</para></entry>
+ <entry><para><menuchoice><guimenu>Edit</guimenu>
+ <guimenuitem>Insert Date and Time</guimenuitem></menuchoice></para></entry>
+ </row>
+ <row valign="top">
+ <entry><para>Shell command</para></entry>
+ <entry><para><menuchoice><guimenu>Tools</guimenu>
+ <guimenuitem>Run Command</guimenuitem></menuchoice></para></entry>
+ </row>
+ <row valign="top">
+ <entry><para>Sort</para></entry>
+ <entry><para><menuchoice><guimenu>Edit</guimenu>
+ <guimenuitem>Sort</guimenuitem></menuchoice></para></entry>
+ </row>
+ <row valign="top">
+ <entry><para>Spell checker</para></entry>
+ <entry>
+ <para><menuchoice><guimenu>Tools</guimenu>
+ <guimenuitem>Check Spelling</guimenuitem></menuchoice></para>
+ <para><menuchoice><guimenu>Tools</guimenu>
+ <guimenuitem>Autocheck Spelling</guimenuitem></menuchoice></para>
+ <para><menuchoice><guimenu>Tools</guimenu>
+ <guimenuitem>Set Language</guimenuitem></menuchoice></para>
+ </entry>
+ </row>
+ <row valign="top">
+ <entry><para>Tag list</para></entry>
+ <entry><para><menuchoice><guimenu>View</guimenu>
+ <guimenuitem>Tag List</guimenuitem></menuchoice></para></entry>
+ </row>
+ <row valign="top">
+ <entry><para>User name</para></entry>
+ <entry><para><menuchoice><guimenu>Edit</guimenu>
+ <guimenuitem>Insert User Name</guimenuitem></menuchoice></para></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+<!-- ============= To Load gedit Plugins ========================= -->
+ <sect2 id="gedit-install-plugins">
+ <title>To Load a &app; Plugin</title>
+ <para>To load a <application>&app;</application> plugin, perform the following steps:</para>
+ <orderedlist>
+ <listitem>
+ <para>Choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Preferences</guimenuitem> </menuchoice>. </para>
+ </listitem>
+ <listitem>
+ <para>Select the <guilabel>Plugins</guilabel> tab. </para>
+ </listitem>
+ <listitem>
+ <para>Select the check box next to the name of the plugin that you want to load.</para>
+ </listitem>
+ <listitem>
+ <para>Click <guibutton>Close</guibutton> to close the <guilabel>Preferences</guilabel> dialog. </para>
+ </listitem>
+ </orderedlist>
+ </sect2>
+
+<!-- ============= To Remove gedit Plugins ========================= -->
+ <sect2 id="gedit-remove-plugins">
+ <title>To Remove a &app; Plugin</title>
+ <para>A plugin remains loaded when you quit <application>&app;</application>. </para>
+ <para>To remove a <application>&app;</application> plugin, perform the following steps:</para>
+ <orderedlist>
+ <listitem>
+ <para>Choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Preferences</guimenuitem> </menuchoice>. </para>
+ </listitem>
+ <listitem>
+ <para>Select the <guilabel>Plugins</guilabel> tab. </para>
+ </listitem>
+ <listitem>
+ <para>Deselect the check box next to the name of the plugin that you want to remove.</para>
+ </listitem>
+ <listitem>
+ <para>Click <guibutton>Close</guibutton> to close the <guilabel>Preferences</guilabel> dialog. </para>
+ </listitem>
+ </orderedlist>
+ </sect2>
+
+<sect2 id="gedit-change-case-plugin">
+<title>To Use the ChangeCase Plugin</title>
+ <para>The ChangeCase plugin changes the case of the selected text. To use the ChangeCase plugin, perform the following steps:</para>
+ <orderedlist>
+ <listitem><para>Load the ChangeCase plugin.</para>
+ </listitem>
+ <listitem><para>Choose one of the following menu items:</para>
+ <informaltable frame="all">
+ <tgroup cols="3" colsep="1" rowsep="1">
+ <colspec colname="COLSPEC0" colwidth="33*"/>
+ <colspec colname="COLSPEC1" colwidth="33*"/>
+ <colspec colname="COLSPEC2" colwidth="33*"/>
+ <thead>
+ <row valign="top">
+ <entry colname="COLSPEC0">
+ <para>Menu Item</para></entry>
+ <entry colname="COLSPEC1">
+ <para>Action</para></entry>
+ <entry colname="COLSPEC2">
+ <para>Example</para></entry>
+ </row>
+ </thead>
+ <tbody>
+ <row valign="top">
+ <entry><para><menuchoice><guimenu>Edit</guimenu>
+<guisubmenu>Change Case</guisubmenu><guimenuitem>All Upper Case</guimenuitem></menuchoice></para></entry>
+ <entry><para>Change each character to uppercase. </para></entry>
+ <entry><para><literal>This text</literal> becomes <literal>THIS TEXT</literal> </para></entry>
+ </row>
+ <row valign="top">
+ <entry><para><menuchoice><guimenu>Edit</guimenu>
+<guisubmenu>Change Case</guisubmenu><guimenuitem>All Lower Case</guimenuitem></menuchoice></para></entry>
+ <entry><para>Change each character to lowercase. </para></entry>
+ <entry><para><literal>This Text</literal> becomes <literal>this text</literal> </para></entry>
+ </row>
+ <row valign="top">
+ <entry><para><menuchoice><guimenu>Edit</guimenu>
+<guisubmenu>Change Case</guisubmenu><guimenuitem>Invert Case</guimenuitem></menuchoice></para></entry>
+ <entry><para>Change each lowercase character to uppercase, and change each uppercase character to lowercase. </para></entry>
+ <entry><para><literal>This Text</literal> becomes <literal>tHIS tEXT</literal> </para></entry>
+ </row>
+ <row valign="top">
+ <entry><para><menuchoice><guimenu>Edit</guimenu>
+<guisubmenu>Change Case</guisubmenu><guimenuitem>Title Case</guimenuitem></menuchoice></para></entry>
+ <entry><para>Change the first character of each word to uppercase. </para></entry>
+ <entry><para><literal>this text</literal> becomes <literal>This Text</literal> </para></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </listitem>
+ </orderedlist>
+</sect2>
+
+<sect2 id="gedit-document-statistics-plugin">
+<title>To Use the Document Statistics Plugin</title>
+ <para>The Document Statistics plugin counts the number of lines, words, characters with spaces, characters without spaces, and bytes in the current file. The plugin displays the results in a <guilabel>Document Statistics</guilabel> dialog. To use the Document Statistics plugin, perform the following steps:</para>
+ <orderedlist>
+ <listitem><para>Load the Document Statistics plugin. </para>
+ </listitem>
+ <listitem><para>Choose <menuchoice> <guimenu>Tools</guimenu> <guimenuitem>Document Statistics</guimenuitem> </menuchoice> to display the <guilabel>Document Statistics</guilabel> dialog. The <guilabel>Document Statistics</guilabel> dialog displays the following information about the file:
+ </para>
+ <itemizedlist>
+ <listitem><para>Number of lines in the current document.
+ </para>
+ </listitem>
+ <listitem><para>Number of words in the current document.
+ </para>
+ </listitem>
+ <listitem><para>Number of characters, including spaces, in the current document.
+ </para>
+ </listitem>
+ <listitem><para>Number of characters, not including spaces, in the current document.
+ </para>
+ </listitem>
+ <listitem><para>Number of bytes in the current document.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem><para>You can continue to update the <application>&app;</application> file while the <guilabel>Document Statistics</guilabel> dialog is open. To refresh the contents of the <guilabel>Document Statistics</guilabel> dialog, click <guibutton>Update</guibutton>.
+ </para>
+ </listitem>
+ <listitem><para>To close the <guilabel>Document Statistics</guilabel> dialog, click <guibutton>Close</guibutton>.
+ </para>
+ </listitem>
+ </orderedlist>
+</sect2>
+
+<sect2 id="gedit-indent-lines-plugin">
+<title>To Use the Indent Lines Plugin</title>
+ <para>The Indent lines plugin indents the selected lines, or removes the indentation from the selected lines. To use the Indent lines plugin, perform the following steps:</para>
+ <orderedlist>
+ <listitem><para>Load the Indent lines plugin. </para>
+ </listitem>
+ <listitem><para>Select the lines that you want to indent. To indent or unindent a single line, place the cursor anywhere on that line.
+ </para>
+ </listitem>
+ <listitem><para>Choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Indent</guimenuitem> </menuchoice>. </para>
+ </listitem>
+ <listitem><para>To remove the indentation, select the lines and choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Unindent</guimenuitem> </menuchoice>.
+ </para>
+ </listitem>
+ </orderedlist>
+</sect2>
+
+<sect2 id="gedit-insert-date-time-plugin">
+<title>To Use the Insert Date/Time Plugin</title>
+ <para>The Insert Date/Time plugin inserts the current date and time into a file. To use the Insert Date/Time plugin, perform the following steps:</para>
+ <orderedlist>
+ <listitem><para>Load the Insert Date/Time plugin. </para>
+ </listitem>
+ <listitem><para>Choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Insert Date and Time</guimenuitem> </menuchoice>. </para>
+ <para>If you have not configured the Insert Date/Time plugin to automatically insert the date/time without prompting you for the format, <application>&app;</application> displays the <guilabel>Insert Date and Time</guilabel> dialog. Select the appropriate date/time format from the list. Click <guibutton>Insert</guibutton> to close the <guilabel>Insert Date and Time</guilabel> dialog. <application>&app;</application> inserts the date/time at the cursor position in the current file. </para>
+ <para>If you have configured <application>&app;</application> to use one particular date/time format, the <guilabel>Insert Date and Time</guilabel> dialog is not displayed. The date/time is automatically entered at the cursor position in the current file. </para>
+ <para>See <xref linkend="gedit-date-time-configure"/> for information about how to configure the Insert Date/Time plugin.</para>
+ </listitem>
+ </orderedlist>
+
+<sect3 id="gedit-date-time-configure">
+<title>To Configure the Insert Date/Time Plugin</title>
+<para>To configure the Insert Date/Time plugin, perform the following steps:</para>
+ <orderedlist>
+ <listitem> <para>Choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Preferences</guimenuitem> </menuchoice>.
+ </para>
+ </listitem>
+ <listitem> <para>Select the <guilabel>Plugins</guilabel> tab.
+ </para>
+ </listitem>
+ <listitem> <para>Select the <guilabel>Insert Date/Time</guilabel> plugin.
+ </para>
+ </listitem>
+ <listitem> <para>Click <guibutton>Configure Plugin</guibutton> to display the <guilabel>Configure insert date/time plugin</guilabel> dialog.
+ </para>
+ </listitem>
+ <listitem> <para>Select one of the options, as follows: </para>
+ <itemizedlist>
+ <listitem><para>To specify the date/time format each time you insert the date/time, select the <guilabel>Prompt for a format</guilabel> option.
+ </para>
+ </listitem>
+ <listitem><para>To use the same <application>&app;</application>-provided date/time format each time you insert the date/time, select the <guilabel>Use the selected format</guilabel> option, then select the appropriate format from the list. When you select this option, <application>&app;</application> does not prompt you for the date/time format when you choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Insert Date and Time</guimenuitem> </menuchoice>.
+ </para>
+ </listitem>
+ <listitem><para>To use the same customized date/time format each time you insert the date/time, select the <guilabel>Use custom format</guilabel> option, then enter the appropriate format in the text box. For more information about how to specify a custom format, see <ulink url="man:strftime" type="man"><citerefentry><refentrytitle>strftime</refentrytitle><manvolnum>3</manvolnum></citerefentry></ulink>. When you select this option, <application>&app;</application> does not prompt you for the date/time format when you choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Insert Date and Time</guimenuitem> </menuchoice>.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem> <para>Click <guibutton>OK</guibutton> to close the <guilabel>Configure insert date/time plugin</guilabel> dialog.
+ </para>
+ </listitem>
+ <listitem> <para>To close the <guilabel>Preferences</guilabel> dialog, click <guibutton>Close</guibutton>.</para>
+ </listitem>
+ </orderedlist>
+</sect3>
+</sect2>
+
+<sect2 id="gedit-shell-command-plugin">
+<title>To Use the Shell Command Plugin</title>
+
+ <para>The Shell Command plugin enables you to capture the output from a shell command in <application>&app;</application>, by displaying the text output of the shell command in the output window. To use the Shell command plugin, perform the following steps:</para>
+ <orderedlist>
+ <listitem><para>Load the Shell command plugin. </para>
+ </listitem>
+
+ <listitem><para>Choose <menuchoice> <guimenu>Tools</guimenu> <guimenuitem>Run Command</guimenuitem> </menuchoice> to display the <guilabel>Run Command</guilabel> dialog.
+ </para>
+ </listitem>
+ <listitem><para>Type the shell command that you want to execute in the <guilabel>Command</guilabel> field. </para>
+ <para> You can include the following special characters:</para>
+ <itemizedlist>
+ <listitem>
+ <para><literal>%f</literal></para>
+ <para>Use these special characters to specify the filename of the current active document, including the path. </para>
+ </listitem>
+ <listitem>
+ <para><literal>%n</literal></para>
+ <para>Use these special characters to specify the filename of the current active document, without the path. In this case, <application>&app;</application> looks for the file in the Working directory. </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem><para>Edit the <guilabel>Working directory</guilabel> field if necessary. By default, the Shell command plugin executes the command you specify in the current directory. </para>
+ </listitem>
+ <listitem><para>Select the <guilabel>Show results in Output Window</guilabel> option to display the results of the command in the output window. If you do not select this option, <application>&app;</application> discards the results of the command.
+ </para>
+ </listitem>
+ <listitem><para>Click <guibutton>Run</guibutton>. The Shell command plugin executes the command and inserts the text output into the output window.
+ </para>
+ </listitem>
+ <listitem><para>Use the <keycap>Shift</keycap> key to select the text in the output window. </para>
+ </listitem>
+ <listitem><para>Click <guibutton>Copy selected lines</guibutton> to copy the selected text into the buffer.
+ </para>
+ </listitem>
+ <listitem><para>Choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Paste</guimenuitem> </menuchoice> to paste the selected text into the file.
+ </para>
+ </listitem>
+ <listitem><para>Click <guibutton>Close the output window</guibutton> to close the output window.
+ </para>
+ </listitem>
+ </orderedlist>
+
+</sect2>
+<sect2 id="gedit-sort-plugin">
+<title>To Use the Sort Plugin</title>
+ <para>The Sort plugin sorts the selected text.</para>
+ <note><para>You cannot undo the Sort operation, so you should save the file before performing the sort. To revert to the saved version of the file after the sort operation, choose <menuchoice> <guimenu>File</guimenu> <guimenuitem>Revert</guimenuitem> </menuchoice>.
+ </para>
+ </note>
+ <para>To use the Sort plugin, perform the following steps:</para>
+ <orderedlist>
+ <listitem><para>Load the Sort plugin. </para>
+ </listitem>
+ <listitem><para>Choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Sort</guimenuitem> </menuchoice> to display the <guilabel>Sort</guilabel> dialog.
+ </para>
+ </listitem>
+ <listitem><para>To arrange the text in reverse sort order, select the <guilabel>Reverse order</guilabel> option.
+ </para>
+ </listitem>
+ <listitem><para>To delete duplicate lines, select the <guilabel>Remove duplicates</guilabel> option.
+ </para>
+ </listitem>
+ <listitem><para>To ignore case sensitivity, select the <guilabel>Ignore case</guilabel> option.
+ </para>
+ </listitem>
+ <listitem><para>To specify the start position of the sort, use the <guilabel>Start at column</guilabel> spin box.
+ </para>
+ </listitem>
+ <listitem><para>To perform the sort operation, click <guibutton>Sort</guibutton>.
+ </para>
+ </listitem>
+ </orderedlist>
+</sect2>
+
+<sect2 id="gedit-spell-checker-plugin">
+<title>To Use the Spell Checker Plugin</title>
+ <para>The Spell checker plugin checks the spelling in the selected text. You can configure <application>&app;</application> to check the spelling automatically, or you can check the spelling manually, in the specified language. The language setting, and the autocheck spelling properties, apply per document. To use the Spell checker plugin, perform the following steps:</para>
+ <orderedlist>
+ <listitem><para>Load the Spell checker plugin. </para>
+ </listitem>
+ <listitem><para>Choose <menuchoice> <guimenu>Tools</guimenu> <guimenuitem>Set Language</guimenuitem> </menuchoice> to display the <guilabel>Set language</guilabel> dialog. Select the appropriate language from the list. Click <guibutton>OK</guibutton> to close the <guilabel>Set language</guilabel> dialog.
+ </para>
+ </listitem>
+ <listitem><para>To check the spelling automatically, choose <menuchoice> <guimenu>Tools</guimenu> <guimenuitem>Autocheck Spelling</guimenuitem> </menuchoice>. To unset the automatic spell check, choose <menuchoice> <guimenu>Tools</guimenu> <guimenuitem>Autocheck Spelling</guimenuitem> </menuchoice> again. When automatic spell checking is set, an icon is displayed beside the <guimenuitem>Autocheck Spelling</guimenuitem> menu item. Automatic spell checking is unset by default, each time <application>&app;</application> starts.</para>
+ <para>Unknown spellings are displayed in a different color, and underlined. Right-click on an unknown spelling, then select <guimenu>Spelling Suggestions</guimenu> from the popup menu:
+ </para>
+ <itemizedlist>
+ <listitem><para>To replace the unknown spelling with another spelling in the list, select the replacement spelling from the <guimenu>Spelling Suggestions</guimenu> popup menu.
+ </para>
+ </listitem>
+ <listitem><para>To add the unknown spelling to your personal dictionary, select <menuchoice> <guimenu>Spelling Suggestions</guimenu> <guimenuitem>Add</guimenuitem> </menuchoice>.
+ </para>
+ </listitem>
+ <listitem><para>To ignore all occurrences of the unknown spelling, so that they are no longer flagged as unknown but are not added to your personal dictionary, select <menuchoice> <guimenu>Spelling Suggestions</guimenu> <guimenuitem>Ignore All</guimenuitem> </menuchoice>. The unknown word is ignored in the current <application>&app;</application> session only.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem><para>To check the spelling manually, choose <menuchoice> <guimenu>Tools</guimenu> <guimenuitem>Check Spelling</guimenuitem> </menuchoice>.
+ </para>
+ <para>If there are no spelling errors, an <guilabel>Information</guilabel> dialog displays a message stating that the document does not contain misspelled words. Click <guibutton>OK</guibutton> to close the <guilabel>Information</guilabel> dialog.
+ </para>
+ <para>If there are spelling errors, the <guilabel>Check Spelling</guilabel> dialog is displayed:
+ </para>
+ <itemizedlist>
+ <listitem><para>The <guilabel>Misspelled word</guilabel> is displayed at the top of the dialog.
+ </para>
+ </listitem>
+ <listitem><para>A suggested known spelling is displayed in the <guilabel>Change to</guilabel> text box. You can replace this with another known spelling by selecting a spelling from the <guilabel>Suggestions</guilabel> list, or you can enter text directly into the <guilabel>Change to</guilabel> text box.
+ </para>
+ </listitem>
+ <listitem><para>To check the spelling of the text in the <guilabel>Change to</guilabel> text box, click <guibutton>Check Word</guibutton>. If this is a known word, the <guilabel>Suggestions</guilabel> list is replaced with the text <literal>(correct spelling)</literal>. If the word is not known, new entries appear in the <guilabel>Suggestions</guilabel> list.
+ </para>
+ </listitem>
+ <listitem><para>To ignore the current occurrence of the unknown word, click <guibutton>Ignore</guibutton>. To ignore all occurrences of the unknown word, click <guibutton>Ignore All</guibutton>. The unknown word is ignored in the current <application>&app;</application> session only.
+ </para>
+ </listitem>
+ <listitem><para>To change the current occurrence of the unknown word to the text in the <guilabel>Change to</guilabel> text box, click <guibutton>Change</guibutton>. To change all occurrences of the unknown word to the text in the <guilabel>Change to</guilabel> text box, click <guibutton>Change All</guibutton>.
+ </para>
+ </listitem>
+ <listitem><para>To add the unknown word to your personal dictionary, click <guibutton>Add word</guibutton>.
+ </para>
+ </listitem>
+ <listitem><para>To close the <guilabel>Check Spelling</guilabel> dialog, click <guibutton>Close</guibutton>.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </orderedlist>
+</sect2>
+
+<sect2 id="gedit-tag-list-plugin">
+<title>To Use the Tag List Plugin</title>
+ <para>The Tag List plugin displays a window that contains a list of common tags. You can use the window to insert a tag into a file. To use the Tag List plugin, perform the following steps:</para>
+ <orderedlist>
+ <listitem><para>Load the Tag List plugin. </para>
+ </listitem>
+ <listitem><para>Choose <menuchoice> <guimenu>View</guimenu> <guimenuitem>Tag List</guimenuitem> </menuchoice> to display the <guilabel>Tag list plugin</guilabel> window.
+ </para>
+ </listitem>
+ <listitem><para>Select the appropriate tag category from the drop-down list. For example, <literal>HTML - Tags</literal>.
+ </para>
+ </listitem>
+ <listitem><para>Scroll through the tag list to find the required tag.
+ </para>
+ </listitem>
+ <listitem><para>To insert a tag at the cursor position in the current file, double-click on the tag in the tag list. You can also insert a tag as follows:</para>
+ <itemizedlist>
+ <listitem><para>To insert a tag in the current file and change the focus from the <guilabel>Tag list plugin</guilabel> window to the editor window, press <keycap>Return</keycap>.
+ </para>
+ </listitem>
+ <listitem><para>To insert a tag in the current file and maintain the focus on the <guilabel>Tag list plugin</guilabel> window, press <keycombo><keycap>Shift</keycap><keycap>Return</keycap></keycombo>.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem><para>To close the <guilabel>Tag list plugin</guilabel> window, click on the <guibutton>Close Window</guibutton> button in the window frame. Alternatively, press <keycombo><keycap>Ctrl</keycap><keycap>W</keycap></keycombo> when the focus is on the <guilabel>Tag list plugin</guilabel> window.
+ </para>
+ </listitem>
+ </orderedlist>
+</sect2>
+
+<sect2 id="gedit-user-name-plugin">
+<title>To Use the User Name Plugin</title>
+ <para>The User name plugin inserts the username of the current user into the file. To use the User name plugin, perform the following steps:</para>
+ <orderedlist>
+ <listitem><para>Load the User name plugin. </para>
+ </listitem>
+ <listitem><para>Choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Insert User Name</guimenuitem> </menuchoice> to insert your username at the cursor position in the current file.
+ </para>
+ </listitem>
+ </orderedlist>
+</sect2>
+ </sect1>
+
+</article>
--- ../gedit/Makefile.am 2006-01-27 11:51:10.000000000 +0000
+++ ./Makefile.am 2006-02-23 16:11:03.122716000 +0000
@@ -1,7 +1,7 @@
## Process this file with automake to produce Makefile.in
ACLOCAL_AMFLAGS = -I m4
-SUBDIRS = bindings gedit pixmaps po help data plugins
+SUBDIRS = bindings gedit pixmaps po data help plugins
distuninstallcheck_listfiles = find . -type f -print | grep -v scrollkeeper
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
