[O] Patch for documentation standards

[Thomas S. Dye]

Aloha all,

A lightly edited and augmented version of the Org documentation 
standards is attached.

All the best,
Tom

>From 010294deec9d35217bdc991bec55a80ab0f40853 Mon Sep 17 00:00:00 2001
From: "Thomas S. Dye" <address@hidden>
Date: Sat, 3 Mar 2018 16:06:27 -1000
Subject: [PATCH] Update documentation standards

---
 doc/Documentation_Standards.org | 57 ++++++++++++++++++++++++++---------------
 1 file changed, 37 insertions(+), 20 deletions(-)

diff --git a/doc/Documentation_Standards.org b/doc/Documentation_Standards.org
index 357520b9f..f1495d2e8 100644
--- a/doc/Documentation_Standards.org
+++ b/doc/Documentation_Standards.org
@@ -34,7 +34,7 @@ used in the patches I am submitting and, which I hope, may be 
adopted by
 others when making their own contributions.
 
 * Org - Referencing systems, packages, modes and much else
- 
+
 Originally Org was a single mode and there was no ambiguity about what
 Org mode could refer to.  Things have changed rapidly though and it
 seems that Carsten now thinks of Org as the system encompassing the
@@ -49,7 +49,7 @@ perfect, merely a start):
    applicable to Org as a whole.
 
  - Be more specific and write, for example, "the Orgtbl minor mode" when
-   referring to something unique to that feature.  It maybe, for example,
+   referring to something unique to that feature.  It may be, for example,
    a command is only available when you are actually editing a file using
    just that mode, add-on package or plug-in.
 
@@ -67,7 +67,7 @@ perfect, merely a start):
 
 * Other Org specific conventions
 
-Unless there is a good reason to do otherwise then try and adopt the
+Unless there is a good reason to do otherwise, then try and adopt the
 following conventions.  (I think all can be justified by reference to
 Carsten or precedent in other significant Emacs documentation...unless I
 have made them up of course).
@@ -89,36 +89,53 @@ have made them up of course).
    lowercase.
 
  - Built-in properties (eg PRIORITY) are written in uppercase.  User defined
-   properties (eg Release) are written in lowercase.
+   properties (e.g. Release) are written in lowercase.
 
- - [[info:org:Top][The Org Manual]] uses the @chapter, @section and 
@subsection Texinfo
-   commands for sectioning.  I have tried to capitalize significant words
-   in @chapter headings.  In @section and @subsection headings, just the
+ - [[info:org:Top][The Org Manual]] capitalizes significant words
+   in first level headings.  In second and third level headings, just the
    first word is capitalized and all other words are lowercase (with
    exceptions of course...).  Thus, use:
 
-   @chapter Properties and Columns
+   * Properties and Columns
 
-   @section Visibility cycling
+   ** Visibility cycling
 
    *but*
 
-   @section Fast access to TODO states
+   ** Fast access to TODO states
 
 * Miscellaneous
 
- - Only two of the standard Texinfo indexes are used; those for concepts
-   and keys.  This has some implications:
+ - Five of the standard Texinfo indexes are used in the Org manual:
+
+   + #+cindex: :: concept index, for general concepts
+
+   + #+findex:  :: function index, for function and function-like names
+
+   + #+kindex: :: keystroke index, for keyboard commands
+
+   + #+pindex: :: program index, for names of programs
+
+   + #+vindex: :: variable index, for variable names
+
+ - Entries in the concept index are normally all lower case unless
+   some other rule dictates otherwise
+
+ - use fixed-width area for one-line examples
+
+ - use example blocks for Org syntax instead of "begin_src org"
+
+ - internal links to headlines always start with a star
+
+ - tags, node properties, are not shown with the surrounding colons
+
+ - when to use =...= or ~...~ markup:
+
+   - files or extensions use =...=,
 
-   + The preference is to document commands by key rather than by name
+   - anything that is meant to be written in the Org buffer uses =...=,
 
-   + Texinfo commands such as @var and @defoption are not used.  The
-     preference for this type of thing is that the user browses the
-     customize groups.  If you want or need to refer to, say, a variable
-     then document it as "the variable @code{org-startup-folded}"
- 
-   + Entries in the concept index are normally all lower case unless
-     some other rule dictates otherwise.
+   - any meaningful token in a programming language uses ~...~.
 
  - Org documentation is written in American English, which is somewhat
    foreign as far as I am concerned, but live with it anyway.
-- 
2.14.1


--
Thomas S. Dye
http://www.tsdye.com