1 #LyX 2.3 created this file. For more info see http://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/attic/
8 \use_default_options false
9 \maintain_unincluded_children false
11 \language_package default
12 \inputencoding iso8859-1
14 \font_roman "default" "default"
15 \font_sans "default" "default"
16 \font_typewriter "default" "default"
17 \font_math "auto" "auto"
18 \font_default_family default
19 \use_non_tex_fonts false
22 \font_sf_scale 100 100
23 \font_tt_scale 100 100
25 \use_dash_ligatures true
27 \default_output_format default
29 \bibtex_command default
30 \index_command default
36 \use_package amsmath 1
37 \use_package amssymb 1
40 \use_package mathdots 1
41 \use_package mathtools 1
43 \use_package stackrel 1
44 \use_package stmaryrd 1
45 \use_package undertilde 1
47 \cite_engine_type default
51 \paperorientation portrait
62 \paragraph_separation indent
63 \paragraph_indentation default
65 \math_numbering_side default
71 \tracking_changes false
81 Documentation Project Style Sheet
88 \begin_layout Abstract
89 This article is a style sheet.
90 It describes, with examples, how the documentation should look and sound.
91 The first few sections explain the font conventions and typography conventions
92 all documentation writers should follow.
93 Those sections also contain examples.
94 It also explains the purpose of each of the different manuals.
95 Follow it not merely to the letter, but also in spirit.
98 \begin_layout Abstract
99 The Style Sheet for \SpecialChar LyX
100 documentation (hereafter known as the Style Sheet)
105 forms of \SpecialChar LyX
106 documenation, regardless of language.
107 There is a section for translators in the Style Sheet, towards the end.
110 Read the entire Style Sheet!
112 Even if you are a translator, I assume you know enough English to comprehend
116 \begin_layout Section
117 Questions and Clarifications
120 \begin_layout Standard
121 After the second version of this Style Sheet grew uncomfortably large, the
123 DocTeam decided it needed to lose some excess weight.
124 It seems the Style Sheet began to specify too many special cases, too many
125 points of clarification.
126 On the other hand, contributors to the documents were discovering many
127 creative ways of misinterpreting the Style Sheet specifications.
132 If you have any questions about anything in the Style Sheet,
134 ask first, write second!
137 \begin_layout Standard
138 Field all questions to the \SpecialChar LyX
139 Developer's Mailing List.
140 There are seasoned DocTeam members who can answer your questions.
141 If you have any problems with the Style Sheet itself, also contact the
145 \begin_layout Section
149 \begin_layout Standard
150 We'll start with the easiest section, yet also the most important.
153 \begin_layout Standard
154 This is how you should fontify text in the manuals:
157 \begin_layout Labeling
158 \labelwidthstring MMMMMMMM
163 general emphasis, generic arguments, titles of books, names the other manuals
164 and of their sections, and notes from the authors
165 \begin_inset Separator latexpar
172 \begin_layout Standard
173 Do not overemphasize your text.
177 \begin_layout Labeling
178 \labelwidthstring MMMMMMMM
183 program names, file names,
187 -page names, \SpecialChar LaTeX
188 code, \SpecialChar LaTeX
189 commands, \SpecialChar LaTeX
190 package names, and \SpecialChar LyX
194 \begin_layout Labeling
195 \labelwidthstring MMMMMMMM
204 menu, button, or popup names, the names/lables of all widgets in a popup,
205 the names of keyboard keys, and certain
206 \begin_inset Quotes eld
210 \begin_inset Quotes erd
216 \begin_layout Labeling
217 \labelwidthstring MMMMMMMM
229 \begin_layout Labeling
230 \labelwidthstring MMMMMMMM
246 Rich Fields added this to mimick the underlining of letters in the menus
248 It helps to highlight the accelerator keys, and human brains store information
249 best when they see it frequently.
250 \begin_inset Separator latexpar
257 \begin_layout Description
258 WARNING! — When you do this, make sure you
262 shut off the underlining.
263 Too many people send in things that look like:
264 \begin_inset Newline newline
274 \begin_inset Newline newline
286 they not only shut off underlining, they turned off
298 Make sure the entire word is still in
306 after you shut off the underlining.
310 \begin_layout Labeling
311 \labelwidthstring MMMMMMMM
317 \begin_inset Separator latexpar
324 \begin_layout Standard
325 If you want to emphasize any text, use
331 will put many things boldface on its own, such as
335 s, certain parts of equations, et cetera.
338 \begin_layout Standard
339 Repeat: do not use boldface.
343 \begin_layout Standard
344 Here are some examples:
347 \begin_layout Enumerate
352 appears in configuration files and in the \SpecialChar LyX
354 Therefore, it (and all other \SpecialChar LyX
355 function names) count as code and is set
363 \begin_layout Enumerate
375 is a menu item in the
382 menu, so it appears in
406 for the accelerator keys.
409 \begin_layout Enumerate
410 Consider the following excerpt from the introduction of one of the manuals:
411 \begin_inset Separator latexpar
418 \begin_layout Quotation
427 both refer to the same key.
428 Some keyboards label the
433 \begin_inset Quotes eld
437 \begin_inset Quotes erd
441 \begin_inset Quotes eld
445 \begin_inset Quotes erd
448 still others have two keys.
450 treats all of them as the same key, so we'll use
461 \begin_layout Standard
462 Notice that the key name,
478 when it references the key itself! When I described how the manufacturer
479 chose to label its keyboard, I used Roman and put the word in quotes.
480 There is a semantic difference.
484 \begin_layout Enumerate
485 Take the following command:
486 \begin_inset Separator latexpar
493 \begin_layout Standard
502 \begin_layout Standard
503 Notice that the argument to the
512 \begin_inset space \thinspace{}
517 This is a case where you don't use
521 for code, because you want the generic argument label to stand out.
522 On the other hand, if you were specifying an argument, for example,
523 \begin_inset Quotes eld
531 \begin_inset Quotes erd
543 \begin_layout Enumerate
544 Any \SpecialChar LaTeX
545 commands and code, and any
550 package names get set in
556 \begin_inset Quotes eld
564 \begin_inset Quotes erd
567 is the name of an unsupported \SpecialChar LaTeX
569 \begin_inset Quotes eld
577 \begin_inset Quotes erd
580 is a supported \SpecialChar LaTeX
584 \begin_layout Section
588 \begin_layout Standard
589 The canonical keyboard contains these keys:
592 \begin_layout Itemize
604 \begin_layout Itemize
616 \begin_layout Itemize
626 \begin_inset Separator latexpar
633 \begin_layout Standard
637 use the abbreviations
643 \begin_layout Itemize
646 F1 F2 F3 F4 F5 F6 F7 F8 F9 F10 F11 F12
649 \begin_inset Separator latexpar
656 \begin_layout Standard
658 Most modern keyboards have all 12.
662 \begin_layout Itemize
668 \begin_inset Separator latexpar
675 \begin_layout Standard
677 \begin_inset Quotes eld
681 \begin_inset Quotes erd
688 \begin_layout Itemize
714 \begin_inset Separator latexpar
721 \begin_layout Standard
722 These are the 6 keys that appear above the cursor keys on many PC keyboards.
723 Consider them as part of the standard motion keys.
727 \begin_layout Itemize
733 \begin_inset Separator latexpar
740 \begin_layout Standard
741 The four standard motion keys.
742 There is no need to put the word
743 \begin_inset Quotes eld
747 \begin_inset Quotes erd
750 anywhere, since that's obvious.
754 \begin_layout Plain Layout
756 \begin_inset Quotes eld
760 \begin_inset Quotes erd
765 \begin_inset Quotes eld
769 \begin_inset Quotes erd
772 after one of these may be redundant in certain situations.
781 \begin_layout Itemize
791 \begin_inset Separator latexpar
798 \begin_layout Standard
799 I won't throw a hissy fit if you use one instead of the other.
800 I'd prefer if you used
808 , but it's okay if you slip up and forget.
809 Since these two keys are bound to the same function in \SpecialChar LyX
815 \begin_layout Standard
816 You do not need to explain everywhere what the
825 The user isn't stupid.
826 Also, someone will document anything that isn't clear (e.
843 problem) someplace in the introduction.
844 No need for you to repeat someone else's work.
847 \begin_layout Standard
849 does not support keyboards missing any of the keys described above, with
852 can support a keyboard missing
861 There is a keyboard accelerator for
865 , but this is the only function key \SpecialChar LyX
867 Nevertheless, these details are of minor, if any, concern for the documentation.
868 Assume the aforementioned keys exist.
871 \begin_layout Section
875 \begin_layout Standard
877 \begin_inset Quotes eld
881 \begin_inset Quotes erd
884 and any description of the 3 mouse buttons have no special handling.
885 Don't typeset them in any other font than the default, which is Roman.
889 \begin_layout Standard
890 Exception: you're writing an Author's Note (see section
891 \begin_inset CommandInset ref
893 reference "sec:author-notes"
897 ) and you need to mention something about the mouse.
898 Since the rest of the note is in
902 , your description of
903 \begin_inset Quotes eld
907 \begin_inset Quotes erd
910 should be emphasized, as well.
911 There are a couple of other cases like this one; use your judgement.
914 \begin_layout Standard
915 There are only 3 mouse buttons.
916 The use of them and of the mouse itself is obvious.
917 There are few — if any — nonstandard things we do with the mouse.
918 Therefore, there's no need to make the word
919 \begin_inset Quotes eld
923 \begin_inset Quotes erd
927 \begin_inset Quotes eld
931 \begin_inset Quotes erd
937 \begin_layout Section
941 \begin_layout Standard
945 \begin_layout Description
958 between the words for menu and widget names.
977 \begin_inset Separator latexpar
984 \begin_layout Standard
985 This holds for things in
998 If you have a long code example, one that can't simply be inlined and put
1007 \begin_inset space ~
1015 \begin_layout Standard
1019 \begin_inset space ~
1024 so that the name doesn't get split between two lines, which is visually
1029 \begin_inset space ~
1034 is near the end of a line and overflows the margin, use a
1040 in that parargraph (consult a \SpecialChar LaTeX
1042 \begin_inset Quotes eld
1052 \begin_inset Quotes erd
1055 ) or manually add a hypenation point.
1059 \begin_layout Description
1061 \begin_inset space ~
1064 Terms These are things like the following:
1065 \begin_inset Separator latexpar
1072 \begin_layout Itemize
1080 \begin_layout Itemize
1088 \begin_layout Itemize
1092 \begin_inset space ~
1098 \begin_layout Itemize
1102 \begin_inset space ~
1108 \begin_inset Separator latexpar
1115 \begin_layout Standard
1119 \begin_inset space ~
1124 font and, in the case of
1132 , capitalize the first two letters.
1135 \begin_layout Standard
1136 Why are these terms special? They are concepts which the seasoned \SpecialChar LaTeX
1138 is familiar with, but which the new \SpecialChar LyX
1140 I want them to stand out from the rest of the text, hence the use of
1143 \begin_inset space ~
1153 \begin_layout Standard
1154 Seasoned \SpecialChar LyX
1155 Team Members: Are there other terms that require this special
1156 status? On the other hand, should we eliminate this style completely?
1159 \begin_layout Description
1160 Terminology Note the following:
1163 \begin_layout Itemize
1164 \begin_inset Quotes eld
1168 \begin_inset Quotes erd
1172 \begin_inset Quotes eld
1176 \begin_inset Quotes erd
1180 \begin_inset Quotes eld
1184 \begin_inset Quotes erd
1189 \begin_inset Quotes eld
1193 \begin_inset Quotes erd
1197 \begin_inset Quotes eld
1201 \begin_inset Quotes erd
1207 \begin_layout Itemize
1208 PostScript® is a registered trademark of Adobe Corp.
1211 You must put the ® after it or we'll get sued!
1213 I also want it written as seen here, always capitalized.
1215 \begin_inset Quotes eld
1219 \begin_inset Quotes erd
1223 \begin_inset Quotes eld
1227 \begin_inset Quotes erd
1231 \begin_inset Quotes eld
1235 \begin_inset Quotes erd
1238 - both of them capitalized, in the default font (i.
1239 \begin_inset space ~
1243 \begin_inset space \thinspace{}
1247 \begin_inset space ~
1251 If you must, cut and paste it from here.
1252 \begin_inset Separator latexpar
1259 \begin_layout Standard
1260 I am going to say this again:
1263 \begin_layout Standard
1264 \begin_inset VSpace 0.37cm
1270 \begin_layout Standard
1275 You must put the ® after PostScript® or we'll get sued!
1278 \begin_layout Standard
1279 \begin_inset VSpace 0.51cm
1285 \begin_layout Standard
1286 I mean it! American companies like to sue anything that moves.
1291 by forgetting that ®.
1297 \begin_layout Itemize
1298 Similarly, if you use any other registered trademark in any documentation,
1299 put the ® after it, too.
1302 \begin_layout Description
1304 \begin_inset space ~
1307 Items When quick-referencing an item in a menu, use the menu separator:
1309 \begin_inset Quotes eld
1312 \SpecialChar menuseparator
1314 \begin_inset Quotes erd
1320 File\SpecialChar menuseparator
1324 Notice that there are
1329 \begin_inset Quotes eld
1332 \SpecialChar menuseparator
1334 \begin_inset Quotes erd
1340 \begin_inset space ~
1345 , just like the menu and item names.
1346 \begin_inset Separator latexpar
1353 \begin_layout Enumerate
1354 The reason why I want no spaces around the
1355 \begin_inset Quotes eld
1358 \SpecialChar menuseparator
1360 \begin_inset Quotes erd
1363 is to prevent \SpecialChar LyX
1364 from splitting terms across lines.
1365 The same goes for using
1368 \begin_inset space ~
1373 s between multi-word terms.
1374 The split would be visually disruptive.
1377 \begin_layout Enumerate
1379 \begin_inset Quotes eld
1382 \SpecialChar menuseparator
1384 \begin_inset Quotes erd
1387 goes between menu names and item names
1392 (Yes, submenus are okay, too).
1395 \begin_layout Enumerate
1401 \begin_inset Quotes eld
1404 \SpecialChar menuseparator
1406 \begin_inset Quotes erd
1409 between menu items and dialog names.
1411 \begin_inset Quotes eld
1419 ayout\SpecialChar menuseparator
1424 per\SpecialChar menuseparator
1426 \begin_inset space ~
1432 \begin_inset Quotes erd
1437 IS STRICTLY FORBIDDEN!
1440 \begin_inset Separator latexpar
1447 \begin_layout Standard
1453 \begin_inset Quotes eld
1456 \SpecialChar menuseparator
1458 \begin_inset Quotes erd
1461 between popup names and any dialog.
1463 \begin_inset Quotes eld
1469 \begin_inset space ~
1472 Dialog\SpecialChar menuseparator
1480 \begin_inset Quotes erd
1485 IS STRICTLY FORBIDDEN!
1488 \begin_layout Standard
1494 \begin_inset Quotes eld
1497 \SpecialChar menuseparator
1499 \begin_inset Quotes erd
1502 between menu items and any dialog.
1504 \begin_inset Quotes eld
1512 ayout\SpecialChar menuseparator
1517 per\SpecialChar menuseparator
1525 \begin_inset Quotes erd
1530 IS STRICTLY FORBIDDEN!
1533 \begin_layout Standard
1534 Either write out the description, or use context to eliminate any need to
1535 repeat menu items, dialog names, etc.
1540 \begin_layout Description
1542 \begin_inset space ~
1545 Boxes \SpecialChar LyX
1546 has a feature for adding comments that appear only within the \SpecialChar LyX
1549 \begin_inset Note Note
1552 \begin_layout Plain Layout
1553 These should NEVER appear in the manuals.
1559 You will see nothing in a printout of the Style Sheet.
1560 Therefore, they have no place in the manuals.
1563 \begin_inset Separator latexpar
1570 \begin_layout Standard
1571 If you have a parenthetical comment you want to make, the reader should
1572 see it too, even in the printed version.
1573 Use an Author's Note (see section
1574 \begin_inset CommandInset ref
1576 reference "sec:author-notes"
1580 ) in place of the Note-Boxes.
1584 \begin_layout Description
1585 \begin_inset Quotes eld
1590 \begin_inset Quotes erd
1594 \begin_inset space ~
1598 \begin_inset Quotes eld
1603 \begin_inset Quotes erd
1607 \begin_inset space ~
1611 \begin_inset space ~
1615 \begin_inset Quotes eld
1620 \begin_inset Quotes erd
1623 I have recently been corrected about the use of parentheses.
1624 Standard English typesetting uses the normal parentheses,
1625 \begin_inset Quotes eld
1630 \begin_inset Quotes erd
1633 , around any aside, remark, or parenthetical expression.
1635 \begin_inset Quotes eld
1640 \begin_inset Quotes erd
1643 , is used only within quotations (see section
1644 \begin_inset space ~
1648 \begin_inset CommandInset ref
1650 reference "sec:quote"
1656 \begin_inset Quotes eld
1661 \begin_inset Quotes erd
1665 Therefore, never use
1666 \begin_inset Quotes eld
1671 \begin_inset Quotes erd
1675 \begin_inset Quotes eld
1680 \begin_inset Quotes erd
1683 unless otherwise specified by this Style Sheet.
1686 \begin_layout Description
1687 Dashes: Be sure to use the correct one.
1689 \begin_inset Quotes eld
1697 \begin_inset Quotes erd
1700 character is not a dash, it's a hyphen.
1701 Use it only as a hyphen.
1703 \begin_inset Separator latexpar
1710 \begin_layout Standard
1712 \begin_inset Quotes eld
1716 \begin_inset Quotes erd
1720 \begin_inset Quotes eld
1724 \begin_inset Quotes erd
1728 \begin_inset Quotes eld
1736 \begin_inset Quotes erd
1739 characters form the en-dash.
1741 \begin_inset Quotes eld
1749 \begin_inset Quotes erd
1752 characters create an em-dash, which is slightly longer than the en-dash.
1753 In the printed version of any document, \SpecialChar LyX
1754 will combine the two or three
1756 \begin_inset Quotes eld
1764 \begin_inset Quotes erd
1767 characters into a single, unbroken line.
1771 \begin_layout Section
1772 Cross-References and Labels
1775 \begin_layout Standard
1776 Use the following labelling conventions:
1779 \begin_layout Labeling
1780 \labelwidthstring 00.00.0000
1781 sec:xxx Use this for
1800 \begin_layout Labeling
1801 \labelwidthstring 00.00.0000
1802 eqn:xxx Use this for Equations, should you need to create any.
1805 \begin_layout Labeling
1806 \labelwidthstring 00.00.0000
1807 tbl:xxxx Use this for tables inside of a table float.
1810 \begin_layout Labeling
1811 \labelwidthstring 00.00.0000
1812 fig:xxx Use this for figures inside of figure floats.
1815 \begin_layout Standard
1816 Additionally, you should put the label at one of two locations:
1819 \begin_layout Enumerate
1822 beginning of the paragraph
1824 , after a section heading, or at the beginning of captions, etc.
1825 It should be the first thing on the first line.
1826 Don't put a space betweeen it and the first word.
1829 \begin_layout Enumerate
1830 If there is no paragraph after a section heading, put it at the
1832 end of the last line.
1836 \begin_inset Separator latexpar
1843 \begin_layout Standard
1848 which is immediately followed by a
1853 This is a case where you need to put the label at the end of the
1858 I know it looks ugly; not much we can do about that, though.
1862 \begin_layout Section
1863 Content — What Goes Where
1866 \begin_layout Standard
1871 important to anyone documenting a new feature.
1872 If you need to add new documentation, pay attention.
1876 \begin_layout Standard
1877 In the dim and distant past, whenever someone wanted to document a new feature
1878 they added, they either wrote a mini-doc and stuck it into the documentation
1879 directory, or they added a new section to the lone manual.
1880 No one paid much attention to organization in those days, either.
1881 The result was a totally bloated, totally unnavigable, and incomplete manual
1882 orbitted by a swarm of tiny, incomplete mini-docs.
1883 I don't want the docs to fall back into that mess.
1886 \begin_layout Standard
1887 With that in mind, I have some instructions for how to keep things organized:
1890 \begin_layout Labeling
1891 \labelwidthstring 00.00.0000
1896 Please, don't touch this file.
1897 It's essentially complete, anyhow.
1898 Only the editor(s) should make changes to this, as this file contains info
1899 about how to contribute to the doc project.
1900 That's really the only stuff that should need to change, and even then,
1901 only when a new maintainer comes along.
1904 \begin_layout Labeling
1905 \labelwidthstring 00.00.0000
1910 This file is complete.
1911 Any changes should be for updates
1916 DO NOT ADD new features to here willy-nilly.
1917 Let the editor decide if — and when — new sections go in here.
1918 Place any new features in\SpecialChar ldots
1922 \begin_layout Labeling
1923 \labelwidthstring 00.00.0000
1928 This is where all new features go from now on.
1929 It's in the style of a bound journal — each section is an
1930 \begin_inset Quotes eld
1934 \begin_inset Quotes erd
1937 from the author of the feature.
1938 Also, anyone who writes a
1942 file for a new document class should write a section describing that new
1943 class and how to use it.
1944 That also goes here.
1945 \begin_inset Separator latexpar
1952 \begin_layout Standard
1953 Note, however, that you are
1957 excused from following this Style Sheet just because the sections of
1961 are in the form of a journal article.
1965 \begin_layout Labeling
1966 \labelwidthstring 00.00.0000
1971 This file is complete.
1972 Do not change or add to without permission of the Documenation Project
1976 \begin_layout Labeling
1977 \labelwidthstring 00.00.0000
1982 This document describes advanced features, most of which alter the look,
1983 feel, and behavior of \SpecialChar LyX
1985 This manual is still a bit incomplete, although that may change soon.
1986 Check for updates often.
1987 \begin_inset Separator latexpar
1994 \begin_layout Standard
1995 If you are unsure whether or not something belongs in
1999 , then, most-likely, it
2008 Again, let the current editor of the \SpecialChar LyX
2009 documentation decide if your new
2010 section should be migrated to
2018 \begin_layout Labeling
2019 \labelwidthstring 00.00.0000
2024 I'd prefer to completely finish this one before doing anything else, but
2027 keeps changing so much that I think the
2031 will be the last one completed.
2032 However, I'd like it if the developer's would add entries anytime they
2033 create a new function or popup.
2034 That would help things immensely!
2035 \begin_inset Separator latexpar
2042 \begin_layout Standard
2047 follows this Style Sheet for the most part.
2048 There are, however, additional rules to follow when making new entries.
2049 At the top of this manual, there are examples of and a template for
2058 \begin_layout Section
2059 Writing Style: The Primary Manuals
2062 \begin_layout Standard
2063 While I want to make contributing to the Documentation Project as painless
2064 as possible for newcomers, I also want the newcomers to be painless on
2065 the existing Documentation Team! Ergo, I've written this section to give
2066 some flavor to guide everyone's individual style.
2070 \begin_layout Subsection
2074 \begin_layout Standard
2075 All contributions to the
2080 documentation must be in English.
2081 I don't care if it's British, Australian, or American English.
2082 The DocTeam editor will proofread for glaring mistakes and fix them.
2085 \begin_layout Standard
2086 Don't get hung up on semantics.
2087 English is a flexible language, and just because your Mothertongue-to-English
2088 dictionary gives only one translation for a word doesn't necessarily mean
2090 We've had some discussions and misunderstandings on the Developers' List
2091 because of this very problem.
2092 If something is unclear (or just plain weird) due to a translation problem,
2093 one of the American/British/Australian developers can fix it.
2096 \begin_layout Standard
2101 documentation, I exclude the translations.
2102 We usually don't have enough people to cover the manuals in one language,
2103 let alone more than one.
2104 Subsequently, the tranlsations are just that — translations of the English
2105 version of the \SpecialChar LyX
2107 The translation efforts require have their own set of guidelines.
2109 \begin_inset CommandInset ref
2111 reference "sec:translations"
2118 \begin_layout Subsection
2120 \begin_inset Newline newline
2123 Commentary from the Author (i.
2124 \begin_inset space ~
2130 \begin_layout Standard
2131 \begin_inset CommandInset label
2133 name "sec:author-notes"
2137 I want to make it easy for everyone when it comes to documenting things.
2138 Some features are incomplete.
2139 Some, you might not know everything about.
2140 Sometimes, you may want to comminucate something to me or the reader or
2141 other DocTeam members.
2142 Sometimes, you may want to
2143 \begin_inset Quotes eld
2147 \begin_inset Quotes erd
2150 you want to say something that is your personal opinion and using
2151 \begin_inset Quotes eld
2155 \begin_inset Quotes erd
2158 would be inappropriate.
2161 \begin_layout Standard
2162 In short, when you contribute to the \SpecialChar LyX
2163 Docs, you wear many hats.
2166 \begin_layout Standard
2167 For occasions when you need to switch hats, I've designed some special mechanism
2171 \begin_layout Subsubsection
2173 \begin_inset space ~
2177 \begin_inset Quotes eld
2181 \begin_inset Quotes erd
2187 \begin_layout Standard
2188 These are footnotes.
2189 They begin with the following:
2200 \begin_layout Standard
2206 for the person's name and without the quotes.
2207 The rest of the footnote is the actual comment.
2211 \begin_layout Standard
2212 Use these when you need to quote a comment by someone (usually yourself),
2213 and need to identify that person.
2214 This includes occasions when you need wear the
2215 \begin_inset Quotes eld
2219 \begin_inset Quotes erd
2223 \begin_inset space ~
2227 \begin_inset space ~
2230 to speak for yourself instead of for the \SpecialChar LyX
2234 \begin_layout Standard
2235 If the comment is too large to put in a footnote, don't use a Personal Note.
2236 When quoting more than about 3 sentences or 5 lines of text, use a bona
2238 Don't use any leading
2239 \begin_inset Quotes eld
2247 \begin_inset Quotes erd
2251 In a real quote, you'll give credit to the original speaker in either the
2252 paragraph before or after the body of the
2259 \begin_layout Subsubsection
2261 \begin_inset space ~
2265 \begin_inset Quotes eld
2269 \begin_inset Quotes erd
2275 \begin_layout Standard
2276 There will be times when you are not speaking for the \SpecialChar LyX
2278 not entirely speaking for yourself.
2279 Instead, you are speaking on behalf of the manual itself, as the author
2281 Some examples of when you might need to do this are:
2284 \begin_layout Itemize
2285 You need to contradict something you just wrote because the feature isn't
2286 quite ready yet, but you wanted to document what it will do.
2289 \begin_layout Itemize
2290 You need to leave a note for yourself.
2293 \begin_layout Itemize
2294 You need to leave a note for the editor or the other DocTeam members.
2297 \begin_layout Itemize
2298 You need to point out something about the manuals to the reader, something
2299 that doesn't fit into the context of the current paragraph.
2302 \begin_layout Standard
2303 At such times, you are wearing your
2304 \begin_inset Quotes eld
2308 \begin_inset Quotes erd
2314 \begin_layout Standard
2315 The typography for an
2316 \begin_inset Quotes eld
2320 \begin_inset Quotes erd
2326 \begin_layout Itemize
2327 They go in the body of the text, in brackets,
2328 \begin_inset Quotes eld
2332 \begin_inset Quotes erd
2335 , not any other form of parentheses.
2336 The bracket are in the default character style.
2339 \begin_layout Itemize
2340 The text of the note itself, however, is emphasized.
2344 \begin_layout Itemize
2345 Begin with the words,
2346 \begin_inset Quotes eld
2354 \begin_inset Quotes erd
2357 and end with an em-dash,
2358 \begin_inset Quotes eld
2362 \begin_inset Quotes erd
2365 , followed by your initials.
2369 \begin_layout Standard
2370 Here's an example: [
2372 Author's Note: This is an example note.
2378 \begin_layout Standard
2379 The form of the Author's Note, by the way, isn't a suggestion or request.
2385 All Author's Notes must begin with this text, verbatim:
2386 \begin_inset Quotes eld
2394 \begin_inset Quotes erd
2399 \begin_inset Quotes eld
2403 \begin_inset Quotes erd
2406 are or any other variant are forbidden.
2407 The Author's Note must end with an em-dash, which is 3
2408 \begin_inset Quotes eld
2412 \begin_inset Quotes erd
2416 \begin_inset Quotes eld
2420 \begin_inset Quotes erd
2425 \begin_inset Quotes eld
2429 \begin_inset Quotes erd
2432 ; you must use 3 (and 5 is right out).
2435 \begin_layout Standard
2436 \begin_inset Quotes eld
2440 \begin_inset Quotes erd
2443 are inherently transient, and should disapear as a manual matures.
2446 \begin_layout Subsubsection
2450 \begin_layout Standard
2451 You are also free to use footnotes on their own in addition to the Personal
2452 Notes and/or Author's Notes.
2453 I've frequently used footnotes to \SpecialChar ldots
2454 well, to comment on parts of a section
2455 without putting the commentary into the body of the text.
2458 \begin_layout Paragraph*
2459 Mixing Footnotes and Personal Notes
2462 \begin_layout Standard
2463 Personal Notes always go in footnotes, and should be 5 lines or fewer.
2464 Any larger quotation should be quoted properly, using the rules of standard
2470 paragraph environment.
2473 \begin_layout Paragraph*
2474 Mixing Footnotes and Author's Notes
2477 \begin_layout Standard
2478 Author's Notes should
2486 \begin_layout Paragraph*
2487 Mixing Personal Notes and Author's Notes
2490 \begin_layout Standard
2491 Forbidden; these two are mutually exclusive.
2494 \begin_layout Subsubsection
2498 \begin_layout Itemize
2500 \begin_inset Newline newline
2507 opinion — yours or another \SpecialChar LyX
2508 developer's — about anything.
2509 Anywhere in the manuals you wish to speak for yourself instead the the
2512 If you have a long rant, however, quote yourself (see section
2513 \begin_inset space ~
2517 \begin_inset CommandInset ref
2519 reference "sec:quote"
2526 \begin_layout Itemize
2528 \begin_inset Newline newline
2531 Use this to describe things in \SpecialChar LyX
2532 (or the manuals) that may change in the
2533 future or are somehow incomplete.
2534 Author's Notes are supposed to disappear as a manual matures.
2537 \begin_layout Itemize
2539 \begin_inset Newline newline
2542 Used for text fragments that almost fit into the flow of the text\SpecialChar ldots
2547 \begin_layout Standard
2548 When using these three mechanisms, in addition to rigorously following their
2549 descriptions, please use them properly.
2550 I listed some additional restrictions previously.
2551 Some of you may balk at these restrictions.
2552 Nevertheless, there is a reason for them: if you have an overwhemling desire
2553 to mix or modify footnotes, Personal Notes, and Author's Notes, you shouldn't
2554 be using any of them.
2555 More specifically, you're trying to use a hammer to drive in a screw.
2556 What you want to say probably needs to go into the main body of the text.
2559 \begin_layout Subsection
2560 General Stylistic Guidelines
2563 \begin_layout Standard
2564 Everything in this section is
2566 mandatory to all documenters
2568 , regardless the language you're writing in.
2572 \begin_layout Subsubsection
2576 \begin_layout Enumerate
2577 Use the typography rules outlined in the beginning sections of this document.
2580 \begin_layout Enumerate
2581 Don't, however, mimic the typography of this file.
2582 Yes, the Style Sheet doesn't follow the Style Sheet (grin).
2585 \begin_layout Enumerate
2586 There is some typographic freedom in those rules in earlier sections.
2587 Use that freedom wisely.
2588 Most importanly, never sacrifice the online appearance for the printed
2589 appearance and vice versa.
2590 \begin_inset Separator latexpar
2597 \begin_layout Standard
2598 An example is in the
2603 There is a footnote using the
2607 command to divide a long
2611 environment into 3 columns.
2612 It adds some \SpecialChar LaTeX
2613 commands to the online version, the so-called
2614 \begin_inset Quotes eld
2618 \begin_inset Quotes erd
2621 that some so vehemently oppose.
2622 Without it, however, that footnote takes up over two pages, most of which
2624 This is an example of permitting a little ugliness in the online version
2625 to get the printed version to look right.
2629 \begin_layout Enumerate
2630 When in doubt, compromise.
2631 \begin_inset Separator latexpar
2638 \begin_layout Standard
2639 When in doubt, use good judgement.
2643 \begin_layout Subsubsection
2647 \begin_layout Enumerate
2649 \begin_inset Quotes eld
2653 \begin_inset Quotes erd
2657 \begin_inset Separator latexpar
2664 \begin_layout Standard
2665 When you speak, you speak for the entire \SpecialChar LyX
2667 \begin_inset Quotes eld
2671 \begin_inset Quotes erd
2675 \begin_inset Quotes eld
2679 \begin_inset Quotes erd
2686 \begin_layout Enumerate
2688 \begin_inset Quotes eld
2692 \begin_inset Quotes erd
2696 \begin_inset Separator latexpar
2703 \begin_layout Standard
2704 Whenever you want to say something to the reader, use
2705 \begin_inset Quotes eld
2709 \begin_inset Quotes erd
2712 not some contorted construction to avoid being too informal.
2717 \begin_layout Enumerate
2719 \begin_inset Quotes eld
2723 \begin_inset Quotes erd
2726 for both the physical pointing object (mouse, joystick, touch pad, track
2727 ball, etc.) and the mouse cursor which the physical object moves about the
2731 \begin_layout Enumerate
2733 \begin_inset Quotes eld
2737 \begin_inset Quotes erd
2740 for the little blinking vertical bar that indicates where text can/will
2744 \begin_layout Enumerate
2745 When in doubt, compromise.
2746 \begin_inset Separator latexpar
2753 \begin_layout Standard
2754 When in doubt, use good judgement.
2758 \begin_layout Subsubsection
2759 \begin_inset CommandInset label
2765 Quoting Yourself and Others
2768 \begin_layout Standard
2769 In some cases, you'll have something to say, an opinion of yours.
2770 Since this is your opinion, you're not speaking for the \SpecialChar LyX
2772 You have so much to say, in fact, that it won't fit into a Personal Note
2773 or an Author's Note.
2774 In these cases you want to quote yourself.
2777 \begin_layout Standard
2778 Any time you wish to quote someone, be it yourself or someone else, there
2779 are standard rules one follows.
2780 Every language has its own rules.
2781 You should follow the rules that apply to the language of the document
2782 to which you are contributing.
2786 \begin_layout Standard
2787 This creates a problem for the primary documentation.
2788 The primary documentation is written in English, yet the contributors come
2789 from many countries.
2790 The quoting rules for English (well, American English, at least) are outlined
2794 \begin_inset space ~
2799 , for your convenience.
2800 Read them if you need to.
2803 \begin_layout Standard
2804 \begin_inset Float figure
2810 \begin_layout Plain Layout
2811 Quoting rules for English:
2814 \begin_layout Itemize
2815 The body of the quote belongs in a
2822 \begin_layout Itemize
2823 The sentences prior to the quote should flow logically and smoothly into
2827 \begin_layout Itemize
2828 The sentences immediately following the quote should continue the flow of
2832 \begin_layout Itemize
2837 credit the original author of the quote in the sentences immediately before
2841 \begin_layout Itemize
2842 Crediting the original author of the quote should not, however, disrupt
2843 the flow of the text.
2846 \begin_layout Itemize
2847 If you omit text from the beginning of the first sentence in the quote,
2848 the quote must start with the text
2849 \begin_inset Quotes eld
2854 \begin_inset Quotes erd
2858 This is an ellipsis in square brackets.
2861 \begin_layout Itemize
2862 If you omit text from the end of the last sentence in the quote, the quote
2863 must end with the text
2864 \begin_inset Quotes eld
2869 \begin_inset Quotes erd
2872 followed by the sentence's punctuation mark.
2875 \begin_layout Itemize
2876 If you omit any text from the middle of the quote, be it whole sentences
2877 or parts of sentences, replace it with the text
2878 \begin_inset Quotes eld
2883 \begin_inset Quotes erd
2889 \begin_layout Itemize
2890 The quote must be grammatically correct.
2892 \begin_inset Separator latexpar
2899 \begin_layout Itemize
2900 If the original is wrong, you must correct it.
2903 \begin_layout Itemize
2904 If omitting part of the quote
2905 \begin_inset Quotes eld
2909 \begin_inset Quotes erd
2912 it, you must correct the problem.
2915 \begin_layout Itemize
2916 For missing words (e.
2917 \begin_inset space ~
2921 \begin_inset space ~
2925 \begin_inset Quotes eld
2929 \begin_inset Quotes erd
2932 goes missing), place the word in square brackets,
2933 \begin_inset Quotes eld
2938 \begin_inset Quotes erd
2941 and insert in the quote where needed.
2944 \begin_layout Itemize
2945 For mangled word order, correct the mangled text, following it with the
2947 \begin_inset Quotes eld
2951 \begin_inset Quotes erd
2958 \begin_layout Itemize
2959 Spelling in the quote must be correct.
2960 Correct any misspelled words and place the text
2961 \begin_inset Quotes eld
2965 \begin_inset Quotes erd
2968 after the corrected word.
2971 \begin_layout Itemize
2972 Back-to-back bracket blocks merge together.
2974 \begin_inset Quotes eld
2979 \begin_inset Quotes erd
2984 \begin_inset Quotes eld
2989 \begin_inset Quotes erd
2995 \begin_layout Itemize
2996 If you correct the spelling in 2 or more consecutive words, you can get
2998 \begin_inset Quotes eld
3002 \begin_inset Quotes erd
3005 after the last mistake.
3013 \begin_layout Subsubsection
3017 \begin_layout Standard
3018 When describing a new feature or
3025 \begin_layout Enumerate
3036 \begin_inset Quotes eld
3039 Keep It Short and Sweet
3040 \begin_inset Quotes erd
3044 \begin_inset Quotes eld
3047 Keep It Simple, Stupid!
3048 \begin_inset Quotes erd
3052 \begin_inset Separator latexpar
3059 \begin_layout Itemize
3064 write paragraph after paragraph of verbage.
3068 \begin_layout Itemize
3072 \begin_layout Itemize
3073 Take a look at the manual for a commercial word processor — it's a fine
3078 to write documentation.
3079 It's all pithy, substanceless verbage, and its
3087 \begin_layout Enumerate
3088 Avoid being pedantic like The Plague!
3091 \begin_layout Enumerate
3092 In the same vein, don't write more than you have to.
3093 You're not working in a vacuum — refer freely to other parts of the manual
3094 (and other parts of other manuals).
3096 \begin_inset Quotes eld
3099 other part of the manual
3100 \begin_inset Quotes erd
3103 is incomplete or empty, refer to it.
3104 Someone will fill it in eventually.
3107 \begin_layout Enumerate
3108 On the other hand, BE THOROUGH!
3109 \begin_inset Separator latexpar
3116 \begin_layout Enumerate
3121 , not widgets, not how the source code is organized.
3124 \begin_layout Enumerate
3125 Group by feature, not by widget.
3128 \begin_layout Enumerate
3142 s and further subdivisions to group things if you're documenting several
3143 related features in a single
3150 \begin_layout Enumerate
3151 Describe EVERYTHING related to that feature, no matter where it is.
3152 \begin_inset Separator latexpar
3159 \begin_layout Enumerate
3160 Example: Paragraph Indenting.
3161 Several popups control its behavior.
3166 of this: which popups control it, when you use which setting on which popup
3167 to do which operation, et cetera.
3170 \begin_layout Enumerate
3176 \begin_inset Newline newline
3179 I've had people only document one popup — literally.
3180 This added off-topic information and only described half of the feature,
3181 since other menus, popups, and even unbound functions contained additional
3183 \begin_inset Newline newline
3190 cranky when that happens, because it means
3195 Bad help is worse than no help at all.
3196 \begin_inset Separator latexpar
3203 \begin_layout Standard
3204 These remarks still hold true: you'll piss of the DocTeam editor if you
3205 do things wrong, because he'll have to fix your mistakes.
3210 \begin_layout Enumerate
3211 Remember, there are people who will reference
3215 section, just as you're referencing someone else's.
3216 You do want what you write to be useful, don't you?
3220 \begin_layout Enumerate
3221 When in doubt, compromise.
3222 \begin_inset Separator latexpar
3229 \begin_layout Standard
3230 When in doubt, use good judgement.
3234 \begin_layout Subsubsection
3239 Treat the Reader as if She is Stupid
3242 \begin_layout Enumerate
3246 \begin_layout Enumerate
3247 No talking down to the reader.
3250 \begin_layout Enumerate
3251 The reader is smart enough to know what a mouse is.
3254 \begin_layout Enumerate
3255 The reader is smart enough to know how to use a keyboard, including the
3269 (The introduction of most of the manuals takes care of the
3270 \begin_inset Quotes eld
3282 \begin_inset Quotes erd
3285 issue, so you don't need to.)
3288 \begin_layout Enumerate
3289 The reader is smart enough to know that
3290 \begin_inset Quotes eld
3294 \begin_inset Quotes erd
3298 \begin_inset Quotes eld
3301 where the text cursor is sitting right now, in the buffer currently visible.
3302 \begin_inset Quotes erd
3307 (Anything more than the word
3308 \begin_inset Quotes eld
3312 \begin_inset Quotes erd
3315 is, IMO, superfluous and wll be deleted .
3316 So, save yourself the typing, save the editor the cutting, and save the
3317 reader the strain of sifting through extra verbage that adds no content.)
3320 \begin_layout Enumerate
3321 Rule of thumb: the reader is not an imbecile.
3322 The reader is merely lost; point them in the right direction, and they
3323 can take it from there.
3326 \begin_layout Subsection
3327 Tips for the English Version
3330 \begin_layout Standard
3331 \begin_inset CommandInset label
3333 name "sec:english-only"
3337 When contributing to the primary — i.
3338 \begin_inset space ~
3342 \begin_inset space ~
3345 the English language version — of the \SpecialChar LyX
3346 manuals, keep the following in mind.
3349 \begin_layout Subsubsection
3350 Write as if You're Talking with a Friend.
3354 \begin_layout Enumerate
3355 Think that way when you write.
3356 Play the dialogue in your mind.
3359 \begin_layout Enumerate
3360 Be as informal as you please (without being rude).
3363 \begin_layout Subsubsection
3364 AVOID the Passive Voice
3367 \begin_layout Enumerate
3369 \begin_inset Quotes eld
3372 It is felt that this name best explains the command's purpose.
3373 \begin_inset Quotes erd
3376 We know full well who wrote the command:
3377 \begin_inset Quotes eld
3380 The \SpecialChar LyX
3382 \begin_inset Quotes erd
3386 \begin_inset Quotes eld
3390 \begin_inset Quotes erd
3396 \begin_layout Enumerate
3397 Things don't happen by magic - somebody or something did it.
3398 Only politicians use the passive voice to cover up who did something.
3400 reformats a paragraph, write,
3401 \begin_inset Quotes eld
3405 reformatted the paragraph.
3406 \begin_inset Quotes erd
3413 makes changes, write,
3414 \begin_inset Quotes eld
3421 changes the document.
3422 \begin_inset Quotes erd
3426 \begin_inset Separator latexpar
3433 \begin_layout Standard
3434 Rule of thumb: any sentence you can express as,
3435 \begin_inset Quotes eld
3439 \begin_inset Quotes erd
3443 \begin_inset Quotes eld
3447 \begin_inset Quotes erd
3454 \begin_layout Enumerate
3456 We all hear way, way too much garbage English on the TV every day in the
3458 Some people think it makes speech better.
3460 It makes speech baroque, if not outright byzantine.
3461 With a little effort, you can wean yourself off of it.
3464 \begin_layout Enumerate
3467 will make you rewrite
3469 anything in the passive voice.
3470 It's awkward and hard to read.
3473 \begin_layout Enumerate
3474 Note to non-Americans:
3475 \begin_inset Separator latexpar
3482 \begin_layout Standard
3483 Using passive voice is generally considered bad style in the U.
3484 \begin_inset space ~
3488 \begin_inset space ~
3491 as it is too easy to obfuscate your words with it.
3492 It also bloats sentences, often unnecessarily.
3496 \begin_layout Subsubsection
3501 \begin_layout Standard
3502 In English, there is a grammatical error known as the
3503 \begin_inset Quotes eld
3507 \begin_inset Quotes erd
3510 The classic example of a run-on sentence is 7 clauses strung together with
3512 \begin_inset Quotes eld
3516 \begin_inset Quotes erd
3519 There are, however, less obvious run-on sentences, ones using too many
3520 subordinate clauses.
3521 Such sentences may look elegant because they are complex.
3522 However, they are also extremely difficult to read because they are so
3526 \begin_layout Standard
3527 In general, stick to short sentences in written English.
3528 Getting rid of passive voice (
3529 \begin_inset Quotes eld
3533 was done by\SpecialChar ldots
3535 \begin_inset Quotes erd
3538 ) shortens and simplifies them.
3539 Hacking apart sentences with many dependent clauses is another way to shorten
3541 There are ways to do this yet still have a smooth-flowing paragraph.
3544 \begin_layout Standard
3545 While I'm talking about paragraphs, I'll apply the
3546 \begin_inset Quotes eld
3550 \begin_inset Quotes erd
3553 motto to them, as well.
3554 At the time I started with the manuals (and this Style Sheet), I didn't
3555 pay too much attention to paragraph size.
3556 I've since become a big proponent of short paragraphs, with one idea per
3558 While long, flowing, multi-concept paragraphs can be nice in novels, we're
3560 Our goal is rapid information location and comprehension, not a literary
3564 \begin_layout Standard
3565 There is a single exception to the short sentence, short paragraph rule.
3566 Particularly complex ideas may need more
3567 \begin_inset Quotes eld
3571 \begin_inset Quotes erd
3574 However, you shouldn't encounter such complex ideas often when documenting
3577 Try to keep things short, and use your judgement as needed.
3580 \begin_layout Standard
3581 To reiterate, yet again, something I said before:
3585 When in doubt, compromise.
3589 When in doubt, use good judgement.
3592 \begin_layout Standard
3593 Hopefully, you've got the idea (grin).
3596 \begin_layout Section
3600 \begin_layout Subsection
3601 Rules of the Translating Trade
3604 \begin_layout Standard
3605 While translating anything, there are certain
3606 \begin_inset Quotes eld
3610 \begin_inset Quotes erd
3614 They will help you greatly.
3617 \begin_layout Subsubsection
3618 Translate one paragraph at a time.
3621 \begin_layout Standard
3622 Most people translate word by word.
3623 Clearly, you lose all context if you do that.
3624 A word may have multiple meanings.
3625 You can't tell which unless you look at the rest of the sentence.
3628 \begin_layout Standard
3629 There is another level to the context issue, however.
3630 Your dictionary may translate multiple English words the same way.
3631 All those words mean
3636 Each one, however, covers a different shade of meaning, a different mood
3638 It is often difficult to resolve those shades of meaning in the context
3639 of even one sentence.
3640 A paragraph, however, will provide that context.
3643 \begin_layout Subsubsection
3644 You will not translate it correctly on the first try.
3647 \begin_layout Standard
3648 Alright, I admit that you may be able to translate some of the sentences
3650 If you know a language well, you may even understand over half of the text.
3651 Nevertheless, overconfidence can lead you astray.
3652 There will be some sentences, no matter how few, that will simply confound
3656 \begin_layout Standard
3657 It is generally a good idea to make multiple passes over a paragraph you're
3659 Even if you translate the entire paragraph on the first pass, make a second
3661 You'll often improve upon your first attempt.
3664 \begin_layout Subsubsection
3665 When in doubt, write down all of the meanings for a word.
3668 \begin_layout Standard
3669 You can often translate tricky parts of a text using the context of the
3670 surrounding sentences.
3671 So, if you hit a word or phrase you don't know, translate it more than
3673 Picking the most likely translations, summarize them in one to three words
3675 \begin_inset Quotes eld
3679 \begin_inset Quotes erd
3686 \begin_layout Subsubsection
3687 Using context, fix the meanings on the next pass.
3690 \begin_layout Standard
3691 This is where your multiple translations of a single word become useful.
3692 Using the other sentences you translated, you can now translate that mystery–se
3693 ntence without reconsulting your dictionary.
3696 \begin_layout Subsubsection
3697 Fix the grammar only after you've finished translating the sentence.
3700 \begin_layout Standard
3701 If there's a mystery phrase in the middle of a sentence, you can't translate
3702 the entire sentence.
3703 Why grammatically rearrange the words you translated already? You may need
3704 to restructure the sentence a second time once you figure out how to translate
3705 that mystery phrase.
3706 Better to wait until you've completely translated the sentence to clean
3708 That way, you do so only once.
3711 \begin_layout Subsubsection
3712 If you can't translate it, skip it and come back to it on the next pass.
3715 \begin_layout Standard
3716 Remember the earlier discussion of context and its immense usefulness? There
3717 is no sin in making multiple passes over a tricky passage.
3720 \begin_layout Subsubsection
3721 Translate the meaning first.
3725 \begin_layout Standard
3726 The information content of the text under translation is the most important
3728 This is especially important for a manual, where the information
3732 important part of the original document.
3733 Lose that, and you lose the very point of performing the translation.
3736 \begin_layout Subsection
3737 Tips for the Translators
3740 \begin_layout Standard
3741 Those of you contributing to a translation of the \SpecialChar LyX
3742 manuals must follow a
3743 modified set of rules.
3744 The first few rules are analogous to those in section
3745 \begin_inset space ~
3749 \begin_inset CommandInset ref
3751 reference "sec:english-only"
3756 There are additional rules and regulations that follow those first few.
3760 \begin_layout Subsubsection
3761 Write as if you are explaining \SpecialChar LyX
3762 to a colleague you know well.
3765 \begin_layout Enumerate
3766 Think that way when you write.
3767 Play the dialogue in your mind.
3770 \begin_layout Enumerate
3771 Use a conversational style in your writing.
3772 Pretend you are teaching \SpecialChar LyX
3773 to a colleague you know well.
3776 \begin_layout Enumerate
3777 Use a style that is polite without being too formal.
3778 If, in your culture, informal language is appropriate to use with a colleague,
3779 use informal speech in the translation of the manual.
3782 \begin_layout Subsubsection
3783 AVOID Snobby, Academic, Specialized, or
3784 \begin_inset Quotes eld
3788 \begin_inset Quotes erd
3795 \begin_layout Standard
3796 In English, the passive voice appears formal, dry, barren.
3797 It also often adds unnecessary complexity.
3798 In other langauges, however, this is not the case.
3799 There is nothing wrong with passive voice, and people use it frequently
3800 in everyday conversation.
3801 Nevertheless, your translation of the \SpecialChar LyX
3803 \begin_inset Quotes eld
3807 \begin_inset Quotes erd
3813 \begin_layout Standard
3814 In Germany, there is a magazine known as
3815 \begin_inset Quotes gld
3819 \begin_inset Quotes grd
3822 The writing in it is so complex, it is extremely difficult for non-native
3823 German speakers to understand.
3824 While sophisticated, the writing style of
3825 \begin_inset Quotes gld
3829 \begin_inset Quotes grd
3832 is not what a German uses in everyday conversation.
3833 Nor is the writing style for a Russian mathematics journal.
3834 Such specialized or overly-sophisticated styles are
3835 \begin_inset Quotes eld
3839 \begin_inset Quotes erd
3842 in the sense that they are seldom used by normal people in everyday speech.
3845 \begin_layout Standard
3846 We who write the \SpecialChar LyX
3847 manuals, original or translated, seek to
3852 If we write in a style only a few people use, and use seldomly, we will
3854 Use a writing style that mirrors everyday speech (without being vulgar,
3859 \begin_layout Subsubsection
3860 Keep the Writing Simple.
3863 \begin_layout Standard
3864 For the English version, I wrote,
3865 \begin_inset Quotes eld
3868 Use short sentences and short paragraphs.
3869 \begin_inset Quotes erd
3872 What if, however, short sentences and paragraphs are something only children
3873 use in your language? What if, in yet another language, short sentences
3874 imply rudeness? Naturally, you would not want to use them in your translation.
3877 \begin_layout Standard
3878 Nevertheless, the translations of the \SpecialChar LyX
3879 manuals should be as clear as the
3881 So, for our international colleagues, we apply this rule: Keep your sentences
3882 and paragraphs as short as makes sense.
3885 \begin_layout Standard
3886 Remember: we're translating manuals here, folks.
3887 Our goal is rapid information location and comprehension, not a literary
3889 Try to keep your writing concise yet smooth-flowing.
3890 And use your judgement as needed:
3894 When in doubt, compromise.
3898 When in doubt, use good judgement.
3901 \begin_layout Subsubsection
3902 Translators must follow the Style Sheet, too!
3905 \begin_layout Standard
3906 Everything in this manual —
3909 \begin_inset space ~
3913 \begin_inset CommandInset ref
3915 reference "sec:english-only"
3921 — applies to every \SpecialChar LyX
3922 documenter, no matter what the language.
3925 \begin_layout Subsubsection
3926 Translators must read the Style Sheet Supplement for their language.
3929 \begin_layout Standard
3930 For every translation project, there is a Supplement to the Style Sheet.
3937 DocStyle_Supplement_<cn>.lyx
3940 \begin_layout Standard
3943 \begin_inset Quotes eld
3951 \begin_inset Quotes erd
3954 is your language's two-letter locale code.
3955 The Translation Project Chief for your language wrote this.
3956 If he hasn't, pester him to do so! <
3963 \begin_layout Subsubsection
3964 The English versions of the manuals are not Sacred Text.
3967 \begin_layout Standard
3968 You do not need to translate everything word for word.
3969 In fact, you shouldn't.
3970 Keep to the spirit of the originals, not the letter.
3971 Be as creative as you want, as long as you
3979 convey all of the information contained in the English versions.
3982 \begin_layout Subsubsection
3983 Any information in the \SpecialChar LyX
3984 manuals must also be in the translations.
3987 \begin_layout Standard
3988 \begin_inset CommandInset label
3994 This falls under translating the orignals accurately and completely.
3998 \begin_layout Itemize
3999 Omitting any feature description is
4006 \begin_layout Itemize
4007 Misrepresenting or misdescribing any \SpecialChar LyX
4008 feature or operation
4015 \begin_layout Itemize
4020 outpace the original.
4021 \begin_inset Newline newline
4024 If no one has documented new feature in the primary \SpecialChar LyX
4026 \begin_inset space ~
4030 \begin_inset space ~
4033 the English versions), do not do so in the translations.
4034 If you're really looking for something to do, either:
4035 \begin_inset Separator latexpar
4042 \begin_layout Itemize
4044 focus on translating something you haven't yet,
4045 \begin_inset Newline newline
4051 \begin_layout Itemize
4053 update or repair the primary manual.
4056 \begin_layout Standard
4057 If you cannot or do not want to do one of the above, then take a break.
4059 Wait for the main manuals to catch up before translating anything else.
4063 \begin_layout Subsubsection
4064 What you cannot translate, you may omit (usually).
4067 \begin_layout Standard
4068 Prepositions, idioms, metaphors, slang, Oh My! There's a jungle of potentially
4069 untranslatable text you may face.
4070 Happily, none of these untranslatables are essential to the original text\SpecialChar ldots
4073 If you can't translate a phrase or two, try omitting them.
4074 If the rest of the paragraph still makes sense, then don't worry about
4078 \begin_layout Standard
4079 There may be special cases where omitting part of a sentence or paragraph
4081 \begin_inset space ~
4085 \begin_inset CommandInset ref
4087 reference "sec:accuracy"
4096 You must try and translate those tricky spots.
4099 \begin_layout Subsubsection
4100 Translators may add their own fluff to the information content.
4103 \begin_layout Standard
4104 After you do strip away all of the idioms, metaphors, slang, humor, and
4106 \begin_inset Quotes eld
4110 \begin_inset Quotes erd
4113 you may find that your translated manual is dull and dry.
4114 Why not add your own fluff? Add text that makes the manual a pleasure to
4115 read, that engages the reader.
4116 It may take the form of humor, or metaphors, or sayings.
4117 Whatever you add, it should be
4118 \begin_inset Quotes eld
4122 \begin_inset Quotes erd
4125 It should not clash with the explanation of \SpecialChar LyX
4126 features and functions.
4129 \begin_layout Subsection
4130 For Translation Project Chiefs
4133 \begin_layout Subsubsection
4134 The First Is In Charge
4137 \begin_layout Standard
4138 If you were the first person to start translating the manuals, you're the
4140 Doc Translation Project Chief for your language.
4145 person translating the \SpecialChar LyX
4146 Docs, that automatically makes you the Translation
4150 \begin_layout Standard
4151 Amongst other things, that means that you must read this section and perform
4152 the tasks described here.
4155 \begin_layout Standard
4156 If you are a member of a \SpecialChar LyX
4157 Documentation Translation Team, but
4161 its Chief, you may stop reading.
4162 The remainder of this section will be of no interest to you.
4163 If you came to the Style Sheet from the Supplement for your language, you
4167 \begin_layout Standard
4168 If you have not read the Style Sheet Supplement for your language, you should
4173 \begin_layout Subsubsection
4174 Read the Style Sheet
4177 \begin_layout Standard
4178 No documenter is excused from following the Style Sheet, not even a Translation
4182 \begin_layout Standard
4187 important that the Translation Project Chiefs read the Style Sheet.
4190 \begin_layout Subsubsection
4191 Make your translators read the Style Sheet
4194 \begin_layout Standard
4195 No documenter is excused from following the Style Sheet.
4198 \begin_layout Standard
4199 Since your translation team is translating, they know
4204 Therefore, they should be able to read the Style Sheet.
4207 \begin_layout Subsubsection
4209 \begin_inset Quotes eld
4213 \begin_inset Quotes erd
4219 \begin_layout Standard
4220 There are parts of this Style Sheet that are English-specific.
4221 I have tried to provide a general, language-independent description of
4222 certain details in this section.
4223 Unfortunately, that general description doesn't cover the specifics of
4228 \begin_layout Standard
4229 That's where you, as head of a \SpecialChar LyX
4230 Doc Translation Team, come in.
4233 \begin_layout Standard
4234 Every Translation Team Chief is
4238 to write a Supplement to the official Documentation Style Sheet, with specifics
4239 issues affecting your language.
4240 (You are, after all, the \SpecialChar LyX
4241 Team expert on your native tongue.) Follow these
4242 guidelines when writing the Supplement:
4245 \begin_layout Enumerate
4247 \begin_inset Newline newline
4252 DocStyle_Supplement_<cn>.lyx
4255 \begin_inset Newline newline
4260 \begin_inset Quotes eld
4268 \begin_inset Quotes erd
4271 is the two-letter code for your language.
4272 This is the same two-letter code that is part of the filenames for the
4275 \begin_inset Quotes eld
4283 \begin_inset Quotes erd
4287 \begin_inset Quotes eld
4295 \begin_inset Quotes erd
4299 \begin_inset Quotes eld
4307 \begin_inset Quotes erd
4313 \begin_layout Enumerate
4314 Do not worry about where the file goes.
4315 The CVS maintainers will locate all documentation and Style Sheet Supplements
4316 in an appropriate place.
4319 \begin_layout Enumerate
4320 Document Properties:
4321 \begin_inset Separator latexpar
4328 \begin_layout Itemize
4329 For consistency, use the same document class and other document properties
4334 \begin_layout Plain Layout
4335 Specifically, check the settings in the
4340 Use those in your Supplement.
4348 \begin_layout Itemize
4349 Exceptions: Use margins, indentation/paragraph separation, language, and
4350 encoding appropriate for your language.
4354 \begin_layout Enumerate
4355 The title of the Supplement:
4356 \begin_inset Separator latexpar
4363 \begin_layout Itemize
4364 The title will use the
4365 \begin_inset Quotes eld
4373 \begin_inset Quotes erd
4376 paragraph environment.
4377 In your native tongue, the title will read:
4378 \begin_inset Separator latexpar
4385 \begin_layout Standard
4388 Documentation Project Style Sheet:
4389 \begin_inset Newline newline
4392 Supplement for the <foo> Translation Project
4395 \begin_layout Standard
4397 \begin_inset Quotes eld
4405 \begin_inset Quotes erd
4408 with the name of your language.)
4412 \begin_layout Itemize
4413 If, in your language,
4414 \begin_inset Quotes eld
4418 \begin_inset Quotes erd
4422 \begin_inset Quotes eld
4426 \begin_inset Quotes erd
4431 \begin_inset Quotes eld
4435 \begin_inset Quotes erd
4439 \begin_inset Quotes eld
4443 \begin_inset Quotes erd
4446 have somewhat different meanings.
4447 An appendix is an extra part of a document.
4448 A supplement is an extra document.
4450 \begin_inset Separator latexpar
4457 \begin_layout Standard
4458 Choose a replacement word accordingly.
4459 Whatever you choose to replace
4460 \begin_inset Quotes eld
4464 \begin_inset Quotes erd
4467 it must not have the same translation as the word
4468 \begin_inset Quotes eld
4472 \begin_inset Quotes erd
4480 \begin_layout Enumerate
4481 Below the title, in the
4482 \begin_inset Quotes eld
4490 \begin_inset Quotes erd
4493 paragraph environment, place your name.
4494 \begin_inset Separator latexpar
4501 \begin_layout Standard
4502 There will be no abstract.
4506 \begin_layout Enumerate
4512 \begin_inset Separator latexpar
4519 \begin_layout Standard
4520 The first thing you will do is strongly yet politely encourage the reader
4522 \begin_inset Quotes eld
4526 \begin_inset Quotes erd
4529 and go read the Style Sheet.
4530 The reader should not return to the
4531 \begin_inset Quotes eld
4535 \begin_inset Quotes erd
4542 understood the Style Sheet proper.
4546 \begin_layout Subsubsection
4547 Keep the Supplement Succinct
4550 \begin_layout Standard
4551 This Style Sheet is already very detailed.
4552 DocTeam members all have a lot to read.
4553 We don't want to place an extra burden on translators.
4554 Therefore, keep the Supplement as short as you can without losing information.
4557 \begin_layout Subsubsection
4561 \begin_layout Standard
4566 will be about font issues\SpecialChar ldots
4568 Not all Translation Project Chiefs will need to deal with this issue.
4572 \begin_layout Itemize
4578 \begin_layout Itemize
4584 \begin_layout Itemize
4586 \begin_inset Newline newline
4591 Emphasized (actually Italics)
4594 \begin_layout Itemize
4600 \begin_layout Itemize
4606 \begin_layout Itemize
4609 Noun (actually Small Caps)
4612 \begin_layout Standard
4614 certainly exist for all languages that use the Roman alphabet.
4615 Do they exist, however, for Greek? How about Cyrillic? These different
4616 fonts almost certainly do not exist for Devanagri, Chinese, Korean, Japanese,
4617 Hebrew, Arabic, and other scripts.
4621 \begin_layout Standard
4622 There will be some languages for which following the font-scheme specified
4623 in this Style Sheet may not be possible.
4624 If you are the Translation Project Chief for such a language, you have
4628 \begin_layout Standard
4629 In the font section of the Supplement, you will provide a new typographic
4630 style, designed specifically for your writing system.
4631 For consistency, the title of this section in every Supplement should translate
4633 \begin_inset Quotes eld
4637 \begin_inset Quotes erd
4640 Before adding anything to this section, however, determine what this new
4641 typographic style will look like.
4642 Stick to the font specifications in this Style Sheet as best you can, whenever
4644 When you cannot, use the following suggestions:
4647 \begin_layout Itemize
4649 \begin_inset Quotes eld
4653 \begin_inset Quotes erd
4657 \begin_inset Newline newline
4661 \begin_inset Newline newline
4664 What to do when a font doesn't exist:
4665 \begin_inset Separator latexpar
4672 \begin_layout Labeling
4673 \labelwidthstring MMMMMMMM
4674 Roman Use the font that typesetters in your language use for printing books,
4676 This will typically be the default font \SpecialChar LyX
4677 (and \SpecialChar LaTeX
4678 ) uses in your language.
4681 \begin_layout Labeling
4682 \labelwidthstring MMMMMMMM
4686 \begin_inset space ~
4691 This is for people's names.
4692 If there is special font for names in your alphabet/writing system, use
4693 it in place of this.
4694 Otherwise, write names in the default font, typeset according to the rules
4698 \begin_layout Labeling
4699 \labelwidthstring MMMMMMMM
4704 Use the font with which your language normally emphasizes text.
4705 \begin_inset Separator latexpar
4712 \begin_layout Standard
4713 Use a font that is different from your language's equivalent of
4718 In other words, your
4726 and similar headers will be in one typeface, perhaps
4731 Whatever that font is, avoid using it for
4739 \begin_layout Labeling
4740 \labelwidthstring MMMMMMMM
4745 Pick up a computer program manual written in your language.
4746 It will use a special typeface for filenames, for command names, program
4748 Use that same font in place of
4755 \begin_layout Labeling
4756 \labelwidthstring MMMMMMMM
4760 \begin_inset space ~
4765 Pick any other font that is different from the ones you're using in place
4779 If you're unlucky, and your language's writing system doesn't have enough
4780 fonts, use the same font you picked to replace
4785 Only do this, however, if your alphabet/writing system has very few fonts
4789 \begin_layout Labeling
4790 \labelwidthstring MMMMMMMM
4797 \begin_inset space ~
4801 \begin_inset space ~
4806 Don't worry about this one.
4807 \begin_inset Separator latexpar
4814 \begin_layout Standard
4815 If you use some special font on-screen to highlight the accelerator keys
4816 for menus, buttons, and other widgets, you might want to mimic that in
4818 It is not required, however.
4819 Therefore, if you can't mimic this typographic convention in your native
4820 writing system, don't.
4825 \begin_layout Standard
4826 Note that you may also want to describe fonts that your Translation Team
4832 For example, no contributer to the English/European versions may ever use
4837 , as this is used for section-headings.
4838 Since there are enough other fonts, we who use the Roman alphabet and its
4839 variants can afford to omit
4847 \begin_layout Standard
4848 Once you have determined which fonts in your native writing system will
4849 replace one or more of the above, propose it to the \SpecialChar LyX
4852 You may receive valuable feedback this way.
4853 If not, that's okay.
4854 If no one can read your writing system, and therefore cannot comment, that's
4856 Go ahead and describe the typographic standard you created in the Supplement.
4860 \begin_layout Standard
4861 Remember: stick to the font specifications in this Style Sheet as best you
4862 can, whenever you can.
4865 \begin_layout Subsubsection
4866 Quoting Style and the
4878 \begin_layout Standard
4879 The next section of the Supplement will cover the issue of quoting.
4880 Give it an appropriate title.
4883 \begin_layout Standard
4884 One of the first things you should do in that section is resolve the following
4888 \begin_layout Itemize
4897 is the correct paragraph environment for your language.
4900 \begin_layout Itemize
4901 In the Supplement, specify which one to use.
4904 \begin_layout Standard
4905 English has its own typography and style for quoting others.
4906 The Style Sheet describes that typography in section
4907 \begin_inset space ~
4911 \begin_inset CommandInset ref
4913 reference "sec:quote"
4918 Your language also has a specific typography and style for quotations.
4919 Describe that style in this section of the Supplement, too.
4920 Naturally, you do not need to go overboard.
4922 \begin_inset space ~
4926 \begin_inset CommandInset ref
4928 reference "sec:quote"
4932 of this Style Sheet is overly detailed for a good reason.
4933 Authors of the primary \SpecialChar LyX
4934 manuals are not necessarily native English speakers.
4935 The members of your Translation Team, however, will all likely be native
4936 speakers of your language.
4937 Therefore, discuss proper quoting style of your native tongue to an appropriate
4941 \begin_layout Subsubsection
4942 Translations of Style Sheet Terminology
4945 \begin_layout Standard
4946 In the Supplement, you must provide a standard translation of certain key
4947 phrases for the members of your Translation Team.
4948 Place this in a section following the one about quotations.
4951 \begin_layout Standard
4952 In particular, standardize the translations of the phrases:
4955 \begin_layout Itemize
4961 \begin_layout Itemize
4967 \begin_layout Standard
4972 change the typography of the
4973 \begin_inset Quotes eld
4977 \begin_inset Quotes erd
4981 \begin_inset Quotes eld
4985 \begin_inset Quotes erd
4989 Only provide a translation for the opening phrases.
4990 Insist that the members of your Translation Team use these two tools correctly.
4993 \begin_layout Standard
4994 While we are discussing proper use of the
4995 \begin_inset Quotes eld
4999 \begin_inset Quotes erd
5003 \begin_inset Quotes eld
5007 \begin_inset Quotes erd
5010 in translations, let's talk about a related problem.
5012 \begin_inset Quotes eld
5016 \begin_inset Quotes erd
5019 is meant to be a note from the author of a manual to the reader.
5020 In the case of a translation, however, the translator is
5024 the author! How then should a translator translate an
5025 \begin_inset Quotes eld
5029 \begin_inset Quotes erd
5035 \begin_layout Standard
5036 You, as Translation Project Chief, must decide.
5037 You can forbid translation of pre-existing
5038 \begin_inset Quotes eld
5042 \begin_inset Quotes erd
5045 omitting them entirely instead.
5046 You could tell your translators to read any
5047 \begin_inset Quotes eld
5051 \begin_inset Quotes erd
5054 they may encounter, understand it, then write their own
5055 \begin_inset Quotes eld
5059 \begin_inset Quotes erd
5062 about the situation, not as a translation but as a personal opinion.
5063 You may decide on some other policy.
5066 \begin_layout Standard
5067 Whatever you decide, codify your policy in its own
5076 Place it near the section where you translated
5077 \begin_inset Quotes eld
5081 \begin_inset Quotes erd
5085 \begin_inset Quotes eld
5089 \begin_inset Quotes erd
5095 \begin_layout Subsubsection
5099 \begin_layout Standard
5100 After describing all of the previous issues, create a new
5106 \begin_inset Quotes eld
5109 Lost in Translation,
5110 \begin_inset Quotes erd
5113 or something similar.
5116 \begin_layout Standard
5117 In this section you will discuss any common English metaphors, humor, connotatio
5118 n, or other difficult to translate text.
5119 Try to balance brevity and completeness.
5128 s — to each specific issue.
5131 \begin_layout Subsubsection
5134 \begin_inset Quotes eld
5138 \begin_inset Quotes erd
5145 \begin_layout Standard
5146 Throughout the manuals, the DocTeam has used the following sentences:
5150 If you haven't read the <
5154 > manual, go read it.
5158 \begin_layout Standard
5159 This sentence will be tricky to translate, since it contains non-translatable
5165 for this issue in your
5166 \begin_inset Quotes eld
5170 \begin_inset Quotes erd
5175 \begin_inset Quotes eld
5179 Yes, we mean now\SpecialChar ldots
5181 \begin_inset Quotes erd
5184 sentences, then present a translation, along with any explanation you feel
5188 \begin_layout Standard
5189 Here's what those two sentences, sitting alone in their own paragraph, mean:
5192 \begin_layout Standard
5193 The first sentence uses the English conditional followed by an imperative.
5194 We, as the \SpecialChar LyX
5195 team, are commanding the reader to go back to another manual.
5200 manual is a prerequisite for all of the other manuals.
5201 The conditional clause preceeding the command means,
5202 \begin_inset Quotes eld
5205 You do not need to perform this command twice.
5206 \begin_inset Quotes erd
5212 \begin_layout Standard
5213 The second sentence adds force to the command.
5214 Culturally, the imperative tense of a verb in English is not necessarily
5216 The way we wrote that command,
5217 \begin_inset Quotes eld
5221 \begin_inset Quotes erd
5224 is firm, yet polite.
5225 The reader may choose to ignore it.
5227 \begin_inset Quotes eld
5231 \begin_inset Quotes erd
5234 we imply two things.
5236 \begin_inset Quotes eld
5240 \begin_inset Quotes erd
5244 That second sentence reinforces the command, making it a bit harder to
5246 Second, the sentence itself implies a certain sense of urgency.
5247 You cannot merely wait until later to fulfill that command.
5248 The brief pragraph, and its sudden end, add still further subtle reinforcement
5250 \begin_inset Quotes eld
5253 go do the required reading before using this manual.
5254 \begin_inset Quotes erd
5260 \begin_layout Standard
5261 Note that all of this commanding and reinforcing is nevertheless in a polite
5263 Furthermore, it is in a subtle form.
5264 We are commanding the reader to do something, but in an indirect fashion.
5265 This way, the reader does not feel like we are bullying him.
5268 \begin_layout Subsubsection
5273 \begin_layout Standard
5274 In the same part of the Supplement that you place the
5275 \begin_inset Quotes eld
5279 Yes, we mean now\SpecialChar ldots
5281 \begin_inset Quotes erd
5284 translation, discuss the English version's use of
5285 \begin_inset Quotes eld
5289 \begin_inset Quotes erd
5295 \begin_layout Standard
5296 You see, here in America, we often say that everything is permitted unless
5297 explicitly banned by law.
5298 As a result, manuals for computer software are frequently ignored and the
5299 software subsequently blamed for not being
5300 \begin_inset Quotes eld
5304 \begin_inset Quotes erd
5307 This is where the use of
5308 \begin_inset Quotes eld
5312 \begin_inset Quotes erd
5319 \begin_layout Standard
5320 We who wrote the manuals added sentences insisting that the reader not ignore
5321 certain parts of the documentation.
5322 We wrote in a manner that was polite, yet firmly asserted that the user
5323 was misusing the software if he did not read the manual correctly.
5324 We did not, however, want to sound threatening, coercive, or bullying.
5327 \begin_layout Standard
5328 In your culture, cajoling the reader into using the manuals correctly may
5330 It may, in fact, be outright rude.
5331 Additionally, translating the firm-but-convincing bits may not work.
5332 The translation may sound weird, or rude, or hostile.
5333 Therefore, you and your translation team will face many sentences that
5334 you cannot translate.
5337 \begin_layout Standard
5338 You, the Translation Project Chief, must discuss this issue.
5339 Try and find parts of the original manuals where some friendly but firm
5340 convincing does not translate properly.
5341 Use these cases as the basis for examples of the problem.
5342 Be sure to then offer a solution (i.
5343 \begin_inset space ~
5347 \begin_inset space ~
5350 how you want such sentences translated.) If stumped, ask for help on the
5355 \begin_layout Subsubsection
5359 \begin_layout Standard
5360 You can add more sections to the Supplement if you need to discuss other
5362 There may be policies or guidelines that you want to set for your Translation
5364 Be careful, however! Keep the Supplement