Add user guide
[ric-plt/xapp-frame-cpp.git] / doc / src / lib / front_junk.im
1 .if false
2 ==================================================================================
3     Copyright (c) 2020 Nokia
4     Copyright (c) 2020 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     Absgtract:  This is the front matter (junk):
23                                         Title page,
24                                         table of contents
25                                         license (for page oriented output)
26
27                                 If defined, this uses the following variables:
28                                         doc_title
29                                         doc_subtitle
30                                         orig_date
31
32         Date:           21 April 2020
33 .fi
34
35 .if ! _front_junk
36         .gv e OUTPUT_TYPE ot
37         .if "&ot" "generic_ps" =
38                 .sp 20
39                 .st 24
40                 .bc start
41                 .if doc_title
42                         &doc_title
43                 .fi
44                 .br
45                 .if doc_subtitle
46                         &doc_subtitle
47                 .fi
48                 .bc end
49
50                 .st &textsize
51
52                 .sp 25
53                 .if orig_date
54                         Original: &orig_date .br
55                 .fi
56                 .gv Date
57                 Revised: &_date
58                 .pa
59
60                 .lw 0
61                 .pn on noline center roman 0
62                 .im &{lib}/license.im
63                 .pa
64
65                 .gv e XFM_PASS pass
66                 .if &pass 1 =
67                         .tc on
68                 .ei
69                 .tc off
70
71                 .im &{fname_base}.toc    .** initial page eject inside
72                 .pa
73                 .fi
74
75                 .** ensure these happen after toc is rendered
76                 .if pfm
77                         .pn on 0 noline center f=%d
78                         .cd 1 6.0i
79                 .fi
80         .ei
81                 .if "&ot" "rst" =
82                         .dv raw_comment_sym ^..
83                         .cd 1 26i
84                         .ll 18i
85                         .im &{lib}/raw_license.im
86                         .ll 6i
87
88                         .if doc_title
89                                 &many_equals
90                                 &doc_title
91                                 &many_equals
92                         .fi
93                         .if doc_subtitle
94                                 &many_dashes
95                                 &doc_subtitle
96                                 &many_dashes
97                         .fi
98                 .fi
99
100         .dv _front_junk 1
101 .fi
102