Documentation fixes and revamp user guide
[ric-plt/lib/rmr.git] / doc / src / rst.im
1 .if false
2 ==================================================================================
3         Copyright (c) 2019 Nokia
4         Copyright (c) 2018-2019 AT&T Intellectual Property.
5
6    Licensed under the Apache License, Version 2.0 (the "License");
7    you may not use this file except in compliance with the License.
8    You may obtain a copy of the License at
9
10        http://www.apache.org/licenses/LICENSE-2.0
11
12    Unless required by applicable law or agreed to in writing, software
13    distributed under the License is distributed on an "AS IS" BASIS,
14    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15    See the License for the specific language governing permissions and
16    limitations under the License.
17 ==================================================================================
18 .fi
19
20 .if false
21         Mnemonic:       rts.im
22         Abstract:       This file provides macros allowing {X}fm source to generate
23                                 rts input from {X}fm source when the doc is passed through
24                                 tfm, and to generate postscirpt output when passed through
25                                 pfm. Simalar to the roff.im macro set that allows the generation
26                                 of troff input for man pages.
27
28         Author:         E. Scott Daniels
29         Date:           7 February 2019
30
31
32                 Maybe useful (but doesn't explain why real formatters aren't being used)
33                 http://docutils.sourceforge.net/docs/user/rst/quickref.html
34 .fi
35
36
37         .** convert {X}fm input into rts.
38         .** post processing is needed to strip the leading space that tfm insists on adding.
39
40         .** bloody rst has no consistant marking character, and each header level must be different and as long as the text.
41         .** and of course they don't generate <hx> tags in the resulting HTML, but <section> tags. WTF?
42         .dv many_equals ============================================================================================
43         .dv many_dashes --------------------------------------------------------------------------------------------
44         .dv many_tildas ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
45         .dv h1 .sp 1 $1 .br &many_equals .sp 1
46         .dv h2 .sp 1 $1 .br &many_dashes .sp 1
47         .dv h3 .sp 1 $1 .br &many_tildas .sp 1
48
49         .** bloody rst won't allow breaks in a bullet list so we have to allow the column to go wide.
50         .dv cd 1 180i m=0i
51
52         .dv h4 **$1**
53         .** .dv h1 === $1 .br ===  .sp 1
54         .** .dv h2 === $1 .br === .sp 1
55         .** .dv h3 === $1 .br === .sp 1
56
57         .dv fig
58         .dv set_font_cw
59
60         .dv nf  .sp 1 ^:^: .br .ll -2 .in +2
61         .dv fo  .in -2 .ll +2 .sp 1
62
63         .dv indent
64         .dv uindent
65
66         .dv lic1 +
67         .dv lic2 -
68         .dv lic3 *
69
70         .in 0i                                          .** bloody rst is indention sensitive like markdown; sheesh
71
72         .dv esc \ : .** bloody need to escape _ and * at the end of a word
73         .dv line_len .ll $1
74         .dv space .sp 1
75         .dv half_space .sp 1
76         .dv mult_space .sp $1
77         .dv beg_list .ll 17i .sp 1 .dv lic $1 ^:
78         .dv end_list .ll 6i .sp 1
79
80         .dv beg_dlist .sp 1  .ll -3
81         .dv end_dlist .br .in 0i .ll +3
82
83         .** for now we allow only a single layer of defitems
84         .dv di     .in 0i .br  $1 .br .in +3
85         .dv ditem .in 0i .br  $1 .br .in +3
86         .** diitem is odd and deprecated
87         .dv diitem .in 0i .br  $1 .br .in +3
88         .dv item .br &lic
89         .dv li .br &lic
90
91         .dv ex_start .sp 1 ^:^: .br .ll -2 .in +2 .nf
92         .dv ex_end .fo on .in -2 .ll +2 .sp 1
93
94         .dv proto_start .sp 1 .cc .5i .st 9 .sf Courier-bold .nf
95         .dv proto_end .fo on .sf ^&text_font .st ^&text_size .sp .3
96
97         .dv center .br $1 .br
98         .dv center_start .br
99         .dv center_end .br
100
101         .** fonts and font macros
102         .dv ital *$1*
103         .dv bold **$1**
104         .dv cw $1
105         .dv set_font_prop
106
107         .dv table .sp 1 ^[table not supported in rst output]  .if false
108         .dv tab_cell
109         .dv tab_row
110         .dv end_table .fi
111
112         .dv super .sm ^[ .sm ^&{ss_num}]
113         .dv ss_num 1
114         .dv note .dv ss_num ^[ ?%.0f ^&ss_num 1 + ] ^: .sm ^^[^&{ss_num}]
115         .** rst has no concept of a page, so all notes go to the close of the doc
116         .dv atbot atclose
117
118         .ju off