test/test_writers/test_manpage.py

   1 #! /usr/bin/env python
   2
   3 # $Id: test_latex2e.py 6003 2009-06-27 20:44:09Z milde $
   4 # Author: engelbert gruber <grubert@users.sourceforge.net>
   5 # Copyright: This module has been placed in the public domain.
   6
   7 """
   8 Tests for manpage writer.
   9 """
  10
  11 from __init__ import DocutilsTestSupport
  12
  13 from docutils._compat import b
  14
  15 def suite():
  16     settings = {}
  17     s = DocutilsTestSupport.PublishTestSuite('manpage', suite_settings=settings)
  18     s.generateTests(totest)
  19     return s
  20
  21 indend_macros = r""".
  22 .nr rst2man-indent-level 0
  23 .
  24 .de1 rstReportMargin
  25 \\$1 \\n[an-margin]
  26 level \\n[rst2man-indent-level]
  27 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  28 -
  29 \\n[rst2man-indent0]
  30 \\n[rst2man-indent1]
  31 \\n[rst2man-indent2]
  32 ..
  33 .de1 INDENT
  34 .\" .rstReportMargin pre:
  35 . RS \\$1
  36 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  37 . nr rst2man-indent-level +1
  38 .\" .rstReportMargin post:
  39 ..
  40 .de UNINDENT
  41 . RE
  42 .\" indent \\n[an-margin]
  43 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  44 .nr rst2man-indent-level -1
  45 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  46 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  47 ..
  48 """
  49
  50 totest = {}
  51
  52 totest['blank'] = [
  53         ["",
  54         r""".TH   "" "" ""
  55 .SH NAME
  56  \-
  57 .\" Man page generated from reStructeredText.
  58 .
  59 .\" Generated by docutils manpage writer.
  60 .
  61 """],
  62     ]
  63
  64 totest['simple'] = [
  65         ["""\
  66 ========
  67  simple
  68 ========
  69
  70 ---------------
  71  The way to go
  72 ---------------
  73
  74 :Author: someone@somewhere.net
  75 :Date:   2009-08-05
  76 :Copyright: public domain
  77 :Version: 0.1
  78 :Manual section: 1
  79 :Manual group: text processing
  80 :Arbitrary field: some text
  81
  82 SYNOPSIS
  83 ========
  84
  85 ::
  86
  87   K.I.S.S keep it simple.
  88
  89 DESCRIPTION
  90 ===========
  91
  92 General rule of life.
  93
  94 OPTIONS
  95 =======
  96
  97 --config=<file>         Read configuration settings from <file>, if it exists.
  98 --version, -V           Show this program's version number and exit.
  99 --help, -h              Show this help message and exit.
 100
 101 OTHER SECTION
 102 =============
 103
 104 With mixed case.
 105 """,
 106         r""".\" Man page generated from reStructeredText.
 107 .
 108 .TH SIMPLE 1 "2009-08-05" "0.1" "text processing"
 109 .SH NAME
 110 simple \- The way to go
 111 """+indend_macros+
 112 r""".SH SYNOPSIS
 113 .sp
 114 .nf
 115 .ft C
 116 K.I.S.S keep it simple.
 117 .ft P
 118 .fi
 119 .SH DESCRIPTION
 120 .sp
 121 General rule of life.
 122 .SH OPTIONS
 123 .INDENT 0.0
 124 .TP
 125 .BI \-\-config\fB= <file>
 126 Read configuration settings from <file>, if it exists.
 127 .TP
 128 .B \-\-version,  \-V
 129 Show this program\(aqs version number and exit.
 130 .TP
 131 .B \-\-help,  \-h
 132 Show this help message and exit.
 133 .UNINDENT
 134 .SH OTHER SECTION
 135 .sp
 136 With mixed case.
 137 .SH AUTHOR
 138 someone@somewhere.net
 139
 140 Arbitrary field: some text
 141 .SH COPYRIGHT
 142 public domain
 143 .\" Generated by docutils manpage writer.
 144 .
 145 """],
 146     ]
 147
 148 totest['table'] = [
 149         ["""\
 150         ====== =====
 151          head   and
 152         ====== =====
 153            1     2
 154           abc   so
 155         ====== =====
 156 """,
 157 '''\
 158 .TH   "" "" ""
 159 .SH NAME
 160  \\- \n\
 161 .\\" Man page generated from reStructeredText.
 162 .
 163 .INDENT 0.0
 164 .INDENT 3.5
 165 .TS
 166 center;
 167 |l|l|.
 168 _
 169 T{
 170 head
 171 T}\tT{
 172 and
 173 T}
 174 _
 175 T{
 176 1
 177 T}\tT{
 178 2
 179 T}
 180 _
 181 T{
 182 abc
 183 T}\tT{
 184 so
 185 T}
 186 _
 187 .TE
 188 .UNINDENT
 189 .UNINDENT
 190 .\\" Generated by docutils manpage writer.
 191 .
 192 ''']
 193 ]
 194
 195 totest['optiongroup'] = [
 196         ["""
 197 optin group with dot as group item
 198
 199 $
 200    bla bla bla
 201
 202 #
 203    bla bla bla
 204
 205 .
 206    bla bla bla
 207
 208 [
 209    bla bla bla
 210
 211 ]
 212    bla bla bla
 213 """,
 214         """\
 215 .TH   "" "" ""
 216 .SH NAME
 217  \\- \n\
 218 .\\" Man page generated from reStructeredText.
 219 .
 220 optin group with dot as group item
 221 .INDENT 0.0
 222 .TP
 223 .B $
 224 bla bla bla
 225 .UNINDENT
 226 .INDENT 0.0
 227 .TP
 228 .B #
 229 bla bla bla
 230 .UNINDENT
 231 .INDENT 0.0
 232 .TP
 233 .B .
 234 bla bla bla
 235 .UNINDENT
 236 .INDENT 0.0
 237 .TP
 238 .B [
 239 bla bla bla
 240 .UNINDENT
 241 .INDENT 0.0
 242 .TP
 243 .B ]
 244 bla bla bla
 245 .UNINDENT
 246 .\\" Generated by docutils manpage writer.
 247 ."""],
 248     ]
 249
 250 totest['definitionlist'] = [
 251         ["""
 252 ====================
 253 Definition List Test
 254 ====================
 255
 256 :Abstract: Docinfo is required.
 257
 258 Section
 259 =======
 260
 261 :term1:
 262
 263     Description of Term 1 Description of Term 1 Description of Term 1
 264     Description of Term 1 Description of Term 1
 265
 266     Description of Term 1 Description of Term 1 Description of Term 1
 267     Description of Term 1 Description of Term 1
 268
 269 """,
 270 '''\
 271 .TH DEFINITION LIST TEST  "" "" ""
 272 .SH NAME
 273 Definition List Test \\- \n\
 274 .\\" Man page generated from reStructeredText.
 275 .
 276 .SS Abstract
 277 .sp
 278 Docinfo is required.
 279 .SH SECTION
 280 .INDENT 0.0
 281 .TP
 282 .B term1
 283 Description of Term 1 Description of Term 1 Description of Term 1
 284 Description of Term 1 Description of Term 1
 285 .sp
 286 Description of Term 1 Description of Term 1 Description of Term 1
 287 Description of Term 1 Description of Term 1
 288 .UNINDENT
 289 .\\" Generated by docutils manpage writer.
 290 .'''],
 291     ]
 292
 293
 294 if __name__ == '__main__':
 295     import unittest
 296     unittest.main(defaultTest='suite')