Documentation fixes and revamp user guide

[ric-plt/lib/rmr.git] / doc / src / rst.im

diff --git a/doc/src/rst.im b/doc/src/rst.im
index 871d340..e5d74db 100644 (file)
--- a/doc/src/rst.im
+++ b/doc/src/rst.im
@@ -1,6 +1,6 @@
 .if false
 ==================================================================================
-       Copyright (c) 2019 Nokia 
+       Copyright (c) 2019 Nokia
        Copyright (c) 2018-2019 AT&T Intellectual Property.
 
    Licensed under the Apache License, Version 2.0 (the "License");
@@ -21,14 +21,14 @@
        Mnemonic:       rts.im
        Abstract:       This file provides macros allowing {X}fm source to generate
                                rts input from {X}fm source when the doc is passed through
-                               tfm, and to generate postscirpt output when passed through 
+                               tfm, and to generate postscirpt output when passed through
                                pfm. Simalar to the roff.im macro set that allows the generation
                                of troff input for man pages.
 
        Author:         E. Scott Daniels
        Date:           7 February 2019
 
-       
+
                Maybe useful (but doesn't explain why real formatters aren't being used)
                http://docutils.sourceforge.net/docs/user/rst/quickref.html
 .fi
@@ -36,7 +36,7 @@
 
        .** convert {X}fm input into rts.
        .** post processing is needed to strip the leading space that tfm insists on adding.
-       
+
        .** bloody rst has no consistant marking character, and each header level must be different and as long as the text.
        .** and of course they don't generate <hx> tags in the resulting HTML, but <section> tags. WTF?
        .dv many_equals ============================================================================================
@@ -46,20 +46,23 @@
        .dv h2 .sp 1 $1 .br &many_dashes .sp 1
        .dv h3 .sp 1 $1 .br &many_tildas .sp 1
 
+       .** bloody rst won't allow breaks in a bullet list so we have to allow the column to go wide.
+       .dv cd 1 180i m=0i
+
        .dv h4 **$1**
        .** .dv h1 === $1 .br ===  .sp 1
        .** .dv h2 === $1 .br === .sp 1
        .** .dv h3 === $1 .br === .sp 1
-       
-       .dv fig 
-       .dv set_font_cw 
-       
+
+       .dv fig
+       .dv set_font_cw
+
        .dv nf  .sp 1 ^:^: .br .ll -2 .in +2
        .dv fo  .in -2 .ll +2 .sp 1
 
        .dv indent
        .dv uindent
-       
+
        .dv lic1 +
        .dv lic2 -
        .dv lic3 *
@@ -68,11 +71,11 @@
 
        .dv esc \ : .** bloody need to escape _ and * at the end of a word
        .dv line_len .ll $1
-       .dv space .sp 1 
+       .dv space .sp 1
        .dv half_space .sp 1
        .dv mult_space .sp $1
-       .dv beg_list .sp 1 .dv lic $1 ^:
-       .dv end_list .sp 1
+       .dv beg_list .ll 17i .sp 1 .dv lic $1 ^:
+       .dv end_list .ll 6i .sp 1
 
        .dv beg_dlist .sp 1  .ll -3
        .dv end_dlist .br .in 0i .ll +3
@@ -84,7 +87,7 @@
        .dv diitem .in 0i .br  $1 .br .in +3
        .dv item .br &lic
        .dv li .br &lic
-       
+
        .dv ex_start .sp 1 ^:^: .br .ll -2 .in +2 .nf
        .dv ex_end .fo on .in -2 .ll +2 .sp 1
 
@@ -94,14 +97,14 @@
        .dv center .br $1 .br
        .dv center_start .br
        .dv center_end .br
-       
+
        .** fonts and font macros
        .dv ital *$1*
        .dv bold **$1**
        .dv cw $1
-       .dv set_font_prop 
+       .dv set_font_prop
 
-       .dv table .sp 1 ^[table not supported in rst output]  .if false 
+       .dv table .sp 1 ^[table not supported in rst output]  .if false
        .dv tab_cell
        .dv tab_row
        .dv end_table .fi
@@ -111,5 +114,5 @@
        .dv note .dv ss_num ^[ ?%.0f ^&ss_num 1 + ] ^: .sm ^^[^&{ss_num}]
        .** rst has no concept of a page, so all notes go to the close of the doc
        .dv atbot atclose
-       
+
        .ju off