Difference between revisions of "Documentation/Dashboard/Help Style Guide"

From Apache OpenOffice Wiki
Jump to: navigation, search
(Checklist for the Completeness of Function Descriptions)
(Checklist for the Completeness of Function Descriptions)
Line 66: Line 66:
  
 
===Checklist for the Completeness of Function Descriptions===
 
===Checklist for the Completeness of Function Descriptions===
Here are some hints related to the contents that should be considered in every function description although they are not essential and are sometimes missing in the actual help files.
+
Here are some hints related to the contents that should be considered in every function description although they are sometimes missing in the actual help files.
 
* Think global when you give examples. The english documentation is an international one.
 
* Think global when you give examples. The english documentation is an international one.
 
* Give unambiguous examples.
 
* Give unambiguous examples.

Revision as of 11:24, 4 December 2007

Help "Guides" (How-to instructions)

Calc functions

A typical help text for a Calc function should follow this scheme of paragraph styles:

Style Function Example
hidden text Index entry <BOOKMARKVALUE>DATE function</BOOKMARKVALUE>
  • hlp_head2
  • 16p
  • bold
  • capital letters
Second level heading
DATE
hlp_paragraph Function description This function converts a date written as year, month, day to an internal serial number and displays it in the cell's formatting. The default format of a cell containing the DATE function is the date format, but you can format the cells with the 0 number format, which displays the internal serial number of the date as a number.
  • hlp_head3
  • 14p
  • bold
  • without colon
Third level heading
Syntax
  • hlp_code
  • no blank before and after parentheses
  • arguments are separated by semicolon and blank
  • arguments begin with a capital letter
  • arguments that consist of more than one word are contracted (ex.: DegreesFreedom)
Syntax definition DATE(Year; Month; Day)
  • hlp_paragraph
  • 10p
  • argument is bold without colon
Explanation of function arguments Year is an integer between 1583 and 9956 or 0 and 99. In Tools - Options - StarOffice - General you can set from which year a two-digit number entry is recognized as 20xx.
  • hlp_head3
  • 14p
  • bold
  • without colon
Third level heading
Example
  • hlp_paragraph
  • starting with an equal sign
  • without blanks
  • results are not bold
  • no quotes, except if they are literal
Example =DATE(00;1;31) yields 1/31/00 if the cell format setting is "MM/DD/YY".


Distribution of Function Descriptions in the Help

  • One file for every Calc function: Every Calc function should be presented as a self-contained entity as we have it already for some functions like DATE, HOUR, YEAR and some others.
  • One function list for every function category: The individual Calc functions should be bundled in a category file. These category files should contain a list of the related functions, each with a short description (that can be taken from the Calc function file) and a link to the corresponding Calc function file.

Checklist for the Completeness of Function Descriptions

Here are some hints related to the contents that should be considered in every function description although they are sometimes missing in the actual help files.

  • Think global when you give examples. The english documentation is an international one.
  • Give unambiguous examples.
  • Mention differences to Excel.
  • Advise of argument types that are silently converted.
  • Advise of general settings that influence the result.
  • Mention the mathematical formula, which is used to calculate the result.
  • Advise of incorrect arguments that generate no error.
  • Tell the user, if named ranges, named formulas, labels or named data ranges are not resolved to their content or are forbidden.
  • Tell the user if internal underflow or overflow is not automatically detected. Tell about the accuracy if possible.
Personal tools