Add route table guide and formatting tweaks

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

diff --git a/doc/src/library/front_junk.im b/doc/src/library/front_junk.im
index 7b72e9b..c083e90 100644 (file)
--- a/doc/src/library/front_junk.im
+++ b/doc/src/library/front_junk.im
@@ -18,44 +18,102 @@
 .fi
 
 .if false
-       Title page, toc and license for page oriented output
+       Mnemonic:       front_junk.im
+       Abstract:       This will generate a title page, table of contents and
+                               license/copyright page (between title page and toc).
+                               It should only be embedded for postscript output
+
+                               For non-postscript output, a simple title is embedded
+                               without enabling table of contents, index, etc.
+
+                               Expected to be defined before imbedding this:
+                                       doc_title
+                                       col_width
+                                       col_indent
+                                       pass
+                                       textfont
+                                       textsize
+                                       indent_size
+                                       toc_file
+
+                               Optional vars that are used if set
+                                       doc_subtitle
+                                       orig_date
+
+       Date:           August 2019
+       Author:         E. Scott Daniels
 .fi
 
 
 .if ! _front_junk
-.sp 20
-.st 24
-.bc start
-&doc_title
-.br
-&doc_subtitle
-.bc end
-.st &textsize
-
-.sp 25
-Original: 30 July 2019 .br
-.gv Date
-Revised: &_date
-.pa
-
-
-.im license.im
-.pa
-
-.if &pass 1 =
-       .tc on
-.ei
-       .tc off
-       .pn on noline center roman 0
 
-       .im user.toc    .** initial page eject inside
+
+.if pfm
+       .sp 20
+       .st 24
+       .bc start
+       &doc_title
+       .br
+       .if doc_subtitle
+               &doc_subtitle
+       .fi
+       .bc end
+       .st &textsize
+
+       .sp 25
+       .if orig_date
+               Original: &orig_date .br
+       .fi
+       .gv Date
+       Revised: &_date
        .pa
+
+
+       .** license/copyright onto  the page after the title
+       .im license.im
+       .pa
+
+       .if &pass 1 =
+               .tc on
+       .ei
+               .tc off
+               .pn on noline center roman 0
+
+               .im &toc_file
+               .pa
+               .pn on 0
+       .fi
+
+.ei
+       .if "&ot" "rst" =
+               .** copyright into .rst because it supports internal comments
+               .im license.im
+
+               &many_equals .br
+               &doc_title
+               &many_equals .br
+               .if doc_subtitle
+                       &many_dashes .br
+                       &doc_subtitle .br
+                       &many_dashes .br
+               .fi
+       .ei
+               &center_start
+               &doc_title .br
+               .if doc_subtitle
+                       &doc_subtitle .br
+               .fi
+       .fi
 .fi
 
-.** ensure this is restored after toc spits
+.** ensure these are restored after toc spits
 .if pfm
-       .cd 1 6.0i
+       .cd 1  &col_width i=&col_indent
+       .in &indent_size
+       .sf &textfont
+       .st &textsize
 .fi
 
+
 .dv _front_junk 1
 .fi