Convex Press Web

Structuring Documents with FrameBuilder


Previous Page | Next Page | Contents | Convex Press Home | Help

Tips and other flashes of inspiration


The tips

The tips presented here are arranged alphabetically. A Date of last verification is given when applicable.

Please send items for inclusion in this list to scox@convex.com. Updates regarding current tips should also be sent to scox@convex.com.

Auto-numbered paragraphs

Date of last verification: June 20, 1995

Custom auto-numbering is lost online. These constructs must be changed to regular text.

For example, if you have compiler error messages that are auto-numbered with the string fc:, each of those paragraphs must be converted.

Auto-numbered paragraphs that are part of the templates, such as bullet lists and numbered lists, work as expected online.

Code examples

Date of last verification: June 20, 1995

The following elements can be used to wrap examples:

For example, if a <VoiceUser> element were used within an <ExampleBlockVerbatim> element, the strings <VoiceUser> and </VoiceUser> would appear in the online document.

Here is how to use these elements for various applications:

Frame's (code example) paragraph tags and elements

The following list presents the types of examples that the structure rule table will generate given the indicated paragraph tags:

Returns and the <ExampleBlockVerbatim> element

Use only soft returns (SHIFT-RETURN) inside <ExampleBlockVerbatim> elements. Hard returns (RETURN) cause large amounts of whitespace online when used inside <ExampleBlockVerbatim> elements.

Tabs in code examples

Manually change tabs to courier spaces in code examples to preserve the proper indentation.

  1. In the menu bar, select Format -> Document and then in the resulting window turn the Smart Spaces option off (square next to the option will be white, with black outline).
  2. Use Frame's Find/Change feature to locate tabs ( ) in code examples.
  3. Delete the tabs, replacing them with courier spaces (do not use hard spaces). Use as many spaces as required to achieve the desired indentation.
  4. Turn Smart Spaces back on by selecting Format -> Document and then the Smart Spaces option in the resulting window.

Previous Page | Next Page | Contents | Convex Press Home | Help

Please submit comments and questions about these pages to scox@convex.com