Difference between revisions of "Extended Tip Help"

From Apache OpenOffice Wiki
Jump to: navigation, search
Line 10: Line 10:
  
 
The extended tips show text that is authored by the [[OOo OnlineHelp]] writers. If enabled, they are shown instead of the corresponding short tips wherever applicable.
 
The extended tips show text that is authored by the [[OOo OnlineHelp]] writers. If enabled, they are shown instead of the corresponding short tips wherever applicable.
 +
 +
You can enable or disable extended tips permanently on the ''Tools - Options - OOo - General'' dialog page. You can show extended tips until the next mouse click by pressing Shift+F1.
  
 
In the help source files, the author can choose to mark any part of a paragraph as a 'visible' or 'invisible' help text to be displayed as an extended tip, wich is also known as an 'active help' text.
 
In the help source files, the author can choose to mark any part of a paragraph as a 'visible' or 'invisible' help text to be displayed as an extended tip, wich is also known as an 'active help' text.

Revision as of 11:36, 20 September 2006

Tip Help

The short tips are created by the developers of the user interface (UI). For icons on the toolbars, the short tips give the icon name. These names are the same names that the Help authors refer to throughout the whole documentation. This means the names should not be changed by developers without a reason, and for sure not without notifying all documentation authors.

Short tips do not only show the names of icons, but they are valuable sources of information at many other places. For example, while scrolling through a long document with chapter headings, the short tip displays the current chapter name.

You can enable or disable short tips on the Tools - Options - OOo - General dialog page.

Extended Tip Help

The extended tips show text that is authored by the OOo OnlineHelp writers. If enabled, they are shown instead of the corresponding short tips wherever applicable.

You can enable or disable extended tips permanently on the Tools - Options - OOo - General dialog page. You can show extended tips until the next mouse click by pressing Shift+F1.

In the help source files, the author can choose to mark any part of a paragraph as a 'visible' or 'invisible' help text to be displayed as an extended tip, wich is also known as an 'active help' text.

A text passage marked as a 'visible' active help text can be read also inside the Help Viewer, while an 'invisible' text passage is only readable in the extended help tip.

Which text is shown as extended tip is determined by a unique string identifier, the Help ID.

Personal tools