Commit 4d5b3905 authored by luzpaz's avatar luzpaz Committed by Alexandre Prokoudine

Proofreading

parent 73f26b4c
......@@ -7,14 +7,15 @@
The GIMP documentation project is mainly working with docbook xml files
to create the GIMP manual / online help. Since there are different
approaches how to create and edit such files as well as different tools
involved, there is a strong need for the xml files being well formated.
involved, there is a strong need for the xml files being well formatted.
Additionally there are a couple of technical reasons (diff, cvs) that
suggest a general styleguide for the xml files. This is a recommendation
for such a styleguide. Its mainly based on the styles that can be found
suggest a general style guide for the xml files. This is a recommendation
for such a style guide. Its mainly based on the styles that can be found
in xml files that build the current documentation, as well as on the
discussion on the gimp-doc mailing list.
2. XML styleguide by rules
2. XML style guide by rules
§1. General
§1.1. All docbook files for the documentation need to be well formed and
have to comply validation against
......@@ -42,15 +43,16 @@
§4.3. The languages encoded in the lang attributes appear in alphabetical
order of the language codes
§5. Indention
§5. Indentation
§5.1. Space or tab characters can be used for indentation, but it is higly
recommended not to mix space and tab character usage in one single xml
file.
§5.2. Indention width is two spaces (0x20). One tab (0x09) is equivalent
§5.2. Indentation width is two spaces (0x20). One tab (0x09) is equivalent
to 8 spaces (0x20).
§5.3. Indention is done for the content of all tags that start a new line
§5.3. Indentation is done for the content of all tags that start a new line
3 XML style guide by example
2 XML styleguide by example
Example for §1 General
Following the rules in §1 each xml file of the GIMP manual starts with:
......@@ -70,7 +72,7 @@
Example for §4. Element attributes
// to be done
Example for §5. Indention
Example for §5. Indentation
// to be done
Appendix I Inline elements
......
......@@ -54,7 +54,7 @@ AC_PROG_SED
# LANGUAGES will override ALL_LINGUAS
#
# Quickreference files are built for languages in
# QUICKREFERENCE_ALL_LINGUAS *and* (intersecton) ALL_LINGUAS
# QUICKREFERENCE_ALL_LINGUAS *and* (intersection) ALL_LINGUAS
if test "x$ALL_LINGUAS" = "x"; then
ALL_LINGUAS="ca da de el en en_GB es fi fr it ja ko nl nn pt_BR ro ru zh_CN"
......@@ -160,7 +160,7 @@ AC_SUBST(XML2POFLAGS)
AC_PATH_PROG(MSGFMT, msgfmt)
if test -z "$MSGFMT" && test "x$enable_i18n" = "xyes"; then
# print warning only for the main i18n toos xml2po & msgfmt
# print warning only for the main i18n tools xml2po & msgfmt
AC_MSG_WARN([cannot find msgfmt])
missing_i18n_tools=${missing_i18n_tools:+"${missing_i18n_tools} "}msgfmt
fi
......@@ -276,7 +276,7 @@ AM_CONDITIONAL(HAVE_PNGOPTIMIZERS, test -n "$PNGNQ" && test -n "$PNGCRUSH")
STYLEBASE='http://docbook.sourceforge.net/release/xsl/current'
# Allow to explicitely specify the stylesheet location
# Allow to explicitly specify the stylesheet location
# in case the XML catalog doesn't exist or is broken.
AC_ARG_WITH(xsl,
......
......@@ -128,8 +128,8 @@
<para>
As in every dialog that contains preview icons, you can control the
preview images in the tab menu. To get mor informations about that
topic read <xref linkend="gimp-concepts-docks" />.
preview images in the tab menu. To get more information about that
topic please read <xref linkend="gimp-concepts-docks" />.
</para>
</sect4>
......
......@@ -91,7 +91,7 @@ if ($Verbose > 1) {
"Mode(s) = ", join(' ', @Mode), "\n";
}
# Check for existance of directories:
# Check for existence of directories:
foreach (@Srcdirs, $Destdir) {
die "Error: no such directory: $_\n" unless -d
}
......@@ -140,7 +140,7 @@ sub get_copy_command {
}
}
# Subroutine for (re)setting coyp/link mode
# Subroutine for (re)setting copy/link mode
sub set_copy_mode {
if (defined($exec_copy_command)) {
# Fallback
......@@ -172,7 +172,7 @@ foreach my $srcdir (sort @Image_dirs) {
next unless -f $imgfile;
my $basename = (splitpath($imgfile))[2]; # (vol, dir, file)
my $destfile = catfile($dstdir, $basename); # the new file/link
# Check for existance of localized image:
# Check for existence of localized image:
if ($Localize_images) {
(my $localized_imgfile = $imgfile) =~ s|/C/|/$Language/|o;
$inc_i18n = (-e $localized_imgfile) ? 1 : 0;
......
......@@ -62,7 +62,7 @@ Special (helper) targets for build-system development:
dot Create a visualized version of the Makefile dependencies
(this may be not up-to-date!)
Make variables (can be overriden at command-line):
Make variables (can be overridden at command-line):
LINGUAS="..." Space-separated list of manual languages (e.g. "en de fr"),
restricted to ALL_LINGUAS=%ALL_LINGUAS%
LANGUAGES="..." Space-separated list of manual languages (e.g. "en de fr"),
......
......@@ -29,5 +29,5 @@ You can update the <LANG-CODE>.po files with make:
Bugs
-----
There is currently no sane way to integrate the Docbook version in the
manual. Either the seperated files will be integrated via xincludes or
manual. Either the separated files will be integrated via xincludes, or
the stylesheet needs to be adjusted to put each translation in one file.
......@@ -550,7 +550,7 @@
the category's name (Devel) to open the package list. Search down the
rightmost column to find the package name <quote>automake 1.12</quote>.
Click once on the word <quote>Skip</quote>. The text will change to
<quote>1.12.3-1</quote> which is the version number for the choosed
<quote>1.12.3-1</quote> which is the version number for the chosen
package. Do the same with the other packages in the list above. Some
packages will be marked <quote>Keep</quote> instead of <quote>Skip
</quote>. This means that these packages already are installed. Do not
......
......@@ -164,7 +164,7 @@
<listitem>
<para>
Below, a color swatch shows the color pointed by the mouse
cursor. Informations about this color and helpful hints or
cursor. Information about this color and helpful hints or
feedback messages may appear here.
</para>
</listitem>
......@@ -709,7 +709,7 @@
<caption>
<para>
Red has been chosen for left endpoint and yellow for the right
enpoint.
endpoint.
</para>
</caption>
</mediaobject>
......
......@@ -273,7 +273,7 @@
</para>
<note>
<para>
Some of the listed pop-menu entries are installation dependend
Some of the listed pop-menu entries are installation-dependent
and need the <ulink url="http://www.python.org">Python language
interpreter</ulink> to be installed. This includes at the
time of writing: <link linkend="gimp-palette-offset">Offset
......
......@@ -233,7 +233,7 @@
displayed on screen rather than by a black/white printer.
So it is often useful to apply a little anti-aliasing to
simulate ink smearing on paper. If you do want to print the
resulting image then set the antialising to 1 (ie, off).
resulting image then set the antialiasing to 1 (i.e., off).
</para>
<variablelist>
<varlistentry>
......
......@@ -13,7 +13,7 @@
2007-05-06 KoSt: added 'no'
2006-12-12 lexa: added german translation
2005-12-07 replaced <simplesect> by <sect3> by lexa
2005-10-14 ceated by julien hardelin
2005-10-14 created by julien hardelin
-->
<sect2 id="gimp-filter-displace">
<title>Displace</title>
......
......@@ -28,9 +28,9 @@
defined areas are enabled by the pointer. Obviously the most used effect
is a dynamic link to another web page when one of the sensitive areas is
clicked on. This <quote>filter</quote> allows you to design easily
sensitive areas within an image. Web site design softwares have this as a
standard function. In <acronym>GIMP</acronym> you can do this in a similar
way.
sensitive areas within an image. Applications for website design have this
as a standard function. In <acronym>GIMP</acronym>, you can do this in a
similar way.
</para>
<sect3>
......
<?xml version="1.0" encoding="UTF-8"?>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE glossary PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.docbook.org/xml/4.3/docbookx.dtd">
<glossary id="glossary">
......@@ -469,7 +469,7 @@ https://git.gnome.org/browse/gimp-help-2/tree/docs folder-->
<para>
This is the mode used in printing. These are the colors in the ink
cartridges in your printer. It is the mode used in painting and in all
the objects around us, where light is reflected, not emmitted. Objects
the objects around us, where light is reflected, not emitted. Objects
absorb part of the light waves and we see only the reflected part.
Note that the cones in our eyes see this reflected light in RGB mode.
An object appears Red because Green and Blue have been absorbed. Since
......@@ -2545,7 +2545,7 @@ fileref="images/dialogs/examples/layer-groups-pass-through-ex6.png"/>
along with the black-and-white signal, in order to achieve backwards
compatibility with old black and white televisions without having to
increase the available transmission bandwidth. From the YUV color
model of the analog television techiques, the YCrCb color model was
model of the analog television techniques, the YCrCb color model was
developed, which is used for most kinds of digital image and video
compression. Erroneously, the YUV color model is also often spoken
about in those fields, although the YCbCr model is actually used.
......
......@@ -206,7 +206,7 @@
</para>
<para>
This option might be useful to transfer image into printing
softwares with CMY capabilities.
software with CMY capabilities.
</para>
</listitem>
</varlistentry>
......@@ -219,7 +219,7 @@
</para>
<para>
This option might be useful to transfer image into printing
softwares with CMYK capabilities.
software with CMYK capabilities.
</para>
</listitem>
</varlistentry>
......
......@@ -173,7 +173,7 @@
The pointer x/y position is permanently displayed in the top
left part of the grid. By default, this curve is straight,
because every input level corresponds to the same
ouput tone. GIMP automatically places an anchor at both
output tone. GIMP automatically places an anchor at both
ends of the curve, for black (0) and white (255).
</para>
<para>
......
......@@ -149,7 +149,7 @@
Then press <keycap>Enter</keycap> to execute the command.
</para>
<para>
You can (and should!) use the constants you find in the decription
You can (and should!) use the constants you find in the description
of the procedure's parameters, for example
<quote>RGB-IMAGE</quote> or <quote>OVERLAY-MODE</quote>. But note
that you have to replace hyphens (<quote>-</quote>) with
......
......@@ -35,7 +35,7 @@
</figure>
<para>
When you add text to an image, <acronym>GIMP</acronym> adds specific
informations. This command lets you discard these informations,
information. This command lets you discard this information,
transforming the current text layer into a normal bitmap layer. The
reason to do that is not evident.
</para>
......
......@@ -15,9 +15,8 @@
</indexterm>
<para>
This command enables and disables showing the sample points in the image
window. Sample points are used to display color informations of up to four
pixels in the <link linkend="gimp-sample-point-dialog">sample points
dialog</link>.
window. Sample points are used to display color information in the
<link linkend="gimp-sample-point-dialog">sample points dialog</link>.
</para>
<sect3>
......
......@@ -49,7 +49,7 @@
<listitem>
<para>
<emphasis>Under Linux</emphasis>:
home/YourUserName/.mypaint/brushes. Take good note it is a hidden
/home/YourUserName/.mypaint/brushes. Take good note it is a hidden
directory.
</para>
<para>
......@@ -58,20 +58,20 @@
exist yet, you have to create it, with the brushes directory inside.
</para>
<para>
Copy-paste all the unziped files from your temp folder to
Copy-paste all the unzipped files from your temp folder to
home/YourUserName/.mypaint/brushes.
</para>
</listitem>
<listitem>
<para>
<emphasis>Under Windows 10 (and gimp-2.9.5)</emphasis>:
<emphasis>Under Windows 10 (and GIMP 2.10)</emphasis>:
~\.mypaint\brushes. Click on this item to select it and click on
the icon that opens a file browser. In the root of your home folder,
create a new folder"mypaint". The Mypaint path in Preferences
create a new folder"mypaint". The MyPaint path in Preferences
becomes C:\Users\your-user-name\mypaint.
</para>
<para>
Copy-paste all the unziped files from your temp folder to
Copy-paste all the unzipped files from your temp folder to
C:\Users\your-user-name\mypaint.
</para>
</listitem>
......
......@@ -7,7 +7,7 @@
2008-02-05 j.h : updated fr to v2.4 and enhanced align modes
examples for 'en' and 'fr'
2008-01-18 ude: enhanced(?) align mode examples
2007-05-23 Rebuilt Aligment section by j.h
2007-05-23 Rebuilt Alignment section by j.h
2006-02-05 fr revised; shortcut modified in "en" by j.h
2005-12-07 replaced <simplesect> by <sect3> by lexa
2005-11-30 replaced informalfigure by figure by lexa
......
......@@ -743,14 +743,14 @@
<secondary>Printing your photos</secondary>
</indexterm>
<para>
As in most softwares, in GIMP, printing needs to go to main menu
As in most applications, in GIMP, printing needs to go to main menu
<menuchoice>
<guimenu>File</guimenu>
<guisubmenu>Print</guisubmenu>
</menuchoice>.
However it is very useful to keep in mind some elementary concepts
to prevent some unpleasant surprises when looking at result, or to
cure them if that occurs. You always must remember:
cure them if that occurs. You must always remember:
</para>
<itemizedlist>
<listitem>
......
......@@ -134,7 +134,7 @@
<para><guilabel>Pan view</guilabel> (default) or</para>
</listitem>
<listitem>
<para><guilabel>Toogle to Move Tool</guilabel></para>
<para><guilabel>Toggle to Move Tool</guilabel></para>
</listitem>
<listitem>
<para><guilabel>No action</guilabel></para>
......
......@@ -59,8 +59,8 @@
<term>Save input device settings on exit</term>
<listitem>
<para>
When you check this box, GIMP remembers the tool, color, pattern and
brush you were using the last time you quitted.
When you check this box, GIMP remembers the tool, color, pattern, and
brush you were using the last time you quit.
</para>
</listitem>
</varlistentry>
......
......@@ -110,7 +110,7 @@
<para>
OpenCL is an acronym for Open Computing Language (see
<ulink url="https://en.wikipedia.org/wiki/OpenCL">
Wikpedia</ulink>). This option, checked by default, improves
Wikipedia</ulink>). This option, checked by default, improves
the management of relations between the CPU and the graphic
processing unit (GPU).
</para>
......
......@@ -18,7 +18,7 @@
max-width: 45em;
min-width: 15em;
/*
min / max only works withoud a fixed width...
min / max only works without a fixed width...
width: 45em;
*/
margin: 0 auto;
......
These tools should make your documentation life easier:
xml_helper.py - helps you to seperate your language from the XML,
xml_helper.py - helps you to separate your language from the XML,
and merge your changes back. Run with --help
option to see how to use it
......@@ -48,7 +48,7 @@ Operation modes:
--merge:
will integrate back a working copy of a XML file into the main
XML structure. The hidden version in .helper dir must exist.
Merged files are formated as for the --format mode, unless
Merged files are formatted as for the --format mode, unless
stated otherwise. N.B. the paths to the files passed to the
script are the paths on main src tree, not the in the working
dir.
......@@ -85,7 +85,7 @@ Options:
create new language tags, but empty tags, instead of copying
the content of the first language specified. NB - tags
created in this way are self closed ( <tag /> ), by the
xml generator. Dont forget to change the format to <tag>
xml generator. Don't forget to change the format to <tag>
</tag> when adding content.
--no-format:
passed to merge mode - doesn't run the formatting routines
......@@ -93,10 +93,10 @@ Options:
--no-delete-rip:
To avoid conflicts, the working XML version is deleted when
merging is successfull. If passing this option, the file is
merging is successful. If you pass this option, the file gets
preserved (the xmlids change when merging, so it is
basically impossible to use this script to merge a XML a
second time.
basically impossible to use this script to merge an XML the
second time).
General Notes:
......@@ -105,8 +105,8 @@ General Notes:
'changed=""' XML attribute. This way translations can be kept in
sink without further resource to Harry Potter style magic.
This script will not normally supress existing XML tags. If a tag
is deleted in the working file, it's copy in the .helper file will
This script will not normally suppress existing XML tags. If a tag
is deleted in the working file, its copy in the .helper file will
be used.
Workflow example :
......
......@@ -184,10 +184,10 @@ class Statistics(object):
invalid = []
names = {}
root = os.path.join(self.helproot, "src")
# dirs which we can savely skip
# dirs which we can safely skip
filter_directories = ['glossary', 'faq', 'filters']
# filenames which we can savely skip
# filenames which we can safely skip
filter_files = ['gimp', 'introduction', 'menu']
for root, dirs, files in os.walk(root):
......
......@@ -18,7 +18,7 @@
# 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
# Adapted for the GIMP Manual's build system 2009-12-14
# (c) 2009 The GIMP Documenation Team
# (c) 2009 The GIMP Documentation Team
#
import re
......
......@@ -38,8 +38,8 @@ CHANGEDTAG = "xml_changed"
work_dir = "./working_translation"
version = "0.91"
#TODO (v.0.9): properly formating the final gimp-help xml files
#that is: Adding a DTD header, and doing line wrapping and identation
#TODO (v.0.9): properly formatting the final gimp-help xml files
#that is: Adding a DTD header, and doing line-wrapping and indentation
class Stub(object):
......@@ -554,7 +554,7 @@ Operation modes:
--merge:
will integrate back a working copy of a XML file into
the main XML structure. The hidden version in .helper
dir must exist. Merged files are formated as for the
dir must exist. Merged files are formatted as for the
--format mode, unless stated otherwise.
N.B. the paths to the files passed to the script are the paths
on main src tree, not the in the working dir.
......@@ -592,7 +592,7 @@ Options:
create new language tags, but empty tags, instead of copying
the content of the first language specified. NB - tags created in
this way are self closed ( <tag /> ), by the xml generator.
Dont forget to change the format to <tag> </tag> when adding
Don't forget to change the format to <tag> </tag> when adding
content.
--no-format:
passed to merge mode - doesn't run the formatting routines
......@@ -600,9 +600,9 @@ Options:
--no-delete-rip:
To avoid conflicts, the working XML version is deleted when merging
is successfull. If passing this option, the file is preserved (the
xmlids change when merging, so it is basically impossible to use
this script to merge a XML a second time.
is successful. When you pass this option, the file gets preserved
(the xmlids change when merging, so it is basically impossible to use
this script to merge an XML the second time.
General Notes:
......@@ -611,8 +611,8 @@ If a version of the XML being split already exists in the
a 'changed=""' XML attribute. This way translations can be kept in sink
without further resource to Harry Potter style magic.
This script will not normally supress existing XML tags. If
a tag is deleted in the working file, it's copy in the .helper file
This script will not normally suppress existing XML tags. If
a tag is deleted in the working file, its copy in the .helper file
will be used.
Workflow example :
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment