-#LyX 1.4.0cvs created this file. For more info see http://www.lyx.org/
-\lyxformat 245
+#LyX 1.6.0 created this file. For more info see http://www.lyx.org/
+\lyxformat 345
\begin_document
\begin_header
\textclass article
+\use_default_options false
\language english
\inputencoding latin1
-\fontscheme default
+\font_roman default
+\font_sans default
+\font_typewriter default
+\font_default_family default
+\font_sc false
+\font_osf false
+\font_sf_scale 100
+\font_tt_scale 100
\graphics dvips
\paperfontsize 12
\spacing single
+\use_hyperref false
\papersize default
\use_geometry false
\use_amsmath 0
+\use_esint 0
\cite_engine basic
\use_bibtopic false
\paperorientation portrait
\papersides 1
\paperpagestyle plain
\tracking_changes false
-\output_changes true
+\output_changes false
+\author ""
+\author ""
\end_header
\begin_body
\labelwidthstring MMMMMMMM
\family sans
-Sans\InsetSpace ~
+Sans
+\begin_inset space ~
+\end_inset
+
Serif
\family default
menu, button, or popup names, the names/lables of all widgets in a popup,
\labelwidthstring MMMMMMMM
\noun on
-Noun\InsetSpace ~
+Noun
+\begin_inset space ~
+\end_inset
+
Style
\noun default
people's names
\bar under
U
\bar default
-nderlined\InsetSpace ~
-Sans\InsetSpace ~
+nderlined
+\begin_inset space ~
+\end_inset
+
+Sans
+\begin_inset space ~
+\end_inset
+
Serif
\family default
Rich Fields added this to mimick the underlining of letters in the menus
\emph default
shut off the underlining.
Too many people send in things that look like:
-\newline
+\begin_inset Newline newline
+\end_inset
+
\family sans
\bar under
\family default
\bar default
his
-\newline
+\begin_inset Newline newline
+\end_inset
+
\SpecialChar \ldots{}
-i.\InsetSpace ~
-e.\InsetSpace ~
+i.
+\begin_inset space ~
+\end_inset
+
+e.
+\begin_inset space ~
+\end_inset
+
they not only shut off underlining, they turned off
\family sans
-Sans\InsetSpace ~
+Sans
+\begin_inset space ~
+\end_inset
+
Serif
\family default
, too!
\emph default
Make sure the entire word is still in
\family sans
-Sans\InsetSpace ~
+Sans
+\begin_inset space ~
+\end_inset
+
Serif
\family default
after you shut off the underlining.
\bar under
M
\bar default
-ath\InsetSpace ~
+ath
+\begin_inset space ~
+\end_inset
+
mode
\family default
is a menu item in the
\family default
menu, so it appears in
\family sans
-Sans\InsetSpace ~
+Sans
+\begin_inset space ~
+\end_inset
+
Serif
\family default
.
\bar under
U
\bar default
-nderlined\InsetSpace ~
-Sans\InsetSpace ~
+nderlined
+\begin_inset space ~
+\end_inset
+
+Sans
+\begin_inset space ~
+\end_inset
+
Serif
\family default
for the accelerator keys.
\family default
, is in
\family sans
-Sans\InsetSpace ~
+Sans
+\begin_inset space ~
+\end_inset
+
Serif
\family default
, but
\emph on
Roman Italics
\emph default
- (i.e.
+ (i.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
emphasized).
This is a case where you don't use
\family typewriter
\begin_inset Foot
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
Same goes for
\begin_inset Quotes eld
\end_inset
\family default
key is, et cetera.
The user isn't stupid.
- Also, someone will document anything that isn't clear (e.\InsetSpace ~
-g.\InsetSpace ~
+ Also, someone will document anything that isn't clear (e.
+\begin_inset space ~
+\end_inset
+
+g.
+\begin_inset space ~
+\end_inset
+
the
\family sans
Meta
\begin_layout Standard
Exception: you're writing an Author's Note (see section
-\begin_inset LatexCommand \ref{sec:author-notes}
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:author-notes"
\end_inset
\end_layout
\begin_layout Description
-Multi-word\InsetSpace ~
+Multi-word
+\begin_inset space ~
+\end_inset
+
names Use a
\family sans
-Protected\InsetSpace ~
+Protected
+\begin_inset space ~
+\end_inset
+
Blank
\family default
between the words for menu and widget names.
- E.\InsetSpace ~
+ E.
+\begin_inset space ~
+\end_inset
+
g.:
\family sans
-Save\InsetSpace ~
+Save
+\begin_inset space ~
+\end_inset
+
As
\family default
, not
\family default
as well as
\family sans
-Sans\InsetSpace ~
+Sans
+\begin_inset space ~
+\end_inset
+
Serif
\family default
, with one caveat.
\family default
, put that in a
\family sans
-LyX\InsetSpace ~
+LyX
+\begin_inset space ~
+\end_inset
+
Code
\family default
environment.
\begin_layout Standard
I want the
\family sans
-Protected\InsetSpace ~
+Protected
+\begin_inset space ~
+\end_inset
+
Blank
\family default
so that the name doesn't get split between two lines, which is visually
disruptive.
If something with a
\family sans
-Protected\InsetSpace ~
+Protected
+\begin_inset space ~
+\end_inset
+
Blank
\family default
is near the end of a line and overflows the margin, use a
\end_deeper
\begin_layout Description
-Special\InsetSpace ~
+Special
+\begin_inset space ~
+\end_inset
+
Terms These are things like the following:
\end_layout
\begin_layout Itemize
\family sans
-Table\InsetSpace ~
+Table
+\begin_inset space ~
+\end_inset
+
Float
\end_layout
\begin_layout Itemize
\family sans
-Figure\InsetSpace ~
+Figure
+\begin_inset space ~
+\end_inset
+
Float
\end_layout
\begin_layout Standard
Use
\family sans
-Sans\InsetSpace ~
+Sans
+\begin_inset space ~
+\end_inset
+
Serif
\family default
font and, in the case of
\family sans
-HFill
+HFill
\family default
-and
+ and
\family sans
VFill
\family default
is familiar with, but which the new LyX user is not.
I want them to stand out from the rest of the text, hence the use of
\family sans
-Sans\InsetSpace ~
+Sans
+\begin_inset space ~
+\end_inset
+
Serif
\family default
for them.
\end_layout
\begin_layout Itemize
-PostScript® is a registered trademark of Adobe Corp.
+PostScript® is a registered trademark of Adobe Corp.
\emph on
-You must put the ® after it or we'll get sued!
+You must put the ® after it or we'll get sued!
\emph default
I also want it written as seen here, always capitalized.
Not
\begin_inset Quotes eld
\end_inset
-postscript®,
+postscript®,
\begin_inset Quotes erd
\end_inset
\begin_inset Quotes eld
\end_inset
-Postscript®
+Postscript®
\begin_inset Quotes erd
\end_inset
\begin_inset Quotes eld
\end_inset
-PostScript®
+PostScript®
\begin_inset Quotes erd
\end_inset
- - both of them capitalized, in the default font (i.\InsetSpace ~
-.e.\InsetSpace ~
+ - both of them capitalized, in the default font (i.
+\begin_inset space ~
+\end_inset
+
+.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space ~
+\end_inset
+
Roman).
If you must, cut and paste it from here.
\end_layout
\size larger
\emph on
-You must put the ® after PostScript® or we'll get sued!
+You must put the ® after PostScript® or we'll get sued!
\end_layout
\begin_layout Standard
\emph on
major trouble
\emph default
- by forgetting that ®.
+ by forgetting that ®.
So, don't.
Got it?
\end_layout
\end_deeper
\begin_layout Itemize
Similarly, if you use any other registered trademark in any documentation,
- put the ® after it, too.
+ put the ® after it, too.
\end_layout
\begin_layout Description
-Menu\InsetSpace ~
+Menu
+\begin_inset space ~
+\end_inset
+
Items When quick-referencing an item in a menu, use the menu separator:
\begin_inset Quotes eld
and that it's in
\family sans
-Sans\InsetSpace ~
+Sans
+\begin_inset space ~
+\end_inset
+
Serif
\family default
, just like the menu and item names.
is to prevent LyX from splitting terms across lines.
The same goes for using
\family sans
-Protected\InsetSpace ~
+Protected
+\begin_inset space ~
+\end_inset
+
Blank
\family default
s between multi-word terms.
a
\bar default
per\SpecialChar \menuseparator
-Paper\InsetSpace ~
+Paper
+\begin_inset space ~
+\end_inset
+
Dialog
\family default
\family sans
-Paper\InsetSpace ~
+Paper
+\begin_inset space ~
+\end_inset
+
Dialog\SpecialChar \menuseparator
P
\bar under
\end_deeper
\end_deeper
\begin_layout Description
-Note\InsetSpace ~
-Boxes LyX has a feature for adding comments that appear only within
- the LyX GUI.
+Note
+\begin_inset space ~
+\end_inset
+
+Boxes LyX has a feature for adding comments that appear only within the
+ LyX GUI.
Here's one:
\begin_inset Note Note
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
These should NEVER appear in the manuals.
\end_layout
If you have a parenthetical comment you want to make, the reader should
see it too, even in the printed version.
Use an Author's Note (see section
-\begin_inset LatexCommand \ref{sec:author-notes}
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:author-notes"
\end_inset
\begin_inset Quotes erd
\end_inset
-,\InsetSpace ~
+,
+\begin_inset space ~
+\end_inset
+
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
-\InsetSpace ~
-and\InsetSpace ~
+
+\begin_inset space ~
+\end_inset
+
+and
+\begin_inset space ~
+\end_inset
+
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
-, is used only within quotations (see section\InsetSpace ~
+, is used only within quotations (see section
+\begin_inset space ~
+\end_inset
+
-\begin_inset LatexCommand \ref{sec:quote}
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:quote"
\end_inset
\labelwidthstring 00.00.0000
\family typewriter
-Intro.lyx
+Intro.lyx
\family default
-Please, don't touch this file.
+ Please, don't touch this file.
It's essentially complete, anyhow.
Only the editor(s) should make changes to this, as this file contains info
about how to contribute to the doc project.
\labelwidthstring 00.00.0000
\family typewriter
-UserGuide.lyx
+UserGuide.lyx
\family default
-This file is complete.
+ This file is complete.
Any changes should be for updates
\emph on
only
version of the LyX manuals.
The translation efforts require have their own set of guidelines.
See section
-\begin_inset LatexCommand \ref{sec:translations}
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:translations"
\end_inset
\begin_layout Subsection
Wearing Many Hats:
-\newline
-Commentary from the Author (i.\InsetSpace ~
+\begin_inset Newline newline
+\end_inset
+
+Commentary from the Author (i.
+\begin_inset space ~
+\end_inset
+
e.: You)
\end_layout
\begin_layout Standard
-\begin_inset LatexCommand \label{sec:author-notes}
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:author-notes"
\end_inset
\end_layout
\begin_layout Subsubsection
-Personal\InsetSpace ~
+Personal
+\begin_inset space ~
+\end_inset
+
Notes: The
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
- hat, i.\InsetSpace ~
-e.\InsetSpace ~
+ hat, i.
+\begin_inset space ~
+\end_inset
+
+e.
+\begin_inset space ~
+\end_inset
+
to speak for yourself instead of for the LyX Team.
\end_layout
\end_layout
\begin_layout Subsubsection
-Author's\InsetSpace ~
+Author's
+\begin_inset space ~
+\end_inset
+
Notes: The
\begin_inset Quotes eld
\end_inset
\begin_layout Itemize
Personal Notes:
-\newline
+\begin_inset Newline newline
+\end_inset
+
A
\emph on
short
opinion --- yours or another LyX developer's --- about anything.
Anywhere in the manuals you wish to speak for yourself instead the the
LyX Team, use this.
- If you have a long rant, however, quote yourself (see section\InsetSpace ~
+ If you have a long rant, however, quote yourself (see section
+\begin_inset space ~
+\end_inset
-\begin_inset LatexCommand \ref{sec:quote}
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:quote"
\end_inset
\begin_layout Itemize
Author's Note:
-\newline
-Use this to describe things in LyX (or the manuals) that may
- change in the future or are somehow incomplete.
+\begin_inset Newline newline
+\end_inset
+
+Use this to describe things in LyX (or the manuals) that may change in the
+ future or are somehow incomplete.
Author's Notes are supposed to disappear as a manual matures.
\end_layout
\begin_layout Itemize
Plain Footnotes:
-\newline
-Used for text fragments that almost fit into the flow of
- the text\SpecialChar \ldots{}
-but not quite.
+\begin_inset Newline newline
+\end_inset
+
+Used for text fragments that almost fit into the flow of the text\SpecialChar \ldots{}
+but not
+ quite.
\end_layout
\begin_layout Standard
\end_deeper
\begin_layout Subsubsection
-\begin_inset LatexCommand \label{sec:quote}
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:quote"
\end_inset
The quoting rules for English (well, American English, at least) are outlined
in the following
\family sans
-Figure\InsetSpace ~
+Figure
+\begin_inset space ~
+\end_inset
+
Float
\family default
, for your convenience.
sideways false
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
Quoting rules for English:
\end_layout
\end_layout
\begin_layout Itemize
-For missing words (e.\InsetSpace ~
-g.\InsetSpace ~
+For missing words (e.
+\begin_inset space ~
+\end_inset
+
+g.
+\begin_inset space ~
+\end_inset
+
\begin_inset Quotes eld
\end_inset
\begin_layout Enumerate
Be
\emph on
-clear, concise,
+clear, concise,
\emph default
-and
+ and
\emph on
to the point
\emph default
John Weiss
\noun default
:
-\newline
+\begin_inset Newline newline
+\end_inset
+
I've had people only document one popup --- literally.
This added off-topic information and only described half of the feature,
since other menus, popups, and even unbound functions contained additional
stuff.
-\newline
+\begin_inset Newline newline
+\end_inset
+
I got
\emph on
really
\emph default
cranky when that happens, because it means
\emph on
-I
+I
\emph default
-ended up fixing it.
+ ended up fixing it.
Bad help is worse than no help at all.
\end_layout
\end_layout
\begin_layout Standard
-\begin_inset LatexCommand \label{sec:english-only}
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:english-only"
\end_inset
-When contributing to the primary --- i.\InsetSpace ~
-e.\InsetSpace ~
-the English language version ---
- of the LyX manuals, keep the following in mind.
+When contributing to the primary --- i.
+\begin_inset space ~
+\end_inset
+
+e.
+\begin_inset space ~
+\end_inset
+
+the English language version --- of the LyX manuals, keep the following
+ in mind.
\end_layout
\begin_layout Subsubsection
\begin_deeper
\begin_layout Standard
-Using passive voice is generally considered bad style in the U.\InsetSpace ~
-S.\InsetSpace ~
-as it is
- too easy to obfuscate your words with it.
+Using passive voice is generally considered bad style in the U.
+\begin_inset space ~
+\end_inset
+
+S.
+\begin_inset space ~
+\end_inset
+
+as it is too easy to obfuscate your words with it.
It also bloats sentences, often unnecessarily.
\end_layout
\begin_layout Standard
Those of you contributing to a translation of the LyX manuals must follow
a modified set of rules.
- The first few rules are analogous to those in section\InsetSpace ~
+ The first few rules are analogous to those in section
+\begin_inset space ~
+\end_inset
-\begin_inset LatexCommand \ref{sec:english-only}
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:english-only"
\end_inset
\begin_layout Standard
Everything in this manual ---
\emph on
-except section\InsetSpace ~
+except section
+\begin_inset space ~
+\end_inset
+
-\begin_inset LatexCommand \ref{sec:english-only}
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:english-only"
\end_inset
\end_layout
\begin_layout Standard
-\begin_inset LatexCommand \label{sec:accuracy}
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:accuracy"
\end_inset
\end_layout
\begin_layout Itemize
-Omitting any feature description is
+Omitting any feature description is
\emph on
- stricly forbidden
+stricly forbidden
\emph default
.
\end_layout
cannot
\emph default
outpace the original.
-\newline
-If no one has documented new feature in the primary
- LyX manuals (i.\InsetSpace ~
-e.\InsetSpace ~
+\begin_inset Newline newline
+\end_inset
+
+If no one has documented new feature in the primary LyX manuals (i.
+\begin_inset space ~
+\end_inset
+
+e.
+\begin_inset space ~
+\end_inset
+
the English versions), do not do so in the translations.
If you're really looking for something to do, either:
\end_layout
\begin_layout Itemize
\SpecialChar \ldots{}
focus on translating something you haven't yet,
-\newline
+\begin_inset Newline newline
+\end_inset
+
OR
\end_layout
\begin_layout Standard
There may be special cases where omitting part of a sentence or paragraph
- violates rule\InsetSpace ~
+ violates rule
+\begin_inset space ~
+\end_inset
-\begin_inset LatexCommand \ref{sec:accuracy}
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:accuracy"
\end_inset
\begin_layout Enumerate
Name the file:
-\newline
+\begin_inset Newline newline
+\end_inset
+
\family typewriter
DocStyle_Supplement_<cn>.lyx
\family default
-\newline
+\begin_inset Newline newline
+\end_inset
+
\SpecialChar \ldots{}
where
\begin_inset Quotes eld
\begin_inset Foot
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
Specifically, check the settings in the
\family sans
Document Layout
\family typewriter
Documentation Project Style Sheet:
-\newline
+\begin_inset Newline newline
+\end_inset
+
Supplement for the <foo> Translation Project
\end_layout
\begin_layout Itemize
Roman
-\newline
+\begin_inset Newline newline
+\end_inset
+
\emph on
Emphasized (actually Italics)
\end_inset
fonts,
-\newline
+\begin_inset Newline newline
+\end_inset
+
or
-\newline
+\begin_inset Newline newline
+\end_inset
+
What to do when a font doesn't exist:
\end_layout
\labelwidthstring MMMMMMMM
\noun on
-Noun\InsetSpace ~
+Noun
+\begin_inset space ~
+\end_inset
+
Style
\noun default
This is for people's names.
\labelwidthstring MMMMMMMM
\family sans
-Sans\InsetSpace ~
+Sans
+\begin_inset space ~
+\end_inset
+
Serif
\family default
Pick any other font that is different from the ones you're using in place
\bar under
U
\bar default
-nderlined\InsetSpace ~
-Sans\InsetSpace ~
+nderlined
+\begin_inset space ~
+\end_inset
+
+Sans
+\begin_inset space ~
+\end_inset
+
Serif
\family default
Don't worry about this one.
\begin_layout Standard
English has its own typography and style for quoting others.
- The Style Sheet describes that typography in section\InsetSpace ~
+ The Style Sheet describes that typography in section
+\begin_inset space ~
+\end_inset
-\begin_inset LatexCommand \ref{sec:quote}
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:quote"
\end_inset
Your language also has a specific typography and style for quotations.
Describe that style in this section of the Supplement, too.
Naturally, you do not need to go overboard.
- Section\InsetSpace ~
+ Section
+\begin_inset space ~
+\end_inset
+
-\begin_inset LatexCommand \ref{sec:quote}
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:quote"
\end_inset
\begin_layout Standard
This sentence will be tricky to translate, since it contains non-translatable
connotations.
- Therefore, create a
+ Therefore, create a
\family sans
- Subsection
+Subsection
\family default
for this issue in your
\begin_inset Quotes eld
Try and find parts of the original manuals where some friendly but firm
convincing does not translate properly.
Use these cases as the basis for examples of the problem.
- Be sure to then offer a solution (i.\InsetSpace ~
-e.\InsetSpace ~
-how you want such sentences translated.)
- If stumped, ask for help on the LyX Developer's List.
+ Be sure to then offer a solution (i.
+\begin_inset space ~
+\end_inset
+
+e.
+\begin_inset space ~
+\end_inset
+
+how you want such sentences translated.) If stumped, ask for help on the
+ LyX Developer's List.
\end_layout
\begin_layout Subsubsection
projects / lyx.git / blobdiff