"Wikified" Manual_style_guidelines.txt

This commit is contained in:
unknown 2002-05-17 14:47:48 +10:00
parent 2f91c6c3c9
commit cf8433e4fe

View File

@ -1,4 +1,14 @@
MySQL Manual style guidelines OriginalAuthor: PaulDuBois
!!! ManualStyleGuidelines
''Version 1.0''
!! Revision History
* 2002-05-17 ArjenLentz - Version 1.0, Posted to Wiki
!! MySQL Manual Style Guidelines
Paul DuBois <paul@snake.net> Paul DuBois <paul@snake.net>
@ -9,7 +19,8 @@ do reflect current working practice. Arjen asked me to post this
on the list some time ago so that it can be discussed with a view on the list some time ago so that it can be discussed with a view
to adding it (or something like it) to the source tree. So here it is! to adding it (or something like it) to the source tree. So here it is!
MySQL Reference Manual Style Guidelines Present in the mysql-4.0 source tree: Docs/ManualStyleGuidelines.wiki
The manual is written in UK English, not American English. This means: The manual is written in UK English, not American English. This means:
@ -44,7 +55,9 @@ its = possession (e.g., "MySQL is fast, which is one of its strengths")
"a lot" is two words. "alot" is rebarbative. "a lot" is two words. "alot" is rebarbative.
Write lowercase, not lower case Write lowercase, not lower case
Write uppercase, not upper case Write uppercase, not upper case
Write lettercase, not letter case Write lettercase, not letter case
Write "web site" (two words), not "website", and "web page" rather Write "web site" (two words), not "website", and "web page" rather
@ -64,12 +77,9 @@ typos. Don't "fix" it. (If the output is produced by a MySQL program, then
fix the source for the program to write the output correctly without the fix the source for the program to write the output correctly without the
typo, then update the manual to match.) typo, then update the manual to match.)
Use "okay" rather than "ok" or "Ok" or "OK" in sentences. Use "okay" rather than "ok" or "Ok" or "OK" in sentences. Exceptions:
Exceptions: * When describing instructions for a GUI with buttons that say "OK", then use "OK". That is, use the label that the GUI uses.
- When describing instructions for a GUI with buttons that say * When showing the output from a program, show the output exactly; don't change "ok" to "okay", etc.
"OK", then use "OK". That is, use the label that the GUI uses.
- When showing the output from a program, show the output exactly;
don't change "ok" to "okay", etc.
Write "Open Source" (inside @code{}), not "open source". Write "Open Source" (inside @code{}), not "open source".
@ -188,7 +198,9 @@ Write low-volume <something> (when used as an adjective).
Write platform-dependent, not platform dependent. Write platform-dependent, not platform dependent.
Write something like "mentioned previously" instead of "above", and "later in this section" instead of "below" when making such relative references in your text. Write something like "mentioned previously" instead of "above", and "later in this section" instead of "below" when making such relative references in your text.
Write "... shown here", not "... shown below". Write "... shown here", not "... shown below".
Write "following some", not "something [shown] below". Write "following some", not "something [shown] below".
Write high-priority <something> (when used as an adjective), not high priority. Write high-priority <something> (when used as an adjective), not high priority.