Skip to content

Commit

Permalink
Fix all reference entries
Browse files Browse the repository at this point in the history
Used filename and where needed added an additional
reference where it would be quite easy ti get confused.

The first entry is the same as the file, the others use
HTML like syntax
  • Loading branch information
dwaynebailey committed Oct 30, 2012
1 parent 7a22c28 commit 7dce5d8
Show file tree
Hide file tree
Showing 113 changed files with 214 additions and 198 deletions.
105 changes: 53 additions & 52 deletions docs/changelog.rst

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/commands/csv2po.rst
@@ -1,5 +1,5 @@

.. _csv2po#csv2po_and_po2csv:
.. _csv2po:

csv2po and po2csv
*****************
Expand Down
2 changes: 1 addition & 1 deletion docs/commands/csv2tbx.rst
@@ -1,5 +1,5 @@

.. _csv2tbx#csv2tbx:
.. _csv2tbx:

csv2tbx
*******
Expand Down
2 changes: 1 addition & 1 deletion docs/commands/general_usage.rst
@@ -1,5 +1,5 @@

.. _general_usage#general_usage:
.. _general_usage:

General Usage
*************
Expand Down
2 changes: 1 addition & 1 deletion docs/commands/html2po.rst
@@ -1,5 +1,5 @@

.. _html2po#html2po_and_po2html:
.. _html2po:

html2po and po2html
*******************
Expand Down
2 changes: 1 addition & 1 deletion docs/commands/ical2po.rst
@@ -1,5 +1,5 @@

.. _ical2po#ical2po:
.. _ical2po:

ical2po
*******
Expand Down
12 changes: 7 additions & 5 deletions docs/commands/index.rst
@@ -1,4 +1,6 @@
.. _index#converters:
.. _commands:

.. _commands#converters:

Converters
**********
Expand Down Expand Up @@ -72,14 +74,14 @@ that will make the converters much easier to use and understand.
* :doc:`ts2po <ts2po>` - Qt Linguist .ts converter
* :doc:`xliff2po <xliff2po>` - XLIFF (XML Localisation Interchange File Format) converter

.. _index#tools:
.. _commands#tools:

Tools
*****

The PO tools allow you to manipulate and work with PO files

.. _index#quality_assurance:
.. _commands#quality_assurance:

Quality Assurance
=================
Expand All @@ -105,7 +107,7 @@ These tools are especially useful for measuring and improving translation qualit
* :doc:`porestructure` - restructures PO files according to poconflict directives
* :doc:`junitmsgfmt` - run msgfmt and provide JUnit type output for use in continuous integration systems like Hudson and Jenkins

.. _index#other_tools:
.. _commands#other_tools:

Other tools
===========
Expand Down Expand Up @@ -138,7 +140,7 @@ Other tools
* :doc:`pretranslate` - fill any missing translations from translation memory via fuzzy matching.
* :doc:`levenshtein_distance` - edit distance algorithms for translation memory matching

.. _index#scripts:
.. _commands#scripts:

Scripts
*******
Expand Down
2 changes: 1 addition & 1 deletion docs/commands/ini2po.rst
@@ -1,5 +1,5 @@

.. _ini2po#ini2po:
.. _ini2po:

ini2po
******
Expand Down
2 changes: 1 addition & 1 deletion docs/commands/json2po.rst
@@ -1,5 +1,5 @@

.. _json2po#json2po:
.. _json2po:

json2po
*******
Expand Down
2 changes: 1 addition & 1 deletion docs/commands/junitmsgfmt.rst
@@ -1,5 +1,5 @@

.. _junitmsgfmt#junitmsgfmt:
.. _junitmsgfmt:

junitmsgfmt
***********
Expand Down
2 changes: 1 addition & 1 deletion docs/commands/levenshtein_distance.rst
@@ -1,5 +1,5 @@

.. _levenshtein_distance#levenshtein_distance:
.. _levenshtein_distance:

Levenshtein distance
********************
Expand Down
2 changes: 1 addition & 1 deletion docs/commands/moz-l10n-builder.rst
@@ -1,5 +1,5 @@

.. _moz-l10n-builder#moz-l10n-builder:
.. _moz-l10n-builder:

moz-l10n-builder
****************
Expand Down
2 changes: 1 addition & 1 deletion docs/commands/moz2po.rst
@@ -1,5 +1,5 @@

.. _moz2po#moz2po_and_po2moz:
.. _moz2po:

moz2po and po2moz
*****************
Expand Down
2 changes: 1 addition & 1 deletion docs/commands/mozilla_l10n_scripts.rst
@@ -1,5 +1,5 @@

.. _mozilla_l10n_scripts#mozilla_l10n_scripts:
.. _mozilla_l10n_scripts:

Mozilla L10n Scripts
********************
Expand Down
2 changes: 1 addition & 1 deletion docs/commands/odf2xliff.rst
@@ -1,5 +1,5 @@

.. _odf2xliff#odf2xliff_and_xliff2odf:
.. _odf2xliff:

odf2xliff and xliff2odf
***********************
Expand Down
2 changes: 1 addition & 1 deletion docs/commands/oo2po.rst
@@ -1,5 +1,5 @@

.. _oo2po#oo2po_and_po2oo:
.. _oo2po:

oo2po and po2oo
***************
Expand Down
2 changes: 1 addition & 1 deletion docs/commands/option_accelerator.rst
@@ -1,5 +1,5 @@

.. _accelerator_accelerator#--accelerator=accelerator:
.. _option_accelerator:

--accelerator=ACCELERATOR
*************************
Expand Down
6 changes: 3 additions & 3 deletions docs/commands/option_duplicates.rst
@@ -1,5 +1,5 @@

.. _duplicates_duplicatestyle#--duplicates=duplicatestyle:
.. _option_duplicates:

--duplicates=DUPLICATESTYLE
***************************
Expand All @@ -10,7 +10,7 @@ Also affected are conversions in which the source format is empty (allowing poss

Previously the tools used msgid_comment (KDE style comments) to disambiguate text. However, with the release of Gettext 0.15, the new msgctxt disambiguation is now recommended, especially if you wish to use your files with other Gettext the tools. Many other pieces of software now also support this feature, and will probably become the best choice for almost all circumstances. It is the default in our converters.

.. _duplicates_duplicatestyle#merge:
.. _option_duplicates#merge:

merge
=====
Expand All @@ -36,7 +36,7 @@ If however the source text is blank (these are often configuration options in Mo
msgid "_: file1.dtd:translators_email\n"
msgstr ""
.. _duplicates_duplicatestyle#msgctxt:
.. _option_duplicates#msgctxt:

msgctxt (default)
=================
Expand Down
10 changes: 5 additions & 5 deletions docs/commands/option_errorlevel.rst
@@ -1,19 +1,19 @@

.. _errorlevel_errorlevel#--errorlevel=errorlevel:
.. _option_errorlevel:

--errorlevel=ERRORLEVEL
***********************

This is a parameter that can be passed to most of the programs in the translate toolkit in order to choose the level of feedback that you need when errors occur. It is mostly useful for debugging. Please report your errors to the developers with --errorlevel=traceback.

.. _errorlevel_errorlevel#none:
.. _option_errorlevel#none:

none
====

Display no error messages

.. _errorlevel_errorlevel#message:
.. _option_errorlevel#message:

message
=======
Expand All @@ -24,7 +24,7 @@ Display on the error message

An error occurred processing PO file

.. _errorlevel_errorlevel#exception:
.. _option_errorlevel#exception:

exception
=========
Expand All @@ -35,7 +35,7 @@ Give the error message and name and Python exception

ValueError: An error occurred processing PO file

.. _errorlevel_errorlevel#traceback:
.. _option_errorlevel#traceback:

traceback
=========
Expand Down
10 changes: 5 additions & 5 deletions docs/commands/option_filteraction.rst
@@ -1,31 +1,31 @@

.. _filteraction_action#--filteraction=action:
.. _option_filteraction:

--filteraction=ACTION
*********************

.. _filteraction_action#none_default:
.. _option_filteraction#none_default:

none (default)
==============

Take no action. Messages from failing test will appear in the output file

.. _filteraction_action#warn:
.. _option_filteraction#warn:

warn
====

Print a warning but otherwise include the message in the output file.

.. _filteraction_action#exclude-serious:
.. _option_filteraction#exclude-serious:

exclude-serious
===============

Only exclude errors that are listed as serious by the convertor. All other are included.

.. _filteraction_action#exclude-all:
.. _option_filteraction#exclude-all:

exclude-all
===========
Expand Down
8 changes: 4 additions & 4 deletions docs/commands/option_multifile.rst
@@ -1,5 +1,5 @@

.. _multifile_multifilestyle#--multifile=multifilestyle:
.. _option_multifile:

--multifile=MULTIFILESTYLE
**************************
Expand All @@ -8,21 +8,21 @@ This options determines how the POT/PO files are spli from the source files. In
you have source files that generate either too many small files or one large files which you would rather see
split up into smaller files.

.. _multifile_multifilestyle#single:
.. _option_multifile#single:

single
======

Output individual files.

.. _multifile_multifilestyle#toplevel:
.. _option_multifile#toplevel:

toplevel
========

Split the source files at the top level. Ie you see a number of top level files.

.. _multifile_multifilestyle#onefiles:
.. _option_multifile#onefiles:

onefiles
========
Expand Down
12 changes: 6 additions & 6 deletions docs/commands/option_personality.rst
@@ -1,10 +1,10 @@

.. _personality_type#--personality=type:
.. _option_personality:

--personality=TYPE
******************

.. _personality_type#java_default:
.. _option_personality#java_default:

java (default)
==============
Expand All @@ -17,7 +17,7 @@ Will appear as follows in the output .properties file::

\u1E7D\u1E01\u1E3D\u1E7B\u1E1D

.. _personality_type#mozilla:
.. _option_personality#mozilla:

mozilla
=======
Expand All @@ -26,21 +26,21 @@ Mozilla has made slight adjustments to the Java .properties spec. Mozilla will

Of course this style of file is only used by Mozilla and should not be used for other projects that follow the Java spec more strictly.

.. _personality_type#skype:
.. _option_personality#skype:

skype
=====

Skype .lang files are .properties files in UTF-16. The & is used as an accelerator (marked in the PO header).

.. _personality_type#flex:
.. _option_personality#flex:

flex
====

Flex follows the Mozilla approach, a UTF-8 encoded file with no escaped unicode. We include it as its own dialect for ease of use.

.. _personality_type#strings:
.. _option_personality#strings:

strings
=======
Expand Down
12 changes: 6 additions & 6 deletions docs/commands/option_progress.rst
@@ -1,5 +1,5 @@

.. _progress_progress#--progress=progress:
.. _option_progress:

--progress=PROGRESS
*******************
Expand All @@ -8,7 +8,7 @@ All of the programs can give visual feedback. This options allows you to select

In the examples we are converting and OpenOffice.org 2.0 sdf/gsi file into POT files using :doc:`oo2po <oo2po>`.

.. _progress_progress#none:
.. _option_progress#none:

none
====
Expand All @@ -21,7 +21,7 @@ want feedback to interfere with the operation.
[dwayne@laptop OOo20]$ oo2po -P --progress=none en-US.sdf pot
[dwayne@laptop OOo20]$
.. _progress_progress#dots:
.. _option_progress#dots:

dots
====
Expand All @@ -36,7 +36,7 @@ Use visual dots to represent progress. Each dot represent a file that has been
.........................................
[dwayne@laptop OOo20]$
.. _progress_progress#bar_default:
.. _option_progress#bar_default:

bar (default)
=============
Expand All @@ -55,7 +55,7 @@ This is the default mode of operation, therefore this command would create the s
[dwayne@laptop OOo20]$ oo2po -P en-US.sdf pot
.. _progress_progress#verbose:
.. _option_progress#verbose:
verbose
=======
Expand All @@ -79,7 +79,7 @@ Combine the hash (#) progress bar form the *bar* option with the actual names of
filter/source/xsltdialog.oo
[## ] 5%
.. _progress_progress#names:
.. _option_progress#names:
names
=====
Expand Down

0 comments on commit 7dce5d8

Please sign in to comment.