[kde-doc-english] [kxstitch] doc: Various fixes and improvements
Yuri Chornoivan
yurchor at ukr.net
Wed May 28 05:16:11 UTC 2014
Git commit 4370f310873cec14ace5615d2533adc52a3ba320 by Yuri Chornoivan.
Committed on 28/05/2014 at 05:15.
Pushed by yurchor into branch 'master'.
Various fixes and improvements
M +3 -3 doc/commands.docbook
M +4 -2 doc/credits.docbook
M +22 -22 doc/dialogs.docbook
M +7 -7 doc/patterns.docbook
M +1 -1 doc/ui.docbook
http://commits.kde.org/kxstitch/4370f310873cec14ace5615d2533adc52a3ba320
diff --git a/doc/commands.docbook b/doc/commands.docbook
index 5d3d844..b1b7b2d 100644
--- a/doc/commands.docbook
+++ b/doc/commands.docbook
@@ -20,7 +20,7 @@
<listitem><simpara><action>Open a recently used pattern</action></simpara></listitem>
</varlistentry>
<varlistentry>
- <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>s</keycap></keycombo></shortcut><guimenuitem>Save</guimenuitem></menuchoice></term>
+ <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo></shortcut><guimenuitem>Save</guimenuitem></menuchoice></term>
<listitem><simpara><action>Saves the pattern</action></simpara></listitem>
</varlistentry>
<varlistentry>
@@ -169,11 +169,11 @@
<listitem><simpara><action>Zoom the view so that the patterns height fits within the visible area</action></simpara></listitem>
</varlistentry>
<varlistentry>
- <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>Shift</keycap><keycap>+</keycap></keycombo></shortcut><guimenuitem>Zoom In</guimenuitem></menuchoice></term>
+ <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>+</keycap></keycombo></shortcut><guimenuitem>Zoom In</guimenuitem></menuchoice></term>
<listitem><simpara><action>Zoom in on the editor view</action></simpara></listitem>
</varlistentry>
<varlistentry>
- <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>Shift</keycap><keycap>-</keycap></keycombo></shortcut><guimenuitem>Zoom Out</guimenuitem></menuchoice></term>
+ <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>-</keycap></keycombo></shortcut><guimenuitem>Zoom Out</guimenuitem></menuchoice></term>
<listitem><simpara><action>Zoom out on the editor view</action></simpara></listitem></varlistentry>
<varlistentry>
<term><menuchoice><guimenuitem>Preview</guimenuitem></menuchoice></term>
diff --git a/doc/credits.docbook b/doc/credits.docbook
index e825474..189c784 100644
--- a/doc/credits.docbook
+++ b/doc/credits.docbook
@@ -1,11 +1,13 @@
<chapter id="credits" >
<title>Credits and License</title>
<para>&kapp;</para>
- <para>Program copyright 2002 Stephen P. Allewell <email>sallewell at users.sourceforge.net</email></para>
+ <para>Program copyright 2002-2014 Stephen P. Allewell <email>sallewell at users.sourceforge.net</email></para>
<para>
Contributors:
<itemizedlist>
- <listitem><para></para></listitem>
+ <listitem><para>Pierre Brua <email>kxstitchdev at paralline.com</email>: Bug fixes, application icons</para></listitem>
+ <listitem><para>Eric Pareja <email>xenos at upm.edu.ph</email>: Man page</para></listitem>
+ <listitem><para>Adam Gundy <email>adam at starsilk.net</email>: Bug fixes, improvements</para></listitem>
</itemizedlist>
</para>
<para>
diff --git a/doc/dialogs.docbook b/doc/dialogs.docbook
index 8b5eb1c..e4e45cb 100644
--- a/doc/dialogs.docbook
+++ b/doc/dialogs.docbook
@@ -42,8 +42,8 @@
selected and then the parameters can be adjusted to give the correct color.
</para>
<para>
- Once added this new color will be available to be included in your patterns palette via the 'Add Color'
- dialog. It may also be adjusted by using the 'Floss Calibration' dialog.
+ Once added this new color will be available to be included in your patterns palette via the <guilabel>Add Color</guilabel>
+ dialog. It may also be adjusted by using the <guilabel>Floss Calibration</guilabel> dialog.
</para>
</sect1>
@@ -57,22 +57,22 @@
</para>
<para>
On the left, a pick list of the schemes that are currently available along with a list of colors that
- are in that scheme. The color description will be appended with '(Calibrated)' if the color has been
+ are in that scheme. The color description will be appended with <guilabel>(Calibrated)</guilabel> if the color has been
modified by the current invocation of this dialog.
</para>
<para>
On the right, is the name and description of the currently selected color, this will be appended with
- '(Modified)' if the color has been modified, a preview of the color, and the current RGB values for the color.
+ <guilabel>(Modified)</guilabel> if the color has been modified, a preview of the color, and the current RGB values for the color.
</para>
<para>
- Also shown is a 'Reset Color' button. This will reset the currently selected color to the value it had
+ Also shown is a <guibutton>Reset Color</guibutton> button. This will reset the currently selected color to the value it had
when the dialog was first invoked.
</para>
<para>
- Pressing the 'OK' button will commit all of the changed colors.
+ Pressing the <guibutton>OK</guibutton> button will commit all of the changed colors.
</para>
<para>
- Pressing the 'Cancel' button will restore all the changed colors back to their original values.
+ Pressing the <guibutton>Cancel</guibutton> button will restore all the changed colors back to their original values.
</para>
</sect1>
@@ -89,7 +89,7 @@
elements. The pick lists allow selection of the required format of those elements.
</para>
<para>
- You can return to the default set of parameters using the Default button.
+ You can return to the default set of parameters using the <guibutton>Default</guibutton> button.
</para>
</sect1>
@@ -102,16 +102,16 @@
On the left of the dialog there is a preview of the imported image, based on the parameters on the right.
</para>
<para>
- The floss scheme for the finished pattern can be selected, by default this is the same as the 'New
- Pattern Dialog' defaults. The maximum colors to be used for the pattern can be enabled and changed as
+ The floss scheme for the finished pattern can be selected, by default this is the same as the <guilabel>New
+ Pattern Dialog</guilabel> defaults. The maximum colors to be used for the pattern can be enabled and changed as
required, by default the imported pattern will have as many colors as are defined in the original image
- that are converted to floss colors. Checking the Ignore Color box allows you to click the dropper tool to
+ that are converted to floss colors. Checking the <guilabel>Ignore Color</guilabel> box allows you to click the dropper tool to
select a color in the image that will be ignored on import. This is useful to remove backgrounds that you
don't need converting to stitches. The ignored color will be displayed as a checker board pattern in the preview.
</para>
<para>
- The cloth count value defaults to the 'New Pattern Properties' dialog and the scale is set such that
- the final size is as close to the 'New Pattern Properties' pattern size as possible. These values can be
+ The cloth count value defaults to the <guilabel>New Pattern Properties</guilabel> dialog and the scale is set such that
+ the final size is as close to the <guilabel>New Pattern Properties</guilabel> pattern size as possible. These values can be
changed as required.
</para>
<para>
@@ -119,7 +119,7 @@
effectively doubles the import resolution without affecting the overall size of the pattern.
</para>
<para>
- Clicking 'Import' will convert the image into a pattern.
+ Clicking <guibutton>Import</guibutton> will convert the image into a pattern.
</para>
</sect1>
@@ -136,7 +136,7 @@
<para>
The cloth count is defined in units per centimeter or inches and is dependent on the units of size.
i.e. if CM is selected for the units then cloth count will be in units per centimeter, similarly for inches.
- if the Stitches unit is selected then the cloth count units will remain as the last CM or inches value.
+ if the <guilabel>Stitches unit</guilabel> is selected then the cloth count units will remain as the last CM or inches value.
</para>
<para>
The Title, Author, Copyright and Fabric fields are free text, so you can enter anything you like
@@ -148,11 +148,11 @@
defined yourself.
</para>
<para>
- The 'Set as default' checkbox will save the current values which will then be used as defaults
+ The <guilabel>Set as default</guilabel> checkbox will save the current values which will then be used as defaults
for all new patterns.
</para>
<para>
- The Instructions tab can be used to enter any specific instructions for sewing the pattern.
+ The <guilabel>Instructions</guilabel> tab can be used to enter any specific instructions for sewing the pattern.
</para>
</sect1>
@@ -187,11 +187,11 @@
keyboard character. The baseline is used to position the character pattern vertically relative to the cursor position
when using the Alphabet tool. Positive values move it down, negative values move it up. The associated character is
only required for use with the Alphabet tool. After clicking in the associated character text box, the next key press, including
- modifiers (Shift, Ctrl, etc) is used as the key.
+ modifiers (&Shift;, &Ctrl;, &etc;) is used as the key.
</para>
<para>
Create new libraries by clicking the &RMB; on either an existing category, to create a sub category, or on a blank area of the library
- list, for a new top level category, and select the New Category option, enter the name and click OK.
+ list, for a new top level category, and select the <guimenuitem>New Category</guimenuitem> option, enter the name and click <guibutton>OK</guibutton>.
</para>
<para>
Creating a new library pattern by selecting an area in the pattern editor, select copy, then use the &RMB; on an existing category
@@ -209,7 +209,7 @@
<screenshot><mediaobject><imageobject><imagedata fileref="text-tool-dialog.png" format="PNG" /></imageobject></mediaobject></screenshot>
</para>
<para>
- The text dialog allows you to select a font and size, then enter the text. Clicking OK closes the
+ The text dialog allows you to select a font and size, then enter the text. Clicking <guibutton>OK</guibutton> closes the
dialog and returns you to the &kapp; window. Positioning the text is the same as pasting any other
element. Press the &LMB; on the canvas roughly where you want the text, this will show a preview of
the text, position the text exactly where you want it, then release the &LMB;
@@ -221,7 +221,7 @@
<title>Extend Pattern Dialog</title>
<para>
This is used to extend the pattern in various directions by a number of cells. Enter the number of cells in the spin boxes and
- press OK to extend the pattern.
+ press <guibutton>OK</guibutton> to extend the pattern.
</para>
<screenshot><mediaobject><imageobject><imagedata fileref="extend-pattern-dialog.png" format="PNG" /></imageobject></mediaobject></screenshot>
</sect1>
@@ -314,7 +314,7 @@
<sect2 id="KeyElement" >
<title>Key Element</title>
<para>
- The key element shows the flosses used. The properties dialog allows the selection of the fields that can be displayed. The 'First element' and 'No. elements'
+ The key element shows the flosses used. The properties dialog allows the selection of the fields that can be displayed. The <guilabel>First element</guilabel> and <guilabel>No. elements</guilabel>
can be used for large keys that may span multiple pages and allows some symbols to be on one page and others to be on another page.
<screenshot><mediaobject><imageobject><imagedata fileref="key-element-properties-dialog.png" format="PNG" /></imageobject></mediaobject></screenshot>
<screenshot><mediaobject><imageobject><imagedata fileref="key-element.png" format="PNG" /></imageobject></mediaobject></screenshot>
diff --git a/doc/patterns.docbook b/doc/patterns.docbook
index 34a7381..5b75b54 100644
--- a/doc/patterns.docbook
+++ b/doc/patterns.docbook
@@ -5,13 +5,13 @@
<title>Starting &kapp;</title>
<para>
When starting &kapp; you will be presented with a blank canvas of the default
- size. This is also the case when selecting <guimenu>File</guimenu><guimenuitem>New</guimenuitem>.
+ size. This is also the case when selecting <menuchoice><guimenu>File</guimenu><guimenuitem>New</guimenuitem></menuchoice>.
The default sizes can be set in the pattern properties dialog by enabling the set as default checkbox.
</para>
<para>
If the default size is not suitable for your planned pattern, you can use
- the <guimenu>File</guimenu><guimenuitem>Properties</guimenuitem> dialog to change it.
- Adjust the values as required and after clicking on OK, the pattern will be resized to suit.
+ the <menuchoice><guimenu>File</guimenu><guimenuitem>File Properties</guimenuitem></menuchoice> dialog to change it.
+ Adjust the values as required and after clicking on <guibutton>OK</guibutton>, the pattern will be resized to suit.
</para>
</sect1>
@@ -30,11 +30,11 @@
pattern.
</para>
<para>
- Checking the Use fractionals checkbox will enable the use of fractional stitches to give more
+ Checking the <guilabel>Use fractionals</guilabel> checkbox will enable the use of fractional stitches to give more
detail for any given pattern size.
</para>
<para>
- Checking the ignore color checkbox will allow the selection of a color within the image which will then be considered
+ Checking the <guilabel>Ignore color</guilabel> checkbox will allow the selection of a color within the image which will then be considered
as the transparent color and ignored during the import.
</para>
</sect1>
@@ -48,7 +48,7 @@
<para>
The image is normally scaled to cover the entire pattern grid. This may not be suitable, therefore
you can use the select tool to select an area that you want to cover and then select the
- <guimenu>Pattern</guimenu> <guimenuitem>Fit background to selection</guimenuitem>. This will
+ <menuchoice><guimenu>Pattern</guimenu> <guimenuitem>Fit background to selection</guimenuitem></menuchoice>. This will
rescale the image to fit within the selected area. You can continue doing this until you are happy
with the result, even after you have started adding stitches.
</para>
@@ -72,7 +72,7 @@
</para>
<para>
Adding new category headings can be done with a &RMB; on either an existing entry, to create a sub category, or on a blank space on
- the library list, to create a new root entry, and selecting the New Category option. Enter the name of the category and click OK.
+ the library list, to create a new root entry, and selecting the <guimenuitem>New Category</guimenuitem> option. Enter the name of the category and click <guibutton>OK</guibutton>.
</para>
<para>
Creating a new library pattern is done by selecting an area of your working pattern, copying and pasting to one of the existing categories.
diff --git a/doc/ui.docbook b/doc/ui.docbook
index dfc8d71..c1968d7 100644
--- a/doc/ui.docbook
+++ b/doc/ui.docbook
@@ -47,7 +47,7 @@
</para>
<para>
A menu option allows you to add background images to the editor window, to use as a template for
- adding stitches. For more details see the section on Creating Patterns.
+ adding stitches. For more details see the section on <link linkend="creatingpatterns">Creating Patterns</link>.
</para>
<sect2 id="kxstitch-editor-context" >
<title>Context Menu</title>
More information about the kde-doc-english
mailing list