Typographical Conventions

From DocBase

Typographical Conventions by Ladislav Mecir
This is a Documentation Recipe	Complete list of Cookbooks	Add your own Cookbook Recipe

Contents 1 Suggested conventions for documenting REBOL 2 Cookbook References

Suggested conventions for documenting REBOL

Category	Style	How to do it in WikiText
emphasized text	emphasized text	''emphasized text'' (double apostrophe)
REBOL words	bold-and-italic	'''''bold-and-italic''''' (quintuple apostrophe)
values of REBOL variables	bold	'''bold''' (triple apostrophe)
embedded REBOL expression	typewriter text	<tt>typewriter text</tt>

Note: REBOL variables are REBOL words that are bound to a context, unbound words don't have values.

Use:

1. do to represent the value of the do variable - in a fresh console this is a native that does not have a serialized form
2. none to represent the value of the none variable - in a fresh console this is the value that can be literally represented as #[none] or #[none!]
3. true to represent the value of the true variable - in a fresh console this is the value that can be literally represented as #[true]
4. unset! to represent the value of the unset! variable - in a fresh console this is the value that can be literally represented as #[datatype! unset!]
5. unset to represent the value of the unset variable - in a fresh console this is a native that does not have a serialized form

, etc.

The above rules mean, that the #[unset!] value should be represented using neither of unset (the word), unset (the native), unset! (the word), unset! (the datatype).

Cookbook References

Cookbook Reference Page

Class	Documents
Usage	Cookbook List New Cookbooks and Recipes
Authoring	About Cookbooks Requested Cookbooks List of Cookbook/Recipe Authors
See Also	http://www.rebol.net/cookbook/