#LyX 1.4.0cvs created this file. For more info see http://www.lyx.org/
-\lyxformat 243
+\lyxformat 245
\begin_document
\begin_header
\textclass article
\paragraph_separation indent
\defskip medskip
\quotes_language english
-\quotes_times 2
\papercolumns 1
\papersides 1
\paperpagestyle plain
\begin_body
\begin_layout Title
-
Documentation Project Style Sheet
\end_layout
\begin_layout Author
-
by John Weiss
\end_layout
\begin_layout Abstract
-
This article is a style sheet.
It describes, with examples, how the documentation should look and sound.
The first few sections explain the font conventions and typography conventions
\end_layout
\begin_layout Abstract
-
The Style Sheet for LyX documentation (hereafter known as the Style Sheet)
applies to
\emph on
\end_layout
\begin_layout Section
-
Questions and Clarifications
\end_layout
\begin_layout Standard
-
After the second version of this Style Sheet grew uncomfortably large, the
LyX DocTeam decided it needed to lose some excess weight.
It seems the Style Sheet began to specify too many special cases, too many
\end_layout
\begin_layout Quote
-
If you have any questions about anything in the Style Sheet,
\emph on
ask first, write second!
\end_layout
\begin_layout Standard
-
Field all questions to the LyX Developer's Mailing List.
There are seasoned DocTeam members who can answer your questions.
If you have any problems with the Style Sheet itself, also contact the
\end_layout
\begin_layout Section
-
Fonts
\end_layout
\begin_layout Standard
-
We'll start with the easiest section, yet also the most important.
\end_layout
\begin_layout Standard
-
This is how you should fontify text in the manuals:
\end_layout
\begin_layout List
\labelwidthstring MMMMMMMM
-
\emph on
Emphasized
\emph default
\begin_deeper
\begin_layout Standard
-
Do not overemphasize your text.
\end_layout
+
\end_deeper
\begin_layout List
\labelwidthstring MMMMMMMM
-
\family typewriter
Typewriter
\family default
\begin_layout List
\labelwidthstring MMMMMMMM
-
\family sans
Sans\InsetSpace ~
Serif
\begin_layout List
\labelwidthstring MMMMMMMM
-
\noun on
Noun\InsetSpace ~
Style
\begin_layout List
\labelwidthstring MMMMMMMM
-
\family sans
\bar under
U
\begin_deeper
\begin_layout Description
-
WARNING! --- When you do this, make sure you
\emph on
only
\family default
after you shut off the underlining.
\end_layout
+
\end_deeper
\begin_layout List
\labelwidthstring MMMMMMMM
-
\series bold
Bold
\series default
\begin_deeper
\begin_layout Standard
-
If you want to emphasize any text, use
\emph on
Emphasized
\end_layout
\begin_layout Standard
-
Repeat: do not use boldface.
\end_layout
+
\end_deeper
\begin_layout Standard
-
Here are some examples:
\end_layout
\begin_layout Enumerate
-
The function
\family typewriter
math-mode
\end_layout
\begin_layout Enumerate
-
However,
\family sans
\bar under
\end_layout
\begin_layout Enumerate
-
Consider the following excerpt from the introduction of one of the manuals:
\end_layout
\begin_deeper
\begin_layout Quotation
-
\family sans
Return
\family default
\end_layout
\begin_layout Standard
-
Notice that the key name,
\family sans
Return
chose to label its keyboard, I used Roman and put the word in quotes.
There is a semantic difference.
\end_layout
+
\end_deeper
\begin_layout Enumerate
-
Take the following command:
\end_layout
\begin_deeper
\begin_layout Standard
-
\family typewriter
lpr -P
\family default
\end_layout
\begin_layout Standard
-
Notice that the argument to the
\family typewriter
-P
.
\end_layout
+
\end_deeper
\begin_layout Enumerate
-
Any LaTeX commands and code, and any
\emph on
unsupported
\end_layout
\begin_layout Section
-
Keys
\end_layout
\begin_layout Standard
-
The canonical keyboard contains these keys:
\end_layout
\begin_layout Itemize
-
\family sans
C-
\family default
\begin_layout Itemize
-
\family sans
S-
\family default
\begin_layout Itemize
-
\family sans
M-
\family default
\begin_deeper
\begin_layout Standard
-
Self-explanatory.
Be lazy and
\emph on
\emph default
whenever possible.
\end_layout
+
\end_deeper
\begin_layout Itemize
-
\family sans
F1 F2 F3 F4 F5 F6 F7 F8 F9 F10 F11 F12
\end_layout
\begin_deeper
\begin_layout Standard
-
The function keys.
Most modern keyboards have all 12.
\end_layout
+
\end_deeper
\begin_layout Itemize
-
\family sans
Esc
\family default
\begin_deeper
\begin_layout Standard
-
The
\begin_inset Quotes eld
\end_inset
\end_layout
+
\end_deeper
\begin_layout Itemize
-
\family sans
Insert
\family default
\begin_deeper
\begin_layout Standard
-
These are the 6 keys that appear above the cursor keys on many PC keyboards.
Consider them as part of the standard motion keys.
\end_layout
+
\end_deeper
\begin_layout Itemize
-
\family sans
Left Right Up Down
\end_layout
\begin_deeper
\begin_layout Standard
-
The four standard motion keys.
There is no need to put the word
\begin_inset Quotes eld
status collapsed
\begin_layout Standard
-
Same goes for
\begin_inset Quotes eld
\end_inset
\end_layout
+
\end_deeper
\begin_layout Itemize
-
\family sans
Return
\family default
\begin_deeper
\begin_layout Standard
-
I won't throw a hissy fit if you use one instead of the other.
I'd prefer if you used
\family sans
Since these two keys are bound to the same function in LyX, it doesn't
really matter.
\end_layout
+
\end_deeper
\begin_layout Standard
-
You do not need to explain everywhere what the
\family sans
Meta
\end_layout
\begin_layout Standard
-
LyX does not support keyboards missing any of the keys described above,
with one exception.
LyX can support a keyboard missing
\end_layout
\begin_layout Section
-
Mice
\end_layout
\begin_layout Standard
-
The word
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
-
Exception: you're writing an Author's Note (see section
\begin_inset LatexCommand \ref{sec:author-notes}
\end_layout
\begin_layout Standard
-
There are only 3 mouse buttons.
The use of them and of the mouse itself is obvious.
There are few --- if any --- nonstandard things we do with the mouse.
\end_layout
\begin_layout Section
-
Special Typography
\end_layout
\begin_layout Standard
-
Do the following:
\end_layout
\begin_layout Description
-
Multi-word\InsetSpace ~
names Use a
\family sans
\begin_deeper
\begin_layout Standard
-
This holds for things in
\family typewriter
Typewriter
\end_layout
\begin_layout Standard
-
I want the
\family sans
Protected\InsetSpace ~
) or manually add a hypenation point.
\end_layout
+
\end_deeper
\begin_layout Description
-
Special\InsetSpace ~
Terms These are things like the following:
\end_layout
\begin_deeper
\begin_layout Itemize
-
\family sans
HFill
\family default
\begin_layout Itemize
-
\family sans
VFill
\family default
\begin_layout Itemize
-
\family sans
Table\InsetSpace ~
Float
\begin_layout Itemize
-
\family sans
Figure\InsetSpace ~
Float
\begin_deeper
\begin_layout Standard
-
Use
\family sans
Sans\InsetSpace ~
\end_layout
\begin_layout Standard
-
Why are these terms special? They are concepts which the seasoned LaTeX-pert
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 default
for them.
\end_layout
+
\end_deeper
\end_deeper
\begin_layout Standard
-
Seasoned LyX Team Members: Are there other terms that require this special
status? On the other hand, should we eliminate this style completely?
\end_layout
\begin_layout Description
-
Terminology Note the following:
\end_layout
\begin_layout Itemize
-
-
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Itemize
-
PostScript® is a registered trademark of Adobe Corp.
\emph on
\begin_deeper
\begin_layout Standard
-
I am going to say this again:
\end_layout
-
\begin_layout Standard
-
-
\begin_inset VSpace 0.37cm
\end_inset
\end_layout
\begin_layout Standard
-
-
\begin_inset VSpace 0.51cm
\end_inset
\end_layout
-
\begin_layout Standard
-
I mean it! American companies like to sue anything that moves.
We could get in
\emph on
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.
\end_layout
\begin_layout Description
-
Menu\InsetSpace ~
Items When quick-referencing an item in a menu, use the menu separator:
\begin_deeper
\begin_layout Enumerate
-
The reason why I want no spaces around the
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Enumerate
-
A
\begin_inset Quotes eld
\end_inset
\begin_layout Enumerate
-
\emph on
NEVER
\emph default
\begin_deeper
\begin_layout Standard
-
\emph on
NEVER
\emph default
\begin_layout Standard
-
\emph on
NEVER
\emph default
\end_layout
\begin_layout Standard
-
Either write out the description, or use context to eliminate any need to
repeat menu items, dialog names, etc.
\end_layout
+
\end_deeper
\end_deeper
\begin_layout Description
-
Note\InsetSpace ~
Boxes LyX has a feature for adding comments that appear only within
the LyX GUI.
status collapsed
\begin_layout Standard
-
These should NEVER appear in the manuals.
\end_layout
\begin_deeper
\begin_layout Standard
-
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
) in place of the Note-Boxes.
\end_layout
+
\end_deeper
\begin_layout Description
-
-
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Description
-
Dashes: Be sure to use the correct one.
A single
\begin_inset Quotes eld
\begin_deeper
\begin_layout Standard
-
Instead, use an
\begin_inset Quotes eld
\end_inset
characters into a single, unbroken line.
\end_layout
+
\end_deeper
\begin_layout Section
-
Cross-References and Labels
\end_layout
\begin_layout Standard
-
Use the following labelling conventions:
\end_layout
\begin_layout List
\labelwidthstring 00.00.0000
-
sec:xxx Use this for
\family sans
Section
\begin_layout List
\labelwidthstring 00.00.0000
-
eqn:xxx Use this for Equations, should you need to create any.
\end_layout
\begin_layout List
\labelwidthstring 00.00.0000
-
tbl:xxxx Use this for tables inside of a table float.
\end_layout
\begin_layout List
\labelwidthstring 00.00.0000
-
fig:xxx Use this for figures inside of figure floats.
\end_layout
\begin_layout Standard
-
Additionally, you should put the label at one of two locations:
\end_layout
\begin_layout Enumerate
-
The
\emph on
beginning of the paragraph
\end_layout
\begin_layout Enumerate
-
If there is no paragraph after a section heading, put it at the
\emph on
end of the last line.
\begin_deeper
\begin_layout Standard
-
Example: You have a
\family sans
Section
heading.
I know it looks ugly; not much we can do about that, though.
\end_layout
+
\end_deeper
\begin_layout Section
-
Content --- What Goes Where
\end_layout
\begin_layout Standard
-
This is
\emph on
very
\end_layout
\begin_layout Standard
-
In the dim and distant past, whenever someone wanted to document a new feature
they added, they either wrote a mini-doc and stuck it into the documentation
directory, or they added a new section to the lone manual.
\end_layout
\begin_layout Standard
-
With that in mind, I have some instructions for how to keep things organized:
\end_layout
\begin_layout List
\labelwidthstring 00.00.0000
-
\family typewriter
Intro.lyx
\family default
\begin_layout List
\labelwidthstring 00.00.0000
-
\family typewriter
UserGuide.lyx
\family default
\begin_layout List
\labelwidthstring 00.00.0000
-
\family typewriter
Extended.lyx
\family default
\begin_deeper
\begin_layout Standard
-
Note, however, that you are
\emph on
not
\family default
are in the form of a journal article.
\end_layout
+
\end_deeper
\begin_layout List
\labelwidthstring 00.00.0000
-
\family typewriter
Tutorial.lyx
\family default
\begin_layout List
\labelwidthstring 00.00.0000
-
\family typewriter
Customization.lyx
\family default
\begin_deeper
\begin_layout Standard
-
If you are unsure whether or not something belongs in
\family typewriter
Customization.lyx
\family default
.
\end_layout
+
\end_deeper
\begin_layout List
\labelwidthstring 00.00.0000
-
\family typewriter
Reference.lyx
\family default
\begin_deeper
\begin_layout Standard
-
Note that the
\emph on
Reference Manual
entries.
Use them.
\end_layout
+
\end_deeper
\begin_layout Section
-
Writing Style: The Primary Manuals
\end_layout
\begin_layout Standard
-
While I want to make contributing to the Documentation Project as painless
as possible for newcomers, I also want the newcomers to be painless on
the existing Documentation Team! Ergo, I've written this section to give
\end_layout
\begin_layout Subsection
-
Language
\end_layout
\begin_layout Standard
-
All contributions to the
\emph on
primary
\end_layout
\begin_layout Standard
-
Don't get hung up on semantics.
English is a flexible language, and just because your Mothertongue-to-English
dictionary gives only one translation for a word doesn't necessarily mean
\end_layout
\begin_layout Standard
-
Nota Bene: by
\emph on
primary
\end_layout
\begin_layout Subsection
-
Wearing Many Hats:
\newline
Commentary from the Author (i.\InsetSpace ~
\end_layout
\begin_layout Standard
-
-
\begin_inset LatexCommand \label{sec:author-notes}
\end_inset
\end_layout
\begin_layout Standard
-
In short, when you contribute to the LyX Docs, you wear many hats.
\end_layout
\begin_layout Standard
-
For occasions when you need to switch hats, I've designed some special mechanism
s.
\end_layout
\begin_layout Subsubsection
-
Personal\InsetSpace ~
Notes: The
\begin_inset Quotes eld
\end_layout
\begin_layout Standard
-
These are footnotes.
They begin with the following:
\end_layout
\begin_layout Quote
-
Note from
\noun on
Name of Person
\end_layout
\begin_layout Standard
-
\SpecialChar \ldots{}
using the
\noun on
\end_layout
\begin_layout Standard
-
Use these when you need to quote a comment by someone (usually yourself),
and need to identify that person.
This includes occasions when you need wear the
\end_layout
\begin_layout Standard
-
If the comment is too large to put in a footnote, don't use a Personal Note.
When quoting more than about 3 sentences or 5 lines of text, use a bona
fide quote.
\end_layout
\begin_layout Subsubsection
-
Author's\InsetSpace ~
Notes: The
\begin_inset Quotes eld
\end_layout
\begin_layout Standard
-
There will be times when you are not speaking for the LyX Team, yet you
are not entirely speaking for yourself.
Instead, you are speaking on behalf of the manual itself, as the author
\end_layout
\begin_layout Itemize
-
You need to contradict something you just wrote because the feature isn't
quite ready yet, but you wanted to document what it will do.
\end_layout
\begin_layout Itemize
-
You need to leave a note for yourself.
\end_layout
\begin_layout Itemize
-
You need to leave a note for the editor or the other DocTeam members.
\end_layout
\begin_layout Itemize
-
You need to point out something about the manuals to the reader, something
that doesn't fit into the context of the current paragraph.
\end_layout
\begin_layout Standard
-
At such times, you are wearing your
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
-
The typography for an
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Itemize
-
They go in the body of the text, in brackets,
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Itemize
-
The text of the note itself, however, is emphasized.
\end_layout
\begin_layout Itemize
-
Begin with the words,
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
-
Here's an example: [
\emph on
Author's Note: This is an example note.
\end_layout
\begin_layout Standard
-
The form of the Author's Note, by the way, isn't a suggestion or request.
It is
\emph on
\end_layout
\begin_layout Standard
-
-
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Subsubsection
-
Footnotes:
\end_layout
\begin_layout Standard
-
You are also free to use footnotes on their own in addition to the Personal
Notes and/or Author's Notes.
I've frequently used footnotes to \SpecialChar \ldots{}
\end_layout
\begin_layout Paragraph*
-
Mixing Footnotes and Personal Notes
\end_layout
\begin_layout Standard
-
Personal Notes always go in footnotes, and should be 5 lines or fewer.
Any larger quotation should be quoted properly, using the rules of standard
English.
\end_layout
\begin_layout Paragraph*
-
Mixing Footnotes and Author's Notes
\end_layout
\begin_layout Standard
-
Author's Notes should
\emph on
never
\end_layout
\begin_layout Paragraph*
-
Mixing Personal Notes and Author's Notes
\end_layout
\begin_layout Standard
-
Forbidden; these two are mutually exclusive.
\end_layout
\begin_layout Subsubsection
-
Summary of Use
\end_layout
\begin_layout Itemize
-
Personal Notes:
\newline
A
\end_layout
\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.
+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.
+Used for text fragments that almost fit into the flow of
+ the text\SpecialChar \ldots{}
+but not quite.
\end_layout
\begin_layout Standard
-
When using these three mechanisms, in addition to rigorously following their
descriptions, please use them properly.
I listed some additional restrictions previously.
\end_layout
\begin_layout Subsection
-
General Stylistic Guidelines
\end_layout
\begin_layout Standard
-
Everything in this section is
\emph on
mandatory to all documenters
\end_layout
\begin_layout Subsubsection
-
Typography
\end_layout
\begin_layout Enumerate
-
Use the typography rules outlined in the beginning sections of this document.
\end_layout
\begin_layout Enumerate
-
Don't, however, mimic the typography of this file.
Yes, the Style Sheet doesn't follow the Style Sheet (grin).
\end_layout
\begin_layout Enumerate
-
There is some typographic freedom in those rules in earlier sections.
Use that freedom wisely.
Most importanly, never sacrifice the online appearance for the printed
\begin_deeper
\begin_layout Standard
-
An example is in the
\emph on
User's Guide
This is an example of permitting a little ugliness in the online version
to get the printed version to look right.
\end_layout
+
\end_deeper
\begin_layout Enumerate
-
When in doubt, compromise.
\end_layout
\begin_deeper
\begin_layout Standard
-
When in doubt, use good judgement.
\end_layout
+
\end_deeper
\begin_layout Subsubsection
-
Semantics
\end_layout
\begin_layout Enumerate
-
You are
\begin_inset Quotes eld
\end_inset
\begin_deeper
\begin_layout Standard
-
When you speak, you speak for the entire LyX Team, so use
\begin_inset Quotes eld
\end_inset
.
\end_layout
+
\end_deeper
\begin_layout Enumerate
-
The reader is
\begin_inset Quotes eld
\end_inset
\begin_deeper
\begin_layout Standard
-
Whenever you want to say something to the reader, use
\begin_inset Quotes eld
\end_inset
not some contorted construction to avoid being too informal.
\end_layout
+
\end_deeper
\begin_layout Enumerate
-
Use the term
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Enumerate
-
Use the term
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Enumerate
-
When in doubt, compromise.
\end_layout
\begin_deeper
\begin_layout Standard
-
When in doubt, use good judgement.
\end_layout
+
\end_deeper
\begin_layout Subsubsection
-
-
\begin_inset LatexCommand \label{sec:quote}
\end_inset
\end_layout
\begin_layout Standard
-
In some cases, you'll have something to say, an opinion of yours.
Since this is your opinion, you're not speaking for the LyX Team.
You have so much to say, in fact, that it won't fit into a Personal Note
\end_layout
\begin_layout Standard
-
Any time you wish to quote someone, be it yourself or someone else, there
are standard rules one follows.
Every language has its own rules.
\end_layout
\begin_layout Standard
-
This creates a problem for the primary documentation.
The primary documentation is written in English, yet the contributors come
from many countries.
\end_layout
\begin_layout Standard
-
-
\begin_inset Float figure
placement htbp
wide false
status collapsed
\begin_layout Standard
-
Quoting rules for English:
\end_layout
\begin_layout Itemize
-
The body of the quote belongs in a
\family sans
Quotation
\end_layout
\begin_layout Itemize
-
The sentences prior to the quote should flow logically and smoothly into
the quote.
\end_layout
\begin_layout Itemize
-
The sentences immediately following the quote should continue the flow of
the text.
\end_layout
\begin_layout Itemize
-
You must,
\emph on
must
\end_layout
\begin_layout Itemize
-
Crediting the original author of the quote should not, however, disrupt
the flow of the text.
\end_layout
\begin_layout Itemize
-
If you omit text from the beginning of the first sentence in the quote,
the quote must start with the text
\begin_inset Quotes eld
\end_layout
\begin_layout Itemize
-
If you omit text from the end of the last sentence in the quote, the quote
must end with the text
\begin_inset Quotes eld
\end_layout
\begin_layout Itemize
-
If you omit any text from the middle of the quote, be it whole sentences
or parts of sentences, replace it with the text
\begin_inset Quotes eld
\end_layout
\begin_layout Itemize
-
The quote must be grammatically correct.
\end_layout
\begin_deeper
\begin_layout Itemize
-
If the original is wrong, you must correct it.
\end_layout
\begin_layout Itemize
-
If omitting part of the quote
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Itemize
-
For missing words (e.\InsetSpace ~
g.\InsetSpace ~
\end_layout
\begin_layout Itemize
-
For mangled word order, correct the mangled text, following it with the
text
\begin_inset Quotes eld
.
\end_layout
+
\end_deeper
\begin_layout Itemize
-
Spelling in the quote must be correct.
Correct any misspelled words and place the text
\begin_inset Quotes eld
\end_layout
\begin_layout Itemize
-
Back-to-back bracket blocks merge together.
Example:
\begin_inset Quotes eld
\end_layout
\begin_layout Itemize
-
If you correct the spelling in 2 or more consecutive words, you can get
away with one
\begin_inset Quotes eld
\end_layout
\begin_layout Subsubsection
-
Coverage
\end_layout
\begin_layout Standard
-
When describing a new feature or
\family typewriter
*.layout
\end_layout
\begin_layout Enumerate
-
Be
\emph on
clear, concise,
\begin_deeper
\begin_layout Itemize
-
Do
\emph on
not
\end_layout
\begin_layout Itemize
-
Get to the point.
\end_layout
\begin_layout Itemize
-
Take a look at the manual for a commercial word processor --- it's a fine
example of how
\series bold
\emph default
\end_layout
+
\end_deeper
\begin_layout Enumerate
-
Avoid being pedantic like The Plague!
\end_layout
\begin_layout Enumerate
-
In the same vein, don't write more than you have to.
You're not working in a vacuum --- refer freely to other parts of the manual
(and other parts of other manuals).
\end_layout
\begin_layout Enumerate
-
On the other hand, BE THOROUGH!
\end_layout
\begin_deeper
\begin_layout Enumerate
-
You are documenting
\emph on
features
\end_layout
\begin_layout Enumerate
-
Group by feature, not by widget.
\end_layout
\begin_layout Enumerate
-
Stay on topic --- one
\family sans
Section
\end_layout
\begin_layout Enumerate
-
Describe EVERYTHING related to that feature, no matter where it is.
\end_layout
\begin_deeper
\begin_layout Enumerate
-
Example: Paragraph Indenting.
Several popups control its behavior.
You would document
\end_layout
\begin_layout Enumerate
-
Note from
\noun on
John Weiss
\begin_deeper
\begin_layout Standard
-
These remarks still hold true: you'll piss of the DocTeam editor if you
do things wrong, because he'll have to fix your mistakes.
\end_layout
+
\end_deeper
\end_deeper
\begin_layout Enumerate
-
Remember, there are people who will reference
\emph on
your
section, just as you're referencing someone else's.
You do want what you write to be useful, don't you?
\end_layout
+
\end_deeper
\begin_layout Enumerate
-
When in doubt, compromise.
\end_layout
\begin_deeper
\begin_layout Standard
-
When in doubt, use good judgement.
\end_layout
+
\end_deeper
\begin_layout Subsubsection
-
NEVER NEVER
\emph on
NEVER EVER
\end_layout
\begin_layout Enumerate
-
No dumbing-down.
\end_layout
\begin_layout Enumerate
-
No talking down to the reader.
\end_layout
\begin_layout Enumerate
-
The reader is smart enough to know what a mouse is.
\end_layout
\begin_layout Enumerate
-
The reader is smart enough to know how to use a keyboard, including the
\family sans
\end_layout
\begin_layout Enumerate
-
The reader is smart enough to know that
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Enumerate
-
Rule of thumb: the reader is not an imbecile.
The reader is merely lost; point them in the right direction, and they
can take it from there.
\end_layout
\begin_layout Subsection
-
Tips for the English Version
\end_layout
\begin_layout Standard
-
-
\begin_inset LatexCommand \label{sec:english-only}
\end_inset
\end_layout
\begin_layout Subsubsection
-
Write as if You're Talking with a Friend.
\end_layout
\begin_layout Enumerate
-
Think that way when you write.
Play the dialogue in your mind.
\end_layout
\begin_layout Enumerate
-
Be as informal as you please (without being rude).
\end_layout
\begin_layout Subsubsection
-
AVOID the Passive Voice
\end_layout
\begin_layout Enumerate
-
No:
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Enumerate
-
Things don't happen by magic - somebody or something did it.
Only politicians use the passive voice to cover up who did something.
If LyX reformats a paragraph, write,
\begin_deeper
\begin_layout Standard
-
Rule of thumb: any sentence you can express as,
\begin_inset Quotes eld
\end_inset
Much nicer.
\end_layout
+
\end_deeper
\begin_layout Enumerate
-
I know it's tough.
We all hear way, way too much garbage English on the TV every day in the
passive voice.
\end_layout
\begin_layout Enumerate
-
I
\emph on
will make you rewrite
\end_layout
\begin_layout Enumerate
-
Note to non-Americans:
\end_layout
\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.
It also bloats sentences, often unnecessarily.
\end_layout
+
\end_deeper
\begin_layout Subsubsection
-
Short Sentences.
Short Paragraphs.
\end_layout
\begin_layout Standard
-
In English, there is a grammatical error known as the
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
-
In general, stick to short sentences in written English.
Getting rid of passive voice (
\begin_inset Quotes eld
\end_layout
\begin_layout Standard
-
While I'm talking about paragraphs, I'll apply the
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
-
There is a single exception to the short sentence, short paragraph rule.
Particularly complex ideas may need more
\begin_inset Quotes eld
\end_layout
\begin_layout Standard
-
To reiterate, yet again, something I said before:
\end_layout
\begin_layout Quote
-
When in doubt, compromise.
\end_layout
\begin_layout Quote
-
When in doubt, use good judgement.
\end_layout
\begin_layout Standard
-
Hopefully, you've got the idea (grin).
\end_layout
\begin_layout Section
-
Translations
\end_layout
\begin_layout Subsection
-
Rules of the Translating Trade
\end_layout
\begin_layout Standard
-
While translating anything, there are certain
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Subsubsection
-
Translate one paragraph at a time.
\end_layout
\begin_layout Standard
-
Most people translate word by word.
Clearly, you lose all context if you do that.
A word may have multiple meanings.
\end_layout
\begin_layout Standard
-
There is another level to the context issue, however.
Your dictionary may translate multiple English words the same way.
All those words mean
\end_layout
\begin_layout Subsubsection
-
You will not translate it correctly on the first try.
\end_layout
\begin_layout Standard
-
Alright, I admit that you may be able to translate some of the sentences
at first glance.
If you know a language well, you may even understand over half of the text.
\end_layout
\begin_layout Standard
-
It is generally a good idea to make multiple passes over a paragraph you're
translating.
Even if you translate the entire paragraph on the first pass, make a second
\end_layout
\begin_layout Subsubsection
-
When in doubt, write down all of the meanings for a word.
\end_layout
\begin_layout Standard
-
You can often translate tricky parts of a text using the context of the
surrounding sentences.
So, if you hit a word or phrase you don't know, translate it more than
\end_layout
\begin_layout Subsubsection
-
Using context, fix the meanings on the next pass.
\end_layout
\begin_layout Standard
-
This is where your multiple translations of a single word become useful.
Using the other sentences you translated, you can now translate that mystery--s
entence without reconsulting your dictionary.
\end_layout
\begin_layout Subsubsection
-
Fix the grammar only after you've finished translating the sentence.
\end_layout
\begin_layout Standard
-
If there's a mystery phrase in the middle of a sentence, you can't translate
the entire sentence.
Why grammatically rearrange the words you translated already? You may need
\end_layout
\begin_layout Subsubsection
-
If you can't translate it, skip it and come back to it on the next pass.
\end_layout
\begin_layout Standard
-
Remember the earlier discussion of context and its immense usefulness? There
is no sin in making multiple passes over a tricky passage.
\end_layout
\begin_layout Subsubsection
-
Translate the meaning first.
The rest can wait.
\end_layout
\begin_layout Standard
-
The information content of the text under translation is the most important
part.
This is especially important for a manual, where the information
\end_layout
\begin_layout Subsection
-
Tips for the Translators
\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 ~
\end_layout
\begin_layout Subsubsection
-
Write as if you are explaining LyX to a colleague you know well.
\end_layout
\begin_layout Enumerate
-
Think that way when you write.
Play the dialogue in your mind.
\end_layout
\begin_layout Enumerate
-
Use a conversational style in your writing.
Pretend you are teaching LyX to a colleague you know well.
\end_layout
\begin_layout Enumerate
-
Use a style that is polite without being too formal.
If, in your culture, informal language is appropriate to use with a colleague,
use informal speech in the translation of the manual.
\end_layout
\begin_layout Subsubsection
-
AVOID Snobby, Academic, Specialized, or
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
-
In English, the passive voice appears formal, dry, barren.
It also often adds unnecessary complexity.
In other langauges, however, this is not the case.
\end_layout
\begin_layout Standard
-
In Germany, there is a magazine known as
\begin_inset Quotes gld
\end_inset
\end_layout
\begin_layout Standard
-
We who write the LyX manuals, original or translated, seek to
\emph on
inform
\end_layout
\begin_layout Subsubsection
-
Keep the Writing Simple.
\end_layout
\begin_layout Standard
-
For the English version, I wrote,
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
-
Nevertheless, the translations of the LyX manuals should be as clear as
the originals.
So, for our international colleagues, we apply this rule: Keep your sentences
\end_layout
\begin_layout Standard
-
Remember: we're translating manuals here, folks.
Our goal is rapid information location and comprehension, not a literary
prize.
\end_layout
\begin_layout Quote
-
When in doubt, compromise.
\end_layout
\begin_layout Quote
-
When in doubt, use good judgement.
\end_layout
\begin_layout Subsubsection
-
Translators must follow the Style Sheet, too!
\end_layout
\begin_layout Standard
-
Everything in this manual ---
\emph on
except section\InsetSpace ~
\end_layout
\begin_layout Subsubsection
-
Translators must read the Style Sheet Supplement for their language.
\end_layout
\begin_layout Standard
-
For every translation project, there is a Supplement to the Style Sheet.
It will be named:
\end_layout
\begin_layout Quote
-
\family typewriter
DocStyle_Supplement_<cn>.lyx
\end_layout
\begin_layout Standard
-
\SpecialChar \ldots{}
where
\begin_inset Quotes eld
\end_layout
\begin_layout Subsubsection
-
The English versions of the manuals are not Sacred Text.
\end_layout
\begin_layout Standard
-
You do not need to translate everything word for word.
In fact, you shouldn't.
Keep to the spirit of the originals, not the letter.
\end_layout
\begin_layout Subsubsection
-
Any information in the LyX manuals must also be in the translations.
\end_layout
\begin_layout Standard
-
-
\begin_inset LatexCommand \label{sec:accuracy}
\end_inset
\end_layout
\begin_layout Itemize
-
Omitting any feature description is
\emph on
stricly forbidden
\end_layout
\begin_layout Itemize
-
Misrepresenting or misdescribing any LyX feature or operation
\emph on
must be avoided
\end_layout
\begin_layout Itemize
-
The translation
\emph on
cannot
\emph default
outpace the original.
\newline
-If no one has documented new feature in the primary LyX manuals (i.\InsetSpace ~
+If no one has documented new feature in the primary
+ LyX manuals (i.\InsetSpace ~
e.\InsetSpace ~
-the English
- versions), do not do so in the translations.
+the English versions), do not do so in the translations.
If you're really looking for something to do, either:
\end_layout
\begin_deeper
\begin_layout Itemize
-
\SpecialChar \ldots{}
focus on translating something you haven't yet,
\newline
\end_layout
\begin_layout Itemize
-
\SpecialChar \ldots{}
update or repair the primary manual.
\end_layout
\begin_layout Standard
-
If you cannot or do not want to do one of the above, then take a break.
Relax.
Wait for the main manuals to catch up before translating anything else.
\end_layout
+
\end_deeper
\begin_layout Subsubsection
-
What you cannot translate, you may omit (usually).
\end_layout
\begin_layout Standard
-
Prepositions, idioms, metaphors, slang, Oh My! There's a jungle of potentially
untranslatable text you may face.
Happily, none of these untranslatables are essential to the original text\SpecialChar \ldots{}
\end_layout
\begin_layout Standard
-
There may be special cases where omitting part of a sentence or paragraph
violates rule\InsetSpace ~
\end_layout
\begin_layout Subsubsection
-
Translators may add their own fluff to the information content.
\end_layout
\begin_layout Standard
-
After you do strip away all of the idioms, metaphors, slang, humor, and
other
\begin_inset Quotes eld
\end_layout
\begin_layout Subsection
-
For Translation Project Chiefs
\end_layout
\begin_layout Subsubsection
-
The First Is In Charge
\end_layout
\begin_layout Standard
-
If you were the first person to start translating the manuals, you're the
LyXDoc Translation Project Chief for your language.
If you are the
\end_layout
\begin_layout Standard
-
Amongst other things, that means that you must read this section and perform
the tasks described here.
\end_layout
\begin_layout Standard
-
If you are a member of a LyX Documentation Translation Team, but
\emph on
are not
\end_layout
\begin_layout Standard
-
If you have not read the Style Sheet Supplement for your language, you should
read it now.
\end_layout
\begin_layout Subsubsection
-
Read the Style Sheet
\end_layout
\begin_layout Standard
-
No documenter is excused from following the Style Sheet, not even a Translation
Project Chief.
\end_layout
\begin_layout Standard
-
Actually, it is
\emph on
especially
\end_layout
\begin_layout Subsubsection
-
Make your translators read the Style Sheet
\end_layout
\begin_layout Standard
-
No documenter is excused from following the Style Sheet.
\end_layout
\begin_layout Standard
-
Since your translation team is translating, they know
\emph on
some
\end_layout
\begin_layout Subsubsection
-
Provide a
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
-
There are parts of this Style Sheet that are English-specific.
I have tried to provide a general, language-independent description of
certain details in this section.
\end_layout
\begin_layout Standard
-
That's where you, as head of a LyXDoc Translation Team, come in.
\end_layout
\begin_layout Standard
-
Every Translation Team Chief is
\emph on
required
\end_layout
\begin_layout Enumerate
-
Name the file:
\newline
\end_layout
\begin_layout Enumerate
-
Do not worry about where the file goes.
The CVS maintainers will locate all documentation and Style Sheet Supplements
in an appropriate place.
\end_layout
\begin_layout Enumerate
-
Document Properties:
\end_layout
\begin_deeper
\begin_layout Itemize
-
For consistency, use the same document class and other document properties
as the Style Sheet.
\begin_inset Foot
status collapsed
\begin_layout Standard
-
Specifically, check the settings in the
\family sans
Document Layout
\end_layout
\begin_layout Itemize
-
Exceptions: Use margins, indentation/paragraph separation, language, and
encoding appropriate for your language.
\end_layout
+
\end_deeper
\begin_layout Enumerate
-
The title of the Supplement:
\end_layout
\begin_deeper
\begin_layout Itemize
-
The title will use the
\begin_inset Quotes eld
\end_inset
\begin_deeper
\begin_layout Standard
-
\family typewriter
Documentation Project Style Sheet:
\newline
\end_layout
\begin_layout Standard
-
(Replace
\begin_inset Quotes eld
\end_inset
with the name of your language.)
\end_layout
+
\end_deeper
\begin_layout Itemize
-
If, in your language,
\begin_inset Quotes eld
\end_inset
\begin_deeper
\begin_layout Standard
-
Choose a replacement word accordingly.
Whatever you choose to replace
\begin_inset Quotes eld
\end_layout
+
\end_deeper
\end_deeper
\begin_layout Enumerate
-
Below the title, in the
\begin_inset Quotes eld
\end_inset
\begin_deeper
\begin_layout Standard
-
There will be no abstract.
\end_layout
+
\end_deeper
\begin_layout Enumerate
-
The first
\family sans
Section
\begin_deeper
\begin_layout Standard
-
The first thing you will do is strongly yet politely encourage the reader
to stop reading the
\begin_inset Quotes eld
\emph default
understood the Style Sheet proper.
\end_layout
+
\end_deeper
\begin_layout Subsubsection
-
Keep the Supplement Succinct
\end_layout
\begin_layout Standard
-
This Style Sheet is already very detailed.
DocTeam members all have a lot to read.
We don't want to place an extra burden on translators.
\end_layout
\begin_layout Subsubsection
-
Font Issues
\end_layout
\begin_layout Standard
-
The second
\family sans
Section
\begin_layout Itemize
-
\family typewriter
Typewriter
\end_layout
\begin_layout Itemize
-
\family sans
Sans Serif
\end_layout
\begin_layout Itemize
-
Roman
\newline
\begin_layout Itemize
-
\bar under
Underlined
\end_layout
\begin_layout Itemize
-
\series bold
Bold
\end_layout
\begin_layout Itemize
-
\noun on
Noun (actually Small Caps)
\end_layout
\begin_layout Standard
-
\SpecialChar \ldots{}
certainly exist for all languages that use the Roman alphabet.
Do they exist, however, for Greek? How about Cyrillic? These different
\end_layout
\begin_layout Standard
-
There will be some languages for which following the font-scheme specified
in this Style Sheet may not be possible.
If you are the Translation Project Chief for such a language, you have
\end_layout
\begin_layout Standard
-
In the font section of the Supplement, you will provide a new typographic
style, designed specifically for your writing system.
For consistency, the title of this section in every Supplement should translate
\end_layout
\begin_layout Itemize
-
Guidelines for
\begin_inset Quotes eld
\end_inset
\begin_deeper
\begin_layout List
\labelwidthstring MMMMMMMM
-
Roman Use the font that typesetters in your language use for printing books,
manuals, etc.
This will typically be the default font LyX (and LaTeX) uses in your language.
\begin_layout List
\labelwidthstring MMMMMMMM
-
\noun on
Noun\InsetSpace ~
Style
\begin_layout List
\labelwidthstring MMMMMMMM
-
\emph on
Emphasized
\emph default
\begin_deeper
\begin_layout Standard
-
Use a font that is different from your language's equivalent of
\series bold
Boldface
\emph default
if at all possible!
\end_layout
+
\end_deeper
\begin_layout List
\labelwidthstring MMMMMMMM
-
\family typewriter
Typewriter
\family default
\begin_layout List
\labelwidthstring MMMMMMMM
-
\family sans
Sans\InsetSpace ~
Serif
\begin_layout List
\labelwidthstring MMMMMMMM
-
\family sans
\bar under
U
\begin_deeper
\begin_layout Standard
-
If you use some special font on-screen to highlight the accelerator keys
for menus, buttons, and other widgets, you might want to mimic that in
the translations.
Therefore, if you can't mimic this typographic convention in your native
writing system, don't.
\end_layout
+
\end_deeper
\end_deeper
\begin_layout Standard
-
Note that you may also want to describe fonts that your Translation Team
should
\emph on
\end_layout
\begin_layout Standard
-
Once you have determined which fonts in your native writing system will
replace one or more of the above, propose it to the LyX Developer's Mailing
List.
\end_layout
\begin_layout Standard
-
Remember: stick to the font specifications in this Style Sheet as best you
can, whenever you can.
\end_layout
\begin_layout Subsubsection
-
Quoting Style and the
\family sans
Quote
\end_layout
\begin_layout Standard
-
The next section of the Supplement will cover the issue of quoting.
Give it an appropriate title.
\end_layout
\begin_layout Standard
-
One of the first things you should do in that section is resolve the following
issue:
\end_layout
\begin_layout Itemize
-
Decide whether
\family sans
Quote
\end_layout
\begin_layout Itemize
-
In the Supplement, specify which one to use.
\end_layout
\begin_layout Standard
-
English has its own typography and style for quoting others.
The Style Sheet describes that typography in section\InsetSpace ~
\end_layout
\begin_layout Subsubsection
-
Translations of Style Sheet Terminology
\end_layout
\begin_layout Standard
-
In the Supplement, you must provide a standard translation of certain key
phrases for the members of your Translation Team.
Place this in a section following the one about quotations.
\end_layout
\begin_layout Standard
-
In particular, standardize the translations of the phrases:
\end_layout
\begin_layout Itemize
-
Note from
\noun on
<foo>:
\begin_layout Itemize
-
\emph on
Author's Note:
\end_layout
\begin_layout Standard
-
Do
\emph on
not
\end_layout
\begin_layout Standard
-
While we are discussing proper use of the
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
-
You, as Translation Project Chief, must decide.
You can forbid translation of pre-existing
\begin_inset Quotes eld
\end_layout
\begin_layout Standard
-
Whatever you decide, codify your policy in its own
\family sans
Section
\end_layout
\begin_layout Subsubsection
-
Lost in Translation
\end_layout
\begin_layout Standard
-
After describing all of the previous issues, create a new
\family sans
Section
\end_layout
\begin_layout Standard
-
In this section you will discuss any common English metaphors, humor, connotatio
n, or other difficult to translate text.
Try to balance brevity and completeness.
\end_layout
\begin_layout Subsubsection
-
\SpecialChar \ldots{}
\begin_inset Quotes eld
\end_layout
\begin_layout Standard
-
Throughout the manuals, the DocTeam has used the following sentences:
\end_layout
\begin_layout Quote
-
If you haven't read the <
\emph on
Foo
\end_layout
\begin_layout Standard
-
This sentence will be tricky to translate, since it contains non-translatable
connotations.
Therefore, create a
\end_layout
\begin_layout Standard
-
Here's what those two sentences, sitting alone in their own paragraph, mean:
\end_layout
\begin_layout Standard
-
The first sentence uses the English conditional followed by an imperative.
We, as the LyX team, are commanding the reader to go back to another manual.
For example, the
\end_layout
\begin_layout Standard
-
The second sentence adds force to the command.
Culturally, the imperative tense of a verb in English is not necessarily
forceful.
\end_layout
\begin_layout Standard
-
Note that all of this commanding and reinforcing is nevertheless in a polite
format.
Furthermore, it is in a subtle form.
\end_layout
\begin_layout Subsubsection
-
Firm Convincing vs.
Rudeness
\end_layout
\begin_layout Standard
-
In the same part of the Supplement that you place the
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
-
You see, here in America, we often say that everything is permitted unless
explicitly banned by law.
As a result, manuals for computer software are frequently ignored and the
\end_layout
\begin_layout Standard
-
We who wrote the manuals added sentences insisting that the reader not ignore
certain parts of the documentation.
We wrote in a manner that was polite, yet firmly asserted that the user
\end_layout
\begin_layout Standard
-
In your culture, cajoling the reader into using the manuals correctly may
not be necessary.
It may, in fact, be outright rude.
\end_layout
\begin_layout Standard
-
You, the Translation Project Chief, must discuss this issue.
Try and find parts of the original manuals where some friendly but firm
convincing does not translate properly.
\end_layout
\begin_layout Subsubsection
-
Anything Else?
\end_layout
\begin_layout Standard
-
You can add more sections to the Supplement if you need to discuss other
issues.
There may be policies or guidelines that you want to set for your Translation
projects / lyx.git / blobdiff