Difference between revisions of "Documentation/Dashboard/Help Style Guide"
From Apache OpenOffice Wiki
< Documentation | Dashboard
(→Calc functions) |
(→Calc functions) |
||
| Line 13: | Line 13: | ||
| hidden text||Index entry|| <BOOKMARKVALUE>DATE function</BOOKMARKVALUE> | | hidden text||Index entry|| <BOOKMARKVALUE>DATE function</BOOKMARKVALUE> | ||
|- bgcolor="#FFF" | |- bgcolor="#FFF" | ||
| − | | hlp_head2 | + | || |
| + | * hlp_head2 | ||
| + | * 16p | ||
| + | * bold | ||
| + | * capital letters | ||
| + | ||Second level heading|| '''DATE''' | ||
|- bgcolor="#FFF" | |- bgcolor="#FFF" | ||
| 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. ... | | 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. ... | ||
|- bgcolor="#FFF" | |- bgcolor="#FFF" | ||
| − | | hlp_head3 | + | || |
| + | * hlp_head3 | ||
| + | * 14p | ||
| + | * bold | ||
| + | * without colon | ||
| + | ||Third level heading|| '''Syntax''' | ||
|- bgcolor="#FFF" | |- bgcolor="#FFF" | ||
| − | | hlp_code | + | || |
| + | * hlp_code | ||
| + | * no blank before and after brackets | ||
| + | * arguments are separated by colon 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) | ||
|- bgcolor="#FFF" | |- bgcolor="#FFF" | ||
| − | | hlp_paragraph | + | || |
| + | * hlp_paragraph | ||
| + | * 10p | ||
| + | * argument is bold without colon | ||
| + | ||Explanation of function arguments || '''Year''' is an integer between 1583 and 9956 or 0 and 99. ... | ||
|- bgcolor="#FFF" | |- bgcolor="#FFF" | ||
| − | | hlp_head3 | + | || |
| + | * hlp_head3 | ||
| + | * 14p | ||
| + | * bold | ||
| + | *without colon | ||
| + | ||Third level heading|| '''Example''' | ||
|- bgcolor="#FFF" | |- bgcolor="#FFF" | ||
| − | | hlp_paragraph | + | || |
| + | * hlp_paragraph | ||
| + | * starting with an equal sign | ||
| + | * without blanks | ||
| + | * results are not bold | ||
| + | ||Example || =DATE("00;1;1") yields 1/1/00 | ||
|} | |} | ||
Revision as of 14:32, 27 November 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 |
