doc/src/rtd/gen_title.im

   1 .** vim: ts=4 sw=4 noet:
   2 .if false
   3 ==================================================================================
   4         Copyright (c) 2020 Nokia
   5         Copyright (c) 2020 AT&T Intellectual Property.
   6
   7    Licensed under the Apache License, Version 2.0 (the "License");
   8    you may not use this file except in compliance with the License.
   9    You may obtain a copy of the License at
  10
  11        http://www.apache.org/licenses/LICENSE-2.0
  12
  13    Unless required by applicable law or agreed to in writing, software
  14    distributed under the License is distributed on an "AS IS" BASIS,
  15    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16    See the License for the specific language governing permissions and
  17    limitations under the License.
  18 ==================================================================================
  19 .fi
  20
  21 .if false
  22         Mnemonic:       gen_title.im
  23         Abstract:       Imbed file to generate a title when requested.  Uses doc_title and
  24                                 doc_subtitle strings if available. We will inject a man page title
  25                                 if the INPUT_FILE env variable is set to avoid having to edit
  26                                 all of them to add such a beast which isn't needed for a real
  27                                 man page.
  28
  29         Date:           10 April 2020
  30 .fi
  31
  32 .** special man page title generator
  33 .gv e INPUT_FILE in
  34 .if in
  35         .if ! doc_title
  36                 .dv doc_title Man Page: &in
  37         .fi
  38 .fi
  39
  40 .** add license to the document as a comment; where possible
  41 .im license.im
  42
  43 .gv e OUTPUT_TYPE ot
  44 .if doc_title
  45         .if "&ot" "rst" =
  46                 &many_equals .br
  47                 &doc_title .br
  48                 &many_equals .br
  49
  50                 .if doc_subtitle
  51                         &many_dashes .br
  52                         &doc_subtitle .br
  53                         &many_dashes .br
  54                 .fi
  55                 .sp 2
  56         .ei
  57                 if pfm
  58                         .sf Helvetica-bold
  59                         .sp 5
  60                         .st 18
  61                         .ce &doc_title
  62                         .st 12
  63                         .if doc_subtitle
  64                                 .ce &doc_subtitle
  65                         .fi
  66                         .st &textsize
  67                         .sf &txtfont
  68                         .sp 2
  69                 .ei
  70                         .sp 1
  71                         .ce &doc_title
  72                         .br
  73                         .if doc_subtitle
  74                                 .ce &doc_subtitle
  75                         .fi
  76
  77                         .sp 2
  78                 .fi
  79         .fi
  80 .fi