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

Revision as of 13:43, 3 December 2007

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".

@@ Line 41: / Line 41: @@
 * 10p
 * argument is bold without colon
-||Explanation of function arguments || '''Year''' is an integer between 1583 and 9956 or 0 and 99. ...
+||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.
 |- bgcolor="#FFF"
 ||
@@ Line 56: / Line 56: @@
 * results are not bold
 * no quotes, except if they are literal
-||Example || =DATE(00;1;1) yields 1/1/00
+||Example || =DATE(00;1;31) yields 1/31/00 if the cell format setting is "MM/DD/YY".
 |}