blob: 7e4d98b7d51122fe5a43132425c5871278ea9e42 [file] [log] [blame]
Cary Clark8032b982017-07-28 11:04:54 -04001#Topic Bookmaker_Markup
2
3# redefine markup character so examples below will not be parsed
Cary Clark682c58d2018-05-16 07:07:07 -04004###$
Cary Clark8032b982017-07-28 11:04:54 -04005
6Text, except for the single markup character, requires no annotation.
7
8# comments are preceded by a hash symbol and whitespace
9# comments may terminated by linefeed or double hash ## <- end of comment
10
11Keywords are preceded by a single hash symbol without whitespace.
12#Keyword
13
14Keywords are terminated by double hash and may be labeled
15## <- end of #keyword
16
17#Keyword
18#Keyword ## <- alternate labeled end of #Keyword
19
20Tables use single hash symbols to delimit columns, and double to end row.
21#Table
22#Legend
23# first column in table # next column in table ##
24## <- end of #Legend
25# a row # another row ##
26# another row # another row ##
27#Table ## <- or, just ##
28
29$Table
30$Legend
31$ first column in table $ next column in table $$
32$$
33$ a row $ another row $$
34$ another row $ another row $$
35$Table $$
36
37The markup character is initially # at the start of any .bmh file
38###x <- redefine the markup character as 'x'
39xxx# <- restore the default markup character
40
41 anchor, ala HTML
42 anchors may start anywhere in the line
43#A text #_reference ##
44
45 class description
46#Class SkClassName
47description
48methods
49##
50
51 if the example is not named, it inherits the name of its container
52#Example
53 #Description
54 ##
55 #Image
56 #Width
57 #Height
58 code...
59 #StdOut
60 expected example output
61 ##
62##
63
64#Enum __required_reference
65description
66#Code
67##
68#Example
69##
70#Enum ##
71
72 method description
73 the _method_reference must be unique within the class
Cary Clark682c58d2018-05-16 07:07:07 -040074#Method type name(params..)
Cary Clark8032b982017-07-28 11:04:54 -040075description
76#Param name description ##
77#Return return ##
78#Example
79##
80#SeeAlso ##
81##
82
83#ToDo description ##
84
85$ restore markup character
Cary Clark682c58d2018-05-16 07:07:07 -040086$$$#
Cary Clark8032b982017-07-28 11:04:54 -040087
88##