Documentation/Dashboard/Help Style Guide

From Apache OpenOffice Wiki
< Documentation‎ | Dashboard
Revision as of 13:15, 27 November 2007 by Mwaller (Talk | contribs)

Jump to: navigation, search

Help "Guides" (How-to instructions)

Current Style

A typical guide follows this scheme of paragraph styles:

Style Function Example
hlp_aux_bookmark Index entry <BOOKMARKVALUE>tables;calculating across</BOOKMARKVALUE>
hlp_head1 First level heading Calculating Across Tables
hlp_paragraph Introductory feature description, often beginning with "You can..." You can perform calculations that span across more than one table in a text document.
hlp_listitem Step-by-step description 1. Open a text document, insert two tables, and type numbers in a few cells in both tables....
hlp_aux_embed "Related Topics" section with links to other help files <EMBED href="text/shared/00/00000004.xhp#related">

hlp_aux styles = Styles that are created automatically when you insert a text element by the help authoring menu

Calc functions

Current Style

A typical help text for a Calc function follows this scheme of paragraph styles:

Style Function Example
hlp_aux_bookmark Index entry <BOOKMARKVALUE>ISFORMULA function</BOOKMARKVALUE>
hlp_head2 Second level heading ISFORMULA
hlp_paragraph Function description Returns TRUE if a cell is a formula cell.
hlp_head3 Third level heading Syntax
hlp_code Syntax definition ISFORMULA(reference)
hlp_paragraph Explanation of function arguments Reference indicates the reference to a cell in which a test will be performed to determine if it contains a formula.
hlp_head3 Third level heading Example
hlp_paragraph Example ISFORMULA(C4) returns FALSE if the cell C4 contains the number 5.

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

Personal tools