snopea(7)

1SNOPEA(7)                       CSNOBOL4 Manual                      SNOPEA(7)
2
3
4

NAME

6       snopea - A little “Plain Old Documentation” format for SNOBOL4
7

DESCRIPTION

9       snopea is a simple-to-use markup language used for writing
10       documentation for SNOBOL4, SNOBOL4 programs, and SNOBOL4 modules,
11       inspired by perlpod(1).  The snopea(1) command translates snopea to
12       *roff man(7) macro format or HTML.
13
14       A line that starts with zero or more star/asterisk (*) characters
15       followed by =pea signals start of a block of documentation.  All lines
16       until a =cut directive will be processed after removal of leading
17       star/asterisk characters.
18
19       New paragraphs are started with a blank line.
20

FORMATTING

22       B<text>
23           text is formatted in bold.
24
25       I<text>
26           text is formatted in italic.
27
28       C<text>
29           text is formatted in constant width.
30
31       L<url>
32           url is formatted as an HTML link.
33

DIRECTIVES

35       =break
36           Inserts a line break.
37
38       =bull text
39           Indicates a bullet item in a list.
40
41       =code
42           Starts a block of code, lines will be formatted in a constant-width
43           font, and line breaks will be preserved.
44
45       =cut
46           Signals end of a block of documentation.
47
48       =ecode
49           Ends a =code block.
50
51       =etable
52           Ends a table.
53
54       =item label
55           A list item with tag label.
56
57       =indent number
58           Controls the indentation of =item paragraphs.
59
60       =nitem text
61           A numbered list item with tag label.
62
63       =row columns
64           A table row. columns is a tab separated list.
65
66       =sect name
67           Declares man page section name.
68
69       =subsect name
70           Declares man page subsection name.
71
72       =table tab stops
73           Begin a table, setting tab stops, a sequence of positions in
74           inches, each followed by i (ie; 1i 2i 3i)
75

SPECIAL CHARACTERS

77       The following sequences (an unholy mix of troff(1) and HTML) MUST be
78       used for portable formatting:
79
80       ``  left double quote (“)
81
82       ´´  right double quote (”)
83
84       &amp;
85           ampersand (&)
86
87       &pi;
88           greek lower-case pi (π)
89
90       &lt;
91           less than sign (<)
92
93       &gt;
94           greater than sign (>)
95
96       \e  backslash (\)
97
98       \`  accent grave (`)
99
100       \'  apostrophe (')
101
102       \-  en-dash
103
104       \&  zero-width space
105
106       \|  thin space
107
108       \~  non-breaking space
109
110       \=  equals-sign
111

NOT CONFORMING TO

113       Inspired by (but not compatible with) Perl POD format.
114       https://perldoc.perl.org/perlpod.html
115       https://perldoc.perl.org/perlpodspec.html
116

AUTHOR

118       Philip L. Budne
119