doc/src/library/front_junk.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:       front_junk.im
  22         Abstract:       This will generate a title page, table of contents and
  23                                 license/copyright page (between title page and toc).
  24                                 It should only be embedded for postscript output
  25
  26                                 For non-postscript output, a simple title is embedded
  27                                 without enabling table of contents, index, etc.
  28
  29                                 Expected to be defined before imbedding this:
  30                                         doc_title
  31                                         col_width
  32                                         col_indent
  33                                         pass
  34                                         textfont
  35                                         textsize
  36                                         indent_size
  37                                         toc_file
  38
  39                                 Optional vars that are used if set
  40                                         doc_subtitle
  41                                         orig_date
  42
  43         Date:           August 2019
  44         Author:         E. Scott Daniels
  45 .fi
  46
  47
  48 .if ! _front_junk
  49
  50
  51 .if pfm
  52         .sp 20
  53         .st 24
  54         .bc start
  55         &doc_title
  56         .br
  57         .if doc_subtitle
  58                 &doc_subtitle
  59         .fi
  60         .bc end
  61         .st &textsize
  62
  63         .sp 25
  64         .if orig_date
  65                 Original: &orig_date .br
  66         .fi
  67         .gv Date
  68         Revised: &_date
  69         .pa
  70
  71
  72         .** license/copyright onto  the page after the title
  73         .im license.im
  74         .pa
  75
  76         .if &pass 1 =
  77                 .tc on
  78         .ei
  79                 .tc off
  80                 .pn on noline center roman 0
  81
  82                 .im &toc_file
  83                 .pa
  84                 .pn on 0
  85         .fi
  86
  87 .ei
  88         .if "&ot" "rst" =
  89                 .** copyright into .rst because it supports internal comments
  90                 .im license.im
  91
  92                 &many_equals .br
  93                 &doc_title
  94                 &many_equals .br
  95                 .if doc_subtitle
  96                         &many_dashes .br
  97                         &doc_subtitle .br
  98                         &many_dashes .br
  99                 .fi
 100         .ei
 101                 &center_start
 102                 &doc_title .br
 103                 .if doc_subtitle
 104                         &doc_subtitle .br
 105                 .fi
 106         .fi
 107 .fi
 108
 109 .** ensure these are restored after toc spits
 110 .if pfm
 111         .cd 1  &col_width i=&col_indent
 112         .in &indent_size
 113         .sf &textfont
 114         .st &textsize
 115 .fi
 116
 117
 118 .dv _front_junk 1
 119 .fi