Documentation/Dashboard/Help Style Guide
From Apache OpenOffice Wiki
Contents
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> |
|
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. |
|
Third level heading | Syntax
|
|
Syntax definition | DATE(Year; Month; Day) |
|
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. |
|
Third level heading | Example
|
|
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 section/file for every function description: Every function description 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 function descriptions should be bundled in a category section/file. These category files should contain a list of the related functions, each with a short description that can be taken from the function description.