Difference between revisions of "Documentation/Dashboard/Help Style Guide"
From Apache OpenOffice Wiki
< Documentation | Dashboard
(→Calc functions) |
(→Calc functions) |
||
Line 32: | Line 32: | ||
* hlp_code | * hlp_code | ||
* no blank before and after parentheses | * no blank before and after parentheses | ||
− | * arguments are separated by | + | * arguments are separated by semicolon and blank |
* arguments begin with a capital letter | * arguments begin with a capital letter | ||
* arguments that consist of more than one word are contracted (ex.: DegreesFreedom) | * arguments that consist of more than one word are contracted (ex.: DegreesFreedom) |
Revision as of 10:31, 3 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> |
|
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. ... |
|
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. ... |
|
Third level heading | Example
|
|
Example | =DATE("00;1;1") yields 1/1/00 |