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

Revision as of 13:48, 27 November 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	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. ...
hlp_head3	Third level heading	Syntax
hlp_code	Syntax definition	DATE(Year; Month; Day)
hlp_paragraph	Explanation of function arguments	Year is an integer between 1583 and 9956 or 0 and 99. ...
hlp_head3	Third level heading	Example
hlp_paragraph	Example	=DATE("00;1;1") yields 1/1/00

@@ Line 5: / Line 5: @@
 ==Calc functions==
-Most of the Calc functions are described in the files from text/scalc/01/04060101.xhp up to text/scalc/01/04060185.xhp. In the Calc Help they can be found under the index entry "Calc functions".
+A typical help text for a Calc function should follow this scheme of paragraph styles:
+{| cellpadding="3" cellspacing="1" style="background-color: #666; margin-left: 3em;"
+|- bgcolor="#DDD"
+! Style !! Function !! Example
+|- bgcolor="#FFF"
+| hidden text||Index entry|| <BOOKMARKVALUE>DATE function</BOOKMARKVALUE>
+|- bgcolor="#FFF"
+| hlp_head2||Second level heading|| '''DATE'''
+|- 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. ...
+|- bgcolor="#FFF"
+| hlp_head3||Third level heading|| '''Syntax'''
+|- bgcolor="#FFF"
+| hlp_code||Syntax definition || DATE(Year; Month; Day)
+|- bgcolor="#FFF"
+| hlp_paragraph||Explanation of function arguments || '''Year''' is an integer between 1583 and 9956 or 0 and 99. ...
+|- bgcolor="#FFF"
+| hlp_head3||Third level heading|| '''Example'''
+|- bgcolor="#FFF"
+| hlp_paragraph||Example || =DATE("00;1;1") yields 1/1/00
+|}