doc/src/markdown.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:       markdown.im
  22         Abstract:       This is a setup for a very basic generation of markdown from the few
  23                                 macros which are designed for the RMR doc.  It is very scaled down from
  24                                 the markdown imbed file supplied with {X}fm.
  25
  26         Author:         E. Scott Danils
  27         Date:           26 October 2016
  28 -------------------------------------------------------------------------------
  29 .fi
  30
  31
  32 .dh 1 m=.5i  e=no s=21 i=0 p=16 f=Helvetica-bold
  33 .dh 2  m=.5i s=21 i=0      p=14 f=Helvetica-bold
  34 .dh 3  m=.5i s=10 i=0      p=12 f=Helvetica-bold
  35
  36 .ju on
  37 .hn off
  38
  39
  40 .** super sccript number for start_note macro
  41 .dv ss_num 1
  42
  43 .**  these macros are common for prfm/tfm, markdown will override some
  44 .dv indent .ll -.5i .in +.25i
  45 .dv uindent .in -.25i .ll +.5i
  46 .dv smindent .ll -.2i .in +.1i
  47 .dv smuindent .in -.1i .ll +.2i
  48
  49 .dv def_list .bd $1
  50 .dv end_dlist .ed
  51 .dv bd .bd $1
  52 .dv ed .ed
  53
  54 .dv ex_start .sp .5 .ll -.25i .in +.25i .sf Courier .st ^&extextsize .fo off
  55 .** ex_end macro calls _must_ be placed in col 0 to cause an exit from no-format mode.
  56 .dv ex_end .fo on .sf ^&textfont .st ^&textsize .in -.25i .ll +.25i .sp .1
  57
  58 .dv h1 .sp .1 .h1 $1
  59 .dv h2 .sp .1 .h2 $1
  60 .dv h3 .sp .1 .h3 $1
  61 .dv di .di $1 ^:
  62
  63 .dv super .sm ^[ .sm ^&{ss_num}]
  64 .dv note .dv ss_num ^[ ^&ss_num 1 + ] ^: .sm ^[ .sm ^&{ss_num}]
  65
  66 .dv start_note .cn start atend Times-roman 8p .5i
  67 .dv end_note .cn end
  68 .dv bold $1
  69 .dv cw $1
  70 .dv set_font_prop
  71 .dv ital $1
  72 .dv lic1 *
  73 .dv lic2 +
  74
  75 .dv line_len .ll $1
  76 .dv space .sp 1
  77 .dv half_space .sp 1
  78
  79 .** -----------------------------------------------
  80 .** not used, but might be needed if doc expanded
  81 .** .dv ta .br  ^.ta .br |
  82 .** .dv et .br ^.et .br
  83 .** .dv cl |
  84 .** .dv tr | .br ^.tr .br |
  85 .** .dv table_head $1
  86 .** .dv empty_cell &nbsp;
  87 .** -----------------------------------------------
  88
  89 .dv break .sm ^`  ^` .br
  90 .dv br .sm ^`  ^` .br
  91 .ju off
  92 .dv image .ep ^[ .sm $2] ($3)
  93
  94 .** no concept of a definition list in markdown; no start/end and just make the text bold to emulate
  95 .dv beg_dlist  .sp 1
  96 .dv bd  .sp 1
  97 .dv end_dlist .sp 1
  98 .dv ed .sp 1
  99 .dv di ^&break  **$1:**
 100
 101 .dv beg_list .bl *
 102 .dv item .li
 103 .dv li .li
 104 .dv end_list .el
 105
 106 .dv line .sp 1  ------
 107
 108 .** leading indention is significant to markdown, so turn it off
 109 .in 0
 110 .dv indent
 111 .dv uindent .sp 2
 112 .dv smindent
 113 .dv smuindent .sp 2
 114 .dv bold ** .sm $1 .sm **
 115 .dv ital _ .sm $1 .sm _
 116 .dv h1 .sp 2 # $1 .br
 117 .dv h2 .sp 1 ## $1 .br
 118 .dv h3 .sp 1 ### $1 .br
 119
 120 .dv ex_start .sp .5 .ll -4 .in .5i .sp 2 .fo off
 121 .dv ex_end .fo on .in 0i .ll +4 .sp 2