argo_navis: venv/lib/python2.7/site-packages/docutils/writers/manpage.py annotate

author	bcclaywell
date	Mon, 12 Oct 2015 17:43:33 -0400
parents
children

rev	line source
0 d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	1 # -- coding: utf-8 --
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	2 # $Id: manpage.py 7628 2013-03-09 10:19:35Z grubert $
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	3 # Author: Engelbert Gruber <grubert@users.sourceforge.net>
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	4 # Copyright: This module is put into the public domain.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	5
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	6 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	7 Simple man page writer for reStructuredText.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	8
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	9 Man pages (short for "manual pages") contain system documentation on unix-like
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	10 systems. The pages are grouped in numbered sections:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	11
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	12 1 executable programs and shell commands
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	13 2 system calls
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	14 3 library functions
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	15 4 special files
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	16 5 file formats
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	17 6 games
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	18 7 miscellaneous
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	19 8 system administration
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	20
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	21 Man pages are written troff, a text file formatting system.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	22
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	23 See http://www.tldp.org/HOWTO/Man-Page for a start.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	24
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	25 Man pages have no subsection only parts.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	26 Standard parts
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	27
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	28 NAME ,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	29 SYNOPSIS ,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	30 DESCRIPTION ,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	31 OPTIONS ,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	32 FILES ,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	33 SEE ALSO ,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	34 BUGS ,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	35
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	36 and
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	37
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	38 AUTHOR .
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	39
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	40 A unix-like system keeps an index of the DESCRIPTIONs, which is accesable
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	41 by the command whatis or apropos.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	42
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	43 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	44
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	45 __docformat__ = 'reStructuredText'
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	46
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	47 import re
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	48
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	49 import docutils
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	50 from docutils import nodes, writers, languages
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	51 try:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	52 import roman
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	53 except ImportError:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	54 import docutils.utils.roman as roman
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	55
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	56 FIELD_LIST_INDENT = 7
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	57 DEFINITION_LIST_INDENT = 7
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	58 OPTION_LIST_INDENT = 7
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	59 BLOCKQOUTE_INDENT = 3.5
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	60 LITERAL_BLOCK_INDENT = 3.5
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	61
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	62 # Define two macros so man/roff can calculate the
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	63 # indent/unindent margins by itself
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	64 MACRO_DEF = (r""".
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	65 .nr rst2man-indent-level 0
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	66 .
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	67 .de1 rstReportMargin
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	68 \\$1 \\n[an-margin]
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	69 level \\n[rst2man-indent-level]
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	70 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	71 -
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	72 \\n[rst2man-indent0]
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	73 \\n[rst2man-indent1]
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	74 \\n[rst2man-indent2]
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	75 ..
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	76 .de1 INDENT
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	77 .\" .rstReportMargin pre:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	78 . RS \\$1
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	79 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	80 . nr rst2man-indent-level +1
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	81 .\" .rstReportMargin post:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	82 ..
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	83 .de UNINDENT
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	84 . RE
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	85 .\" indent \\n[an-margin]
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	86 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	87 .nr rst2man-indent-level -1
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	88 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	89 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	90 ..
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	91 """)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	92
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	93 class Writer(writers.Writer):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	94
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	95 supported = ('manpage',)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	96 """Formats this writer supports."""
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	97
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	98 output = None
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	99 """Final translated form of `document`."""
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	100
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	101 def __init__(self):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	102 writers.Writer.__init__(self)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	103 self.translator_class = Translator
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	104
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	105 def translate(self):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	106 visitor = self.translator_class(self.document)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	107 self.document.walkabout(visitor)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	108 self.output = visitor.astext()
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	109
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	110
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	111 class Table(object):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	112 def __init__(self):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	113 self._rows = []
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	114 self._options = ['center']
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	115 self._tab_char = '\t'
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	116 self._coldefs = []
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	117 def new_row(self):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	118 self._rows.append([])
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	119 def append_separator(self, separator):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	120 """Append the separator for table head."""
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	121 self._rows.append([separator])
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	122 def append_cell(self, cell_lines):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	123 """cell_lines is an array of lines"""
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	124 start = 0
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	125 if len(cell_lines) > 0 and cell_lines[0] == '.sp\n':
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	126 start = 1
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	127 self._rows[-1].append(cell_lines[start:])
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	128 if len(self._coldefs) < len(self._rows[-1]):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	129 self._coldefs.append('l')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	130 def _minimize_cell(self, cell_lines):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	131 """Remove leading and trailing blank and ``.sp`` lines"""
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	132 while (cell_lines and cell_lines[0] in ('\n', '.sp\n')):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	133 del cell_lines[0]
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	134 while (cell_lines and cell_lines[-1] in ('\n', '.sp\n')):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	135 del cell_lines[-1]
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	136 def as_list(self):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	137 text = ['.TS\n']
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	138 text.append(' '.join(self._options) + ';\n')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	139 text.append('\|%s\|.\n' % ('\|'.join(self._coldefs)))
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	140 for row in self._rows:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	141 # row = array of cells. cell = array of lines.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	142 text.append('_\n') # line above
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	143 text.append('T{\n')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	144 for i in range(len(row)):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	145 cell = row[i]
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	146 self._minimize_cell(cell)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	147 text.extend(cell)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	148 if not text[-1].endswith('\n'):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	149 text[-1] += '\n'
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	150 if i < len(row)-1:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	151 text.append('T}'+self._tab_char+'T{\n')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	152 else:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	153 text.append('T}\n')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	154 text.append('_\n')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	155 text.append('.TE\n')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	156 return text
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	157
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	158 class Translator(nodes.NodeVisitor):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	159 """"""
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	160
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	161 words_and_spaces = re.compile(r'\S+\| +\|\n')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	162 possibly_a_roff_command = re.compile(r'\.\w')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	163 document_start = """Man page generated from reStructuredText."""
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	164
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	165 def __init__(self, document):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	166 nodes.NodeVisitor.__init__(self, document)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	167 self.settings = settings = document.settings
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	168 lcode = settings.language_code
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	169 self.language = languages.get_language(lcode, document.reporter)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	170 self.head = []
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	171 self.body = []
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	172 self.foot = []
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	173 self.section_level = 0
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	174 self.context = []
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	175 self.topic_class = ''
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	176 self.colspecs = []
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	177 self.compact_p = 1
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	178 self.compact_simple = None
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	179 # the list style "*" bullet or "#" numbered
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	180 self._list_char = []
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	181 # writing the header .TH and .SH NAME is postboned after
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	182 # docinfo.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	183 self._docinfo = {
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	184 "title" : "", "title_upper": "",
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	185 "subtitle" : "",
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	186 "manual_section" : "", "manual_group" : "",
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	187 "author" : [],
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	188 "date" : "",
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	189 "copyright" : "",
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	190 "version" : "",
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	191 }
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	192 self._docinfo_keys = [] # a list to keep the sequence as in source.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	193 self._docinfo_names = {} # to get name from text not normalized.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	194 self._in_docinfo = None
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	195 self._active_table = None
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	196 self._in_literal = False
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	197 self.header_written = 0
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	198 self._line_block = 0
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	199 self.authors = []
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	200 self.section_level = 0
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	201 self._indent = [0]
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	202 # central definition of simple processing rules
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	203 # what to output on : visit, depart
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	204 # Do not use paragraph requests ``.PP`` because these set indentation.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	205 # use ``.sp``. Remove superfluous ``.sp`` in ``astext``.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	206 #
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	207 # Fonts are put on a stack, the top one is used.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	208 # ``.ft P`` or ``\\fP`` pop from stack.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	209 # ``B`` bold, ``I`` italic, ``R`` roman should be available.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	210 # Hopefully ``C`` courier too.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	211 self.defs = {
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	212 'indent' : ('.INDENT %.1f\n', '.UNINDENT\n'),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	213 'definition_list_item' : ('.TP', ''),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	214 'field_name' : ('.TP\n.B ', '\n'),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	215 'literal' : ('\\fB', '\\fP'),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	216 'literal_block' : ('.sp\n.nf\n.ft C\n', '\n.ft P\n.fi\n'),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	217
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	218 'option_list_item' : ('.TP\n', ''),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	219
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	220 'reference' : (r'\fI\%', r'\fP'),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	221 'emphasis': ('\\fI', '\\fP'),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	222 'strong' : ('\\fB', '\\fP'),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	223 'term' : ('\n.B ', '\n'),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	224 'title_reference' : ('\\fI', '\\fP'),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	225
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	226 'topic-title' : ('.SS ',),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	227 'sidebar-title' : ('.SS ',),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	228
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	229 'problematic' : ('\n.nf\n', '\n.fi\n'),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	230 }
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	231 # NOTE do not specify the newline before a dot-command, but ensure
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	232 # it is there.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	233
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	234 def comment_begin(self, text):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	235 """Return commented version of the passed text WITHOUT end of
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	236 line/comment."""
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	237 prefix = '.\\" '
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	238 out_text = ''.join(
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	239 [(prefix + in_line + '\n')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	240 for in_line in text.split('\n')])
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	241 return out_text
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	242
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	243 def comment(self, text):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	244 """Return commented version of the passed text."""
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	245 return self.comment_begin(text)+'.\n'
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	246
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	247 def ensure_eol(self):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	248 """Ensure the last line in body is terminated by new line."""
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	249 if len(self.body) > 0 and self.body[-1][-1] != '\n':
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	250 self.body.append('\n')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	251
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	252 def astext(self):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	253 """Return the final formatted document as a string."""
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	254 if not self.header_written:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	255 # ensure we get a ".TH" as viewers require it.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	256 self.append_header()
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	257 # filter body
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	258 for i in xrange(len(self.body)-1, 0, -1):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	259 # remove superfluous vertical gaps.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	260 if self.body[i] == '.sp\n':
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	261 if self.body[i - 1][:4] in ('.BI ','.IP '):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	262 self.body[i] = '.\n'
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	263 elif (self.body[i - 1][:3] == '.B ' and
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	264 self.body[i - 2][:4] == '.TP\n'):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	265 self.body[i] = '.\n'
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	266 elif (self.body[i - 1] == '\n' and
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	267 not self.possibly_a_roff_command.match(self.body[i - 2]) and
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	268 (self.body[i - 3][:7] == '.TP\n.B '
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	269 or self.body[i - 3][:4] == '\n.B ')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	270 ):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	271 self.body[i] = '.\n'
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	272 return ''.join(self.head + self.body + self.foot)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	273
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	274 def deunicode(self, text):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	275 text = text.replace(u'\xa0', '\\ ')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	276 text = text.replace(u'\u2020', '\\(dg')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	277 return text
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	278
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	279 def visit_Text(self, node):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	280 text = node.astext()
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	281 text = text.replace('\\','\\e')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	282 replace_pairs = [
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	283 (u'-', ur'\-'),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	284 (u'\'', ur'\(aq'),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	285 (u'´', ur'\''),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	286 (u'`', ur'\(ga'),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	287 ]
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	288 for (in_char, out_markup) in replace_pairs:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	289 text = text.replace(in_char, out_markup)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	290 # unicode
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	291 text = self.deunicode(text)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	292 # prevent interpretation of "." at line start
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	293 if text.startswith('.'):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	294 text = '\\&' + text
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	295 if self._in_literal:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	296 text = text.replace('\n.', '\n\\&.')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	297 self.body.append(text)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	298
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	299 def depart_Text(self, node):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	300 pass
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	301
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	302 def list_start(self, node):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	303 class enum_char(object):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	304 enum_style = {
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	305 'bullet' : '\\(bu',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	306 'emdash' : '\\(em',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	307 }
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	308
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	309 def __init__(self, style):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	310 self._style = style
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	311 if node.has_key('start'):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	312 self._cnt = node['start'] - 1
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	313 else:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	314 self._cnt = 0
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	315 self._indent = 2
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	316 if style == 'arabic':
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	317 # indentation depends on number of childrens
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	318 # and start value.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	319 self._indent = len(str(len(node.children)))
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	320 self._indent += len(str(self._cnt)) + 1
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	321 elif style == 'loweralpha':
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	322 self._cnt += ord('a') - 1
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	323 self._indent = 3
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	324 elif style == 'upperalpha':
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	325 self._cnt += ord('A') - 1
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	326 self._indent = 3
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	327 elif style.endswith('roman'):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	328 self._indent = 5
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	329
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	330 def next(self):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	331 if self._style == 'bullet':
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	332 return self.enum_style[self._style]
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	333 elif self._style == 'emdash':
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	334 return self.enum_style[self._style]
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	335 self._cnt += 1
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	336 # TODO add prefix postfix
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	337 if self._style == 'arabic':
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	338 return "%d." % self._cnt
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	339 elif self._style in ('loweralpha', 'upperalpha'):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	340 return "%c." % self._cnt
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	341 elif self._style.endswith('roman'):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	342 res = roman.toRoman(self._cnt) + '.'
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	343 if self._style.startswith('upper'):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	344 return res.upper()
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	345 return res.lower()
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	346 else:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	347 return "%d." % self._cnt
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	348 def get_width(self):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	349 return self._indent
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	350 def __repr__(self):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	351 return 'enum_style-%s' % list(self._style)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	352
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	353 if node.has_key('enumtype'):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	354 self._list_char.append(enum_char(node['enumtype']))
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	355 else:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	356 self._list_char.append(enum_char('bullet'))
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	357 if len(self._list_char) > 1:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	358 # indent nested lists
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	359 self.indent(self._list_char[-2].get_width())
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	360 else:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	361 self.indent(self._list_char[-1].get_width())
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	362
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	363 def list_end(self):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	364 self.dedent()
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	365 self._list_char.pop()
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	366
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	367 def header(self):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	368 tmpl = (".TH %(title_upper)s %(manual_section)s"
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	369 " \"%(date)s\" \"%(version)s\" \"%(manual_group)s\"\n"
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	370 ".SH NAME\n"
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	371 "%(title)s \- %(subtitle)s\n")
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	372 return tmpl % self._docinfo
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	373
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	374 def append_header(self):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	375 """append header with .TH and .SH NAME"""
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	376 # NOTE before everything
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	377 # .TH title_upper section date source manual
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	378 if self.header_written:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	379 return
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	380 self.head.append(self.header())
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	381 self.head.append(MACRO_DEF)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	382 self.header_written = 1
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	383
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	384 def visit_address(self, node):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	385 self.visit_docinfo_item(node, 'address')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	386
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	387 def depart_address(self, node):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	388 pass
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	389
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	390 def visit_admonition(self, node, name=None):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	391 #
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	392 # Make admonitions a simple block quote
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	393 # with a strong heading
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	394 #
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	395 # Using .IP/.RE doesn't preserve indentation
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	396 # when admonitions contain bullets, literal,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	397 # and/or block quotes.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	398 #
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	399 if name:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	400 # .. admonition:: has no name
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	401 self.body.append('.sp\n')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	402 name = '%s%s:%s\n' % (
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	403 self.defs['strong'][0],
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	404 self.language.labels.get(name, name).upper(),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	405 self.defs['strong'][1],
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	406 )
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	407 self.body.append(name)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	408 self.visit_block_quote(node)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	409
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	410 def depart_admonition(self, node):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	411 self.depart_block_quote(node)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	412
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	413 def visit_attention(self, node):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	414 self.visit_admonition(node, 'attention')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	415
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	416 depart_attention = depart_admonition
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	417
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	418 def visit_docinfo_item(self, node, name):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	419 if name == 'author':
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	420 self._docinfo[name].append(node.astext())
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	421 else:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	422 self._docinfo[name] = node.astext()
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	423 self._docinfo_keys.append(name)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	424 raise nodes.SkipNode
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	425
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	426 def depart_docinfo_item(self, node):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	427 pass
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	428
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	429 def visit_author(self, node):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	430 self.visit_docinfo_item(node, 'author')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	431
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	432 depart_author = depart_docinfo_item
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	433
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	434 def visit_authors(self, node):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	435 # _author is called anyway.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	436 pass
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	437
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	438 def depart_authors(self, node):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	439 pass
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	440
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	441 def visit_block_quote(self, node):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	442 # BUG/HACK: indent alway uses the _last_ indention,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	443 # thus we need two of them.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	444 self.indent(BLOCKQOUTE_INDENT)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	445 self.indent(0)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	446
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	447 def depart_block_quote(self, node):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	448 self.dedent()
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	449 self.dedent()
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	450
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	451 def visit_bullet_list(self, node):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	452 self.list_start(node)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	453
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	454 def depart_bullet_list(self, node):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	455 self.list_end()
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	456
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	457 def visit_caption(self, node):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	458 pass
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	459
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	460 def depart_caption(self, node):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	461 pass
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	462
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	463 def visit_caution(self, node):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	464 self.visit_admonition(node, 'caution')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	465
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	466 depart_caution = depart_admonition
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	467
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	468 def visit_citation(self, node):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	469 num, text = node.astext().split(None, 1)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	470 num = num.strip()
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	471 self.body.append('.IP [%s] 5\n' % num)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	472
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	473 def depart_citation(self, node):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	474 pass
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	475
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	476 def visit_citation_reference(self, node):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	477 self.body.append('['+node.astext()+']')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	478 raise nodes.SkipNode
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	479
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	480 def visit_classifier(self, node):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	481 pass
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	482
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	483 def depart_classifier(self, node):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	484 pass
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	485
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	486 def visit_colspec(self, node):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	487 self.colspecs.append(node)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	488
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	489 def depart_colspec(self, node):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	490 pass
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	491
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	492 def write_colspecs(self):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	493 self.body.append("%s.\n" % ('L '*len(self.colspecs)))
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	494
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	495 def visit_comment(self, node,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	496 sub=re.compile('-(?=-)').sub):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	497 self.body.append(self.comment(node.astext()))
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	498 raise nodes.SkipNode
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	499
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	500 def visit_contact(self, node):

0

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1 # -*- coding: utf-8 -*-

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

2 # $Id: manpage.py 7628 2013-03-09 10:19:35Z grubert $

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

3 # Author: Engelbert Gruber <grubert@users.sourceforge.net>

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

4 # Copyright: This module is put into the public domain.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

5

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

6 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

7 Simple man page writer for reStructuredText.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

8

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

9 Man pages (short for "manual pages") contain system documentation on unix-like

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

10 systems. The pages are grouped in numbered sections:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

11

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

12 1 executable programs and shell commands

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

13 2 system calls

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

14 3 library functions

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

15 4 special files

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

16 5 file formats

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

17 6 games

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

18 7 miscellaneous

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

19 8 system administration

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

20

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

21 Man pages are written *troff*, a text file formatting system.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

22

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

23 See http://www.tldp.org/HOWTO/Man-Page for a start.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

24

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

25 Man pages have no subsection only parts.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

26 Standard parts

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

27

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

28 NAME ,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

29 SYNOPSIS ,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

30 DESCRIPTION ,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

31 OPTIONS ,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

32 FILES ,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

33 SEE ALSO ,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

34 BUGS ,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

35

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

36 and

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

37

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

38 AUTHOR .

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

39

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

40 A unix-like system keeps an index of the DESCRIPTIONs, which is accesable

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

41 by the command whatis or apropos.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

42

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

43 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

44

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

45 __docformat__ = 'reStructuredText'

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

46

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

47 import re

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

48

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

49 import docutils

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

50 from docutils import nodes, writers, languages

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

51 try:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

52 import roman

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

53 except ImportError:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

54 import docutils.utils.roman as roman

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

55

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

56 FIELD_LIST_INDENT = 7

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

57 DEFINITION_LIST_INDENT = 7

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

58 OPTION_LIST_INDENT = 7

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

59 BLOCKQOUTE_INDENT = 3.5

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

60 LITERAL_BLOCK_INDENT = 3.5

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

61

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

62 # Define two macros so man/roff can calculate the

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

63 # indent/unindent margins by itself

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

64 MACRO_DEF = (r""".

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

65 .nr rst2man-indent-level 0

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

66 .

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

67 .de1 rstReportMargin

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

68 \\$1 \\n[an-margin]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

69 level \\n[rst2man-indent-level]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

70 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

71 -

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

72 \\n[rst2man-indent0]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

73 \\n[rst2man-indent1]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

74 \\n[rst2man-indent2]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

75 ..

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

76 .de1 INDENT

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

77 .\" .rstReportMargin pre:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

78 . RS \\$1

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

79 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

80 . nr rst2man-indent-level +1

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

81 .\" .rstReportMargin post:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

82 ..

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

83 .de UNINDENT

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

84 . RE

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

85 .\" indent \\n[an-margin]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

86 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

87 .nr rst2man-indent-level -1

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

88 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

89 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

90 ..

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

91 """)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

92

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

93 class Writer(writers.Writer):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

94

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

95 supported = ('manpage',)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

96 """Formats this writer supports."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

97

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

98 output = None

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

99 """Final translated form of `document`."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

100

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

101 def __init__(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

102 writers.Writer.__init__(self)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

103 self.translator_class = Translator

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

104

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

105 def translate(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

106 visitor = self.translator_class(self.document)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

107 self.document.walkabout(visitor)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

108 self.output = visitor.astext()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

109

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

110

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

111 class Table(object):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

112 def __init__(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

113 self._rows = []

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

114 self._options = ['center']

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

115 self._tab_char = '\t'

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

116 self._coldefs = []

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

117 def new_row(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

118 self._rows.append([])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

119 def append_separator(self, separator):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

120 """Append the separator for table head."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

121 self._rows.append([separator])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

122 def append_cell(self, cell_lines):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

123 """cell_lines is an array of lines"""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

124 start = 0

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

125 if len(cell_lines) > 0 and cell_lines[0] == '.sp\n':

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

126 start = 1

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

127 self._rows[-1].append(cell_lines[start:])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

128 if len(self._coldefs) < len(self._rows[-1]):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

129 self._coldefs.append('l')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

130 def _minimize_cell(self, cell_lines):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

131 """Remove leading and trailing blank and ``.sp`` lines"""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

132 while (cell_lines and cell_lines[0] in ('\n', '.sp\n')):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

133 del cell_lines[0]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

134 while (cell_lines and cell_lines[-1] in ('\n', '.sp\n')):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

135 del cell_lines[-1]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

136 def as_list(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

137 text = ['.TS\n']

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

138 text.append(' '.join(self._options) + ';\n')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

139 text.append('|%s|.\n' % ('|'.join(self._coldefs)))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

140 for row in self._rows:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

141 # row = array of cells. cell = array of lines.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

142 text.append('_\n') # line above

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

143 text.append('T{\n')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

144 for i in range(len(row)):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

145 cell = row[i]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

146 self._minimize_cell(cell)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

147 text.extend(cell)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

148 if not text[-1].endswith('\n'):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

149 text[-1] += '\n'

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

150 if i < len(row)-1:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

151 text.append('T}'+self._tab_char+'T{\n')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

152 else:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

153 text.append('T}\n')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

154 text.append('_\n')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

155 text.append('.TE\n')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

156 return text

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

157

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

158 class Translator(nodes.NodeVisitor):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

159 """"""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

160

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

161 words_and_spaces = re.compile(r'\S+| +|\n')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

162 possibly_a_roff_command = re.compile(r'\.\w')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

163 document_start = """Man page generated from reStructuredText."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

164

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

165 def __init__(self, document):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

166 nodes.NodeVisitor.__init__(self, document)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

167 self.settings = settings = document.settings

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

168 lcode = settings.language_code

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

169 self.language = languages.get_language(lcode, document.reporter)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

170 self.head = []

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

171 self.body = []

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

172 self.foot = []

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

173 self.section_level = 0

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

174 self.context = []

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

175 self.topic_class = ''

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

176 self.colspecs = []

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

177 self.compact_p = 1

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

178 self.compact_simple = None

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

179 # the list style "*" bullet or "#" numbered

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

180 self._list_char = []

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

181 # writing the header .TH and .SH NAME is postboned after

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

182 # docinfo.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

183 self._docinfo = {

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

184 "title" : "", "title_upper": "",

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

185 "subtitle" : "",

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

186 "manual_section" : "", "manual_group" : "",

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

187 "author" : [],

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

188 "date" : "",

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

189 "copyright" : "",

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

190 "version" : "",

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

191 }

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

192 self._docinfo_keys = [] # a list to keep the sequence as in source.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

193 self._docinfo_names = {} # to get name from text not normalized.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

194 self._in_docinfo = None

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

195 self._active_table = None

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

196 self._in_literal = False

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

197 self.header_written = 0

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

198 self._line_block = 0

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

199 self.authors = []

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

200 self.section_level = 0

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

201 self._indent = [0]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

202 # central definition of simple processing rules

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

203 # what to output on : visit, depart

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

204 # Do not use paragraph requests ``.PP`` because these set indentation.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

205 # use ``.sp``. Remove superfluous ``.sp`` in ``astext``.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

206 #

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

207 # Fonts are put on a stack, the top one is used.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

208 # ``.ft P`` or ``\\fP`` pop from stack.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

209 # ``B`` bold, ``I`` italic, ``R`` roman should be available.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

210 # Hopefully ``C`` courier too.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

211 self.defs = {

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

212 'indent' : ('.INDENT %.1f\n', '.UNINDENT\n'),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

213 'definition_list_item' : ('.TP', ''),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

214 'field_name' : ('.TP\n.B ', '\n'),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

215 'literal' : ('\\fB', '\\fP'),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

216 'literal_block' : ('.sp\n.nf\n.ft C\n', '\n.ft P\n.fi\n'),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

217

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

218 'option_list_item' : ('.TP\n', ''),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

219

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

220 'reference' : (r'\fI\%', r'\fP'),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

221 'emphasis': ('\\fI', '\\fP'),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

222 'strong' : ('\\fB', '\\fP'),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

223 'term' : ('\n.B ', '\n'),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

224 'title_reference' : ('\\fI', '\\fP'),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

225

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

226 'topic-title' : ('.SS ',),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

227 'sidebar-title' : ('.SS ',),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

228

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

229 'problematic' : ('\n.nf\n', '\n.fi\n'),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

230 }

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

231 # NOTE do not specify the newline before a dot-command, but ensure

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

232 # it is there.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

233

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

234 def comment_begin(self, text):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

235 """Return commented version of the passed text WITHOUT end of

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

236 line/comment."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

237 prefix = '.\\" '

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

238 out_text = ''.join(

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

239 [(prefix + in_line + '\n')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

240 for in_line in text.split('\n')])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

241 return out_text

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

242

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

243 def comment(self, text):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

244 """Return commented version of the passed text."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

245 return self.comment_begin(text)+'.\n'

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

246

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

247 def ensure_eol(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

248 """Ensure the last line in body is terminated by new line."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

249 if len(self.body) > 0 and self.body[-1][-1] != '\n':

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

250 self.body.append('\n')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

251

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

252 def astext(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

253 """Return the final formatted document as a string."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

254 if not self.header_written:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

255 # ensure we get a ".TH" as viewers require it.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

256 self.append_header()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

257 # filter body

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

258 for i in xrange(len(self.body)-1, 0, -1):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

259 # remove superfluous vertical gaps.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

260 if self.body[i] == '.sp\n':

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

261 if self.body[i - 1][:4] in ('.BI ','.IP '):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

262 self.body[i] = '.\n'

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

263 elif (self.body[i - 1][:3] == '.B ' and

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

264 self.body[i - 2][:4] == '.TP\n'):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

265 self.body[i] = '.\n'

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

266 elif (self.body[i - 1] == '\n' and

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

267 not self.possibly_a_roff_command.match(self.body[i - 2]) and

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

268 (self.body[i - 3][:7] == '.TP\n.B '

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

269 or self.body[i - 3][:4] == '\n.B ')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

270 ):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

271 self.body[i] = '.\n'

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

272 return ''.join(self.head + self.body + self.foot)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

273

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

274 def deunicode(self, text):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

275 text = text.replace(u'\xa0', '\\ ')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

276 text = text.replace(u'\u2020', '\\(dg')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

277 return text

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

278

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

279 def visit_Text(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

280 text = node.astext()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

281 text = text.replace('\\','\\e')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

282 replace_pairs = [

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

283 (u'-', ur'\-'),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

284 (u'\'', ur'\(aq'),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

285 (u'´', ur'\''),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

286 (u'`', ur'\(ga'),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

287 ]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

288 for (in_char, out_markup) in replace_pairs:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

289 text = text.replace(in_char, out_markup)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

290 # unicode

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

291 text = self.deunicode(text)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

292 # prevent interpretation of "." at line start

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

293 if text.startswith('.'):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

294 text = '\\&' + text

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

295 if self._in_literal:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

296 text = text.replace('\n.', '\n\\&.')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

297 self.body.append(text)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

298

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

299 def depart_Text(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

300 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

301

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

302 def list_start(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

303 class enum_char(object):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

304 enum_style = {

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

305 'bullet' : '\\(bu',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

306 'emdash' : '\\(em',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

307 }

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

308

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

309 def __init__(self, style):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

310 self._style = style

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

311 if node.has_key('start'):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

312 self._cnt = node['start'] - 1

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

313 else:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

314 self._cnt = 0

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

315 self._indent = 2

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

316 if style == 'arabic':

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

317 # indentation depends on number of childrens

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

318 # and start value.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

319 self._indent = len(str(len(node.children)))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

320 self._indent += len(str(self._cnt)) + 1

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

321 elif style == 'loweralpha':

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

322 self._cnt += ord('a') - 1

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

323 self._indent = 3

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

324 elif style == 'upperalpha':

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

325 self._cnt += ord('A') - 1

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

326 self._indent = 3

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

327 elif style.endswith('roman'):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

328 self._indent = 5

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

329

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

330 def next(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

331 if self._style == 'bullet':

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

332 return self.enum_style[self._style]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

333 elif self._style == 'emdash':

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

334 return self.enum_style[self._style]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

335 self._cnt += 1

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

336 # TODO add prefix postfix

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

337 if self._style == 'arabic':

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

338 return "%d." % self._cnt

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

339 elif self._style in ('loweralpha', 'upperalpha'):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

340 return "%c." % self._cnt

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

341 elif self._style.endswith('roman'):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

342 res = roman.toRoman(self._cnt) + '.'

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

343 if self._style.startswith('upper'):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

344 return res.upper()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

345 return res.lower()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

346 else:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

347 return "%d." % self._cnt

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

348 def get_width(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

349 return self._indent

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

350 def __repr__(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

351 return 'enum_style-%s' % list(self._style)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

352

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

353 if node.has_key('enumtype'):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

354 self._list_char.append(enum_char(node['enumtype']))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

355 else:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

356 self._list_char.append(enum_char('bullet'))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

357 if len(self._list_char) > 1:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

358 # indent nested lists

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

359 self.indent(self._list_char[-2].get_width())

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

360 else:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

361 self.indent(self._list_char[-1].get_width())

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

362

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

363 def list_end(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

364 self.dedent()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

365 self._list_char.pop()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

366

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

367 def header(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

368 tmpl = (".TH %(title_upper)s %(manual_section)s"

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

369 " \"%(date)s\" \"%(version)s\" \"%(manual_group)s\"\n"

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

370 ".SH NAME\n"

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

371 "%(title)s \- %(subtitle)s\n")

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

372 return tmpl % self._docinfo

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

373

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

374 def append_header(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

375 """append header with .TH and .SH NAME"""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

376 # NOTE before everything

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

377 # .TH title_upper section date source manual

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

378 if self.header_written:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

379 return

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

380 self.head.append(self.header())

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

381 self.head.append(MACRO_DEF)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

382 self.header_written = 1

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

383

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

384 def visit_address(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

385 self.visit_docinfo_item(node, 'address')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

386

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

387 def depart_address(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

388 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

389

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

390 def visit_admonition(self, node, name=None):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

391 #

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

392 # Make admonitions a simple block quote

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

393 # with a strong heading

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

394 #

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

395 # Using .IP/.RE doesn't preserve indentation

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

396 # when admonitions contain bullets, literal,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

397 # and/or block quotes.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

398 #

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

399 if name:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

400 # .. admonition:: has no name

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

401 self.body.append('.sp\n')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

402 name = '%s%s:%s\n' % (

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

403 self.defs['strong'][0],

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

404 self.language.labels.get(name, name).upper(),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

405 self.defs['strong'][1],

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

406 )

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

407 self.body.append(name)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

408 self.visit_block_quote(node)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

409

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

410 def depart_admonition(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

411 self.depart_block_quote(node)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

412

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

413 def visit_attention(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

414 self.visit_admonition(node, 'attention')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

415

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

416 depart_attention = depart_admonition

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

417

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

418 def visit_docinfo_item(self, node, name):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

419 if name == 'author':

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

420 self._docinfo[name].append(node.astext())

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

421 else:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

422 self._docinfo[name] = node.astext()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

423 self._docinfo_keys.append(name)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

424 raise nodes.SkipNode

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

425

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

426 def depart_docinfo_item(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

427 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

428

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

429 def visit_author(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

430 self.visit_docinfo_item(node, 'author')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

431

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

432 depart_author = depart_docinfo_item

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

433

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

434 def visit_authors(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

435 # _author is called anyway.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

436 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

437

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

438 def depart_authors(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

439 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

440

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

441 def visit_block_quote(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

442 # BUG/HACK: indent alway uses the _last_ indention,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

443 # thus we need two of them.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

444 self.indent(BLOCKQOUTE_INDENT)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

445 self.indent(0)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

446

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

447 def depart_block_quote(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

448 self.dedent()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

449 self.dedent()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

450

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

451 def visit_bullet_list(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

452 self.list_start(node)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

453

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

454 def depart_bullet_list(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

455 self.list_end()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

456

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

457 def visit_caption(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

458 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

459

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

460 def depart_caption(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

461 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

462

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

463 def visit_caution(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

464 self.visit_admonition(node, 'caution')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

465

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

466 depart_caution = depart_admonition

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

467

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

468 def visit_citation(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

469 num, text = node.astext().split(None, 1)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

470 num = num.strip()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

471 self.body.append('.IP [%s] 5\n' % num)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

472

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

473 def depart_citation(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

474 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

475

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

476 def visit_citation_reference(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

477 self.body.append('['+node.astext()+']')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

478 raise nodes.SkipNode

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

479

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

480 def visit_classifier(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

481 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

482

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

483 def depart_classifier(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

484 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

485

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

486 def visit_colspec(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

487 self.colspecs.append(node)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

488

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

489 def depart_colspec(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

490 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

491

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

492 def write_colspecs(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

493 self.body.append("%s.\n" % ('L '*len(self.colspecs)))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

494

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

495 def visit_comment(self, node,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

496 sub=re.compile('-(?=-)').sub):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

497 self.body.append(self.comment(node.astext()))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

498 raise nodes.SkipNode

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

499

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

500 def visit_contact(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

501 self.visit_docinfo_item(node, 'contact')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

502

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

503 depart_contact = depart_docinfo_item

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

504

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

505 def visit_container(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

506 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

507

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

508 def depart_container(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

509 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

510

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

511 def visit_compound(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

512 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

513

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

514 def depart_compound(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

515 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

516

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

517 def visit_copyright(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

518 self.visit_docinfo_item(node, 'copyright')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

519

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

520 def visit_danger(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

521 self.visit_admonition(node, 'danger')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

522

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

523 depart_danger = depart_admonition

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

524

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

525 def visit_date(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

526 self.visit_docinfo_item(node, 'date')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

527

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

528 def visit_decoration(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

529 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

530

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

531 def depart_decoration(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

532 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

533

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

534 def visit_definition(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

535 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

536

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

537 def depart_definition(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

538 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

539

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

540 def visit_definition_list(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

541 self.indent(DEFINITION_LIST_INDENT)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

542

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

543 def depart_definition_list(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

544 self.dedent()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

545

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

546 def visit_definition_list_item(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

547 self.body.append(self.defs['definition_list_item'][0])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

548

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

549 def depart_definition_list_item(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

550 self.body.append(self.defs['definition_list_item'][1])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

551

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

552 def visit_description(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

553 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

554

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

555 def depart_description(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

556 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

557

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

558 def visit_docinfo(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

559 self._in_docinfo = 1

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

560

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

561 def depart_docinfo(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

562 self._in_docinfo = None

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

563 # NOTE nothing should be written before this

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

564 self.append_header()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

565

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

566 def visit_doctest_block(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

567 self.body.append(self.defs['literal_block'][0])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

568 self._in_literal = True

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

569

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

570 def depart_doctest_block(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

571 self._in_literal = False

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

572 self.body.append(self.defs['literal_block'][1])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

573

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

574 def visit_document(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

575 # no blank line between comment and header.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

576 self.head.append(self.comment(self.document_start).rstrip()+'\n')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

577 # writing header is postboned

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

578 self.header_written = 0

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

579

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

580 def depart_document(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

581 if self._docinfo['author']:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

582 self.body.append('.SH AUTHOR\n%s\n'

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

583 % ', '.join(self._docinfo['author']))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

584 skip = ('author', 'copyright', 'date',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

585 'manual_group', 'manual_section',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

586 'subtitle',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

587 'title', 'title_upper', 'version')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

588 for name in self._docinfo_keys:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

589 if name == 'address':

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

590 self.body.append("\n%s:\n%s%s.nf\n%s\n.fi\n%s%s" % (

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

591 self.language.labels.get(name, name),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

592 self.defs['indent'][0] % 0,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

593 self.defs['indent'][0] % BLOCKQOUTE_INDENT,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

594 self._docinfo[name],

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

595 self.defs['indent'][1],

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

596 self.defs['indent'][1]))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

597 elif not name in skip:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

598 if name in self._docinfo_names:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

599 label = self._docinfo_names[name]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

600 else:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

601 label = self.language.labels.get(name, name)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

602 self.body.append("\n%s: %s\n" % (label, self._docinfo[name]))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

603 if self._docinfo['copyright']:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

604 self.body.append('.SH COPYRIGHT\n%s\n'

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

605 % self._docinfo['copyright'])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

606 self.body.append(self.comment(

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

607 'Generated by docutils manpage writer.'))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

608

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

609 def visit_emphasis(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

610 self.body.append(self.defs['emphasis'][0])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

611

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

612 def depart_emphasis(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

613 self.body.append(self.defs['emphasis'][1])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

614

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

615 def visit_entry(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

616 # a cell in a table row

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

617 if 'morerows' in node:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

618 self.document.reporter.warning('"table row spanning" not supported',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

619 base_node=node)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

620 if 'morecols' in node:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

621 self.document.reporter.warning(

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

622 '"table cell spanning" not supported', base_node=node)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

623 self.context.append(len(self.body))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

624

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

625 def depart_entry(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

626 start = self.context.pop()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

627 self._active_table.append_cell(self.body[start:])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

628 del self.body[start:]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

629

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

630 def visit_enumerated_list(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

631 self.list_start(node)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

632

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

633 def depart_enumerated_list(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

634 self.list_end()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

635

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

636 def visit_error(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

637 self.visit_admonition(node, 'error')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

638

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

639 depart_error = depart_admonition

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

640

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

641 def visit_field(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

642 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

643

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

644 def depart_field(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

645 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

646

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

647 def visit_field_body(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

648 if self._in_docinfo:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

649 name_normalized = self._field_name.lower().replace(" ","_")

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

650 self._docinfo_names[name_normalized] = self._field_name

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

651 self.visit_docinfo_item(node, name_normalized)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

652 raise nodes.SkipNode

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

653

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

654 def depart_field_body(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

655 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

656

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

657 def visit_field_list(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

658 self.indent(FIELD_LIST_INDENT)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

659

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

660 def depart_field_list(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

661 self.dedent()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

662

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

663 def visit_field_name(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

664 if self._in_docinfo:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

665 self._field_name = node.astext()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

666 raise nodes.SkipNode

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

667 else:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

668 self.body.append(self.defs['field_name'][0])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

669

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

670 def depart_field_name(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

671 self.body.append(self.defs['field_name'][1])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

672

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

673 def visit_figure(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

674 self.indent(2.5)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

675 self.indent(0)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

676

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

677 def depart_figure(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

678 self.dedent()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

679 self.dedent()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

680

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

681 def visit_footer(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

682 self.document.reporter.warning('"footer" not supported',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

683 base_node=node)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

684

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

685 def depart_footer(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

686 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

687

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

688 def visit_footnote(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

689 num, text = node.astext().split(None, 1)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

690 num = num.strip()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

691 self.body.append('.IP [%s] 5\n' % self.deunicode(num))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

692

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

693 def depart_footnote(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

694 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

695

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

696 def footnote_backrefs(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

697 self.document.reporter.warning('"footnote_backrefs" not supported',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

698 base_node=node)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

699

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

700 def visit_footnote_reference(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

701 self.body.append('['+self.deunicode(node.astext())+']')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

702 raise nodes.SkipNode

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

703

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

704 def depart_footnote_reference(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

705 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

706

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

707 def visit_generated(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

708 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

709

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

710 def depart_generated(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

711 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

712

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

713 def visit_header(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

714 raise NotImplementedError, node.astext()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

715

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

716 def depart_header(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

717 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

718

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

719 def visit_hint(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

720 self.visit_admonition(node, 'hint')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

721

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

722 depart_hint = depart_admonition

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

723

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

724 def visit_subscript(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

725 self.body.append('\\s-2\\d')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

726

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

727 def depart_subscript(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

728 self.body.append('\\u\\s0')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

729

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

730 def visit_superscript(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

731 self.body.append('\\s-2\\u')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

732

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

733 def depart_superscript(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

734 self.body.append('\\d\\s0')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

735

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

736 def visit_attribution(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

737 self.body.append('\\(em ')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

738

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

739 def depart_attribution(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

740 self.body.append('\n')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

741

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

742 def visit_image(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

743 self.document.reporter.warning('"image" not supported',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

744 base_node=node)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

745 text = []

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

746 if 'alt' in node.attributes:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

747 text.append(node.attributes['alt'])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

748 if 'uri' in node.attributes:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

749 text.append(node.attributes['uri'])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

750 self.body.append('[image: %s]\n' % ('/'.join(text)))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

751 raise nodes.SkipNode

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

752

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

753 def visit_important(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

754 self.visit_admonition(node, 'important')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

755

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

756 depart_important = depart_admonition

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

757

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

758 def visit_label(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

759 # footnote and citation

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

760 if (isinstance(node.parent, nodes.footnote)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

761 or isinstance(node.parent, nodes.citation)):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

762 raise nodes.SkipNode

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

763 self.document.reporter.warning('"unsupported "label"',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

764 base_node=node)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

765 self.body.append('[')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

766

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

767 def depart_label(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

768 self.body.append(']\n')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

769

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

770 def visit_legend(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

771 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

772

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

773 def depart_legend(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

774 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

775

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

776 # WHAT should we use .INDENT, .UNINDENT ?

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

777 def visit_line_block(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

778 self._line_block += 1

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

779 if self._line_block == 1:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

780 # TODO: separate inline blocks from previous paragraphs

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

781 # see http://hg.intevation.org/mercurial/crew/rev/9c142ed9c405

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

782 # self.body.append('.sp\n')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

783 # but it does not work for me.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

784 self.body.append('.nf\n')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

785 else:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

786 self.body.append('.in +2\n')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

787

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

788 def depart_line_block(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

789 self._line_block -= 1

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

790 if self._line_block == 0:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

791 self.body.append('.fi\n')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

792 self.body.append('.sp\n')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

793 else:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

794 self.body.append('.in -2\n')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

795

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

796 def visit_line(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

797 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

798

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

799 def depart_line(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

800 self.body.append('\n')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

801

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

802 def visit_list_item(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

803 # man 7 man argues to use ".IP" instead of ".TP"

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

804 self.body.append('.IP %s %d\n' % (

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

805 self._list_char[-1].next(),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

806 self._list_char[-1].get_width(),))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

807

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

808 def depart_list_item(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

809 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

810

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

811 def visit_literal(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

812 self.body.append(self.defs['literal'][0])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

813

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

814 def depart_literal(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

815 self.body.append(self.defs['literal'][1])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

816

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

817 def visit_literal_block(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

818 # BUG/HACK: indent alway uses the _last_ indention,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

819 # thus we need two of them.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

820 self.indent(LITERAL_BLOCK_INDENT)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

821 self.indent(0)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

822 self.body.append(self.defs['literal_block'][0])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

823 self._in_literal = True

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

824

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

825 def depart_literal_block(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

826 self._in_literal = False

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

827 self.body.append(self.defs['literal_block'][1])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

828 self.dedent()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

829 self.dedent()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

830

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

831 def visit_math(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

832 self.document.reporter.warning('"math" role not supported',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

833 base_node=node)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

834 self.visit_literal(node)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

835

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

836 def depart_math(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

837 self.depart_literal(node)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

838

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

839 def visit_math_block(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

840 self.document.reporter.warning('"math" directive not supported',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

841 base_node=node)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

842 self.visit_literal_block(node)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

843

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

844 def depart_math_block(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

845 self.depart_literal_block(node)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

846

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

847 def visit_meta(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

848 raise NotImplementedError, node.astext()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

849

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

850 def depart_meta(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

851 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

852

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

853 def visit_note(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

854 self.visit_admonition(node, 'note')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

855

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

856 depart_note = depart_admonition

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

857

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

858 def indent(self, by=0.5):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

859 # if we are in a section ".SH" there already is a .RS

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

860 step = self._indent[-1]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

861 self._indent.append(by)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

862 self.body.append(self.defs['indent'][0] % step)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

863

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

864 def dedent(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

865 self._indent.pop()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

866 self.body.append(self.defs['indent'][1])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

867

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

868 def visit_option_list(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

869 self.indent(OPTION_LIST_INDENT)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

870

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

871 def depart_option_list(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

872 self.dedent()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

873

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

874 def visit_option_list_item(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

875 # one item of the list

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

876 self.body.append(self.defs['option_list_item'][0])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

877

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

878 def depart_option_list_item(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

879 self.body.append(self.defs['option_list_item'][1])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

880

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

881 def visit_option_group(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

882 # as one option could have several forms it is a group

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

883 # options without parameter bold only, .B, -v

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

884 # options with parameter bold italic, .BI, -f file

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

885 #

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

886 # we do not know if .B or .BI

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

887 self.context.append('.B') # blind guess

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

888 self.context.append(len(self.body)) # to be able to insert later

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

889 self.context.append(0) # option counter

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

890

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

891 def depart_option_group(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

892 self.context.pop() # the counter

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

893 start_position = self.context.pop()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

894 text = self.body[start_position:]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

895 del self.body[start_position:]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

896 self.body.append('%s%s\n' % (self.context.pop(), ''.join(text)))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

897

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

898 def visit_option(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

899 # each form of the option will be presented separately

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

900 if self.context[-1] > 0:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

901 self.body.append('\\fP,\\fB ')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

902 if self.context[-3] == '.BI':

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

903 self.body.append('\\')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

904 self.body.append(' ')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

905

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

906 def depart_option(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

907 self.context[-1] += 1

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

908

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

909 def visit_option_string(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

910 # do not know if .B or .BI

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

911 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

912

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

913 def depart_option_string(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

914 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

915

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

916 def visit_option_argument(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

917 self.context[-3] = '.BI' # bold/italic alternate

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

918 if node['delimiter'] != ' ':

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

919 self.body.append('\\fB%s ' % node['delimiter'])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

920 elif self.body[len(self.body)-1].endswith('='):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

921 # a blank only means no blank in output, just changing font

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

922 self.body.append(' ')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

923 else:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

924 # blank backslash blank, switch font then a blank

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

925 self.body.append(' \\ ')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

926

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

927 def depart_option_argument(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

928 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

929

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

930 def visit_organization(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

931 self.visit_docinfo_item(node, 'organization')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

932

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

933 def depart_organization(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

934 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

935

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

936 def first_child(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

937 first = isinstance(node.parent[0], nodes.label) # skip label

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

938 for child in node.parent.children[first:]:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

939 if isinstance(child, nodes.Invisible):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

940 continue

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

941 if child is node:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

942 return 1

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

943 break

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

944 return 0

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

945

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

946 def visit_paragraph(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

947 # ``.PP`` : Start standard indented paragraph.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

948 # ``.LP`` : Start block paragraph, all except the first.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

949 # ``.P [type]`` : Start paragraph type.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

950 # NOTE dont use paragraph starts because they reset indentation.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

951 # ``.sp`` is only vertical space

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

952 self.ensure_eol()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

953 if not self.first_child(node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

954 self.body.append('.sp\n')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

955

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

956 def depart_paragraph(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

957 self.body.append('\n')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

958

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

959 def visit_problematic(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

960 self.body.append(self.defs['problematic'][0])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

961

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

962 def depart_problematic(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

963 self.body.append(self.defs['problematic'][1])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

964

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

965 def visit_raw(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

966 if node.get('format') == 'manpage':

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

967 self.body.append(node.astext() + "\n")

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

968 # Keep non-manpage raw text out of output:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

969 raise nodes.SkipNode

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

970

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

971 def visit_reference(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

972 """E.g. link or email address."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

973 self.body.append(self.defs['reference'][0])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

974

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

975 def depart_reference(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

976 self.body.append(self.defs['reference'][1])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

977

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

978 def visit_revision(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

979 self.visit_docinfo_item(node, 'revision')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

980

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

981 depart_revision = depart_docinfo_item

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

982

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

983 def visit_row(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

984 self._active_table.new_row()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

985

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

986 def depart_row(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

987 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

988

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

989 def visit_section(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

990 self.section_level += 1

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

991

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

992 def depart_section(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

993 self.section_level -= 1

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

994

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

995 def visit_status(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

996 self.visit_docinfo_item(node, 'status')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

997

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

998 depart_status = depart_docinfo_item

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

999

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1000 def visit_strong(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1001 self.body.append(self.defs['strong'][0])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1002

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1003 def depart_strong(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1004 self.body.append(self.defs['strong'][1])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1005

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1006 def visit_substitution_definition(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1007 """Internal only."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1008 raise nodes.SkipNode

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1009

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1010 def visit_substitution_reference(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1011 self.document.reporter.warning('"substitution_reference" not supported',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1012 base_node=node)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1013

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1014 def visit_subtitle(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1015 if isinstance(node.parent, nodes.sidebar):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1016 self.body.append(self.defs['strong'][0])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1017 elif isinstance(node.parent, nodes.document):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1018 self.visit_docinfo_item(node, 'subtitle')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1019 elif isinstance(node.parent, nodes.section):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1020 self.body.append(self.defs['strong'][0])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1021

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1022 def depart_subtitle(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1023 # document subtitle calls SkipNode

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1024 self.body.append(self.defs['strong'][1]+'\n.PP\n')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1025

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1026 def visit_system_message(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1027 # TODO add report_level

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1028 #if node['level'] < self.document.reporter['writer'].report_level:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1029 # Level is too low to display:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1030 # raise nodes.SkipNode

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1031 attr = {}

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1032 backref_text = ''

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1033 if node.hasattr('id'):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1034 attr['name'] = node['id']

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1035 if node.hasattr('line'):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1036 line = ', line %s' % node['line']

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1037 else:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1038 line = ''

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1039 self.body.append('.IP "System Message: %s/%s (%s:%s)"\n'

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1040 % (node['type'], node['level'], node['source'], line))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1041

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1042 def depart_system_message(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1043 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1044

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1045 def visit_table(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1046 self._active_table = Table()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1047

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1048 def depart_table(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1049 self.ensure_eol()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1050 self.body.extend(self._active_table.as_list())

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1051 self._active_table = None

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1052

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1053 def visit_target(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1054 # targets are in-document hyper targets, without any use for man-pages.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1055 raise nodes.SkipNode

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1056

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1057 def visit_tbody(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1058 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1059

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1060 def depart_tbody(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1061 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1062

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1063 def visit_term(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1064 self.body.append(self.defs['term'][0])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1065

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1066 def depart_term(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1067 self.body.append(self.defs['term'][1])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1068

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1069 def visit_tgroup(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1070 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1071

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1072 def depart_tgroup(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1073 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1074

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1075 def visit_thead(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1076 # MAYBE double line '='

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1077 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1078

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1079 def depart_thead(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1080 # MAYBE double line '='

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1081 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1082

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1083 def visit_tip(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1084 self.visit_admonition(node, 'tip')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1085

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1086 depart_tip = depart_admonition

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1087

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1088 def visit_title(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1089 if isinstance(node.parent, nodes.topic):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1090 self.body.append(self.defs['topic-title'][0])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1091 elif isinstance(node.parent, nodes.sidebar):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1092 self.body.append(self.defs['sidebar-title'][0])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1093 elif isinstance(node.parent, nodes.admonition):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1094 self.body.append('.IP "')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1095 elif self.section_level == 0:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1096 self._docinfo['title'] = node.astext()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1097 # document title for .TH

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1098 self._docinfo['title_upper'] = node.astext().upper()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1099 raise nodes.SkipNode

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1100 elif self.section_level == 1:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1101 self.body.append('.SH %s\n' % self.deunicode(node.astext().upper()))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1102 raise nodes.SkipNode

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1103 else:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1104 self.body.append('.SS ')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1105

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1106 def depart_title(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1107 if isinstance(node.parent, nodes.admonition):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1108 self.body.append('"')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1109 self.body.append('\n')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1110

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1111 def visit_title_reference(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1112 """inline citation reference"""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1113 self.body.append(self.defs['title_reference'][0])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1114

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1115 def depart_title_reference(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1116 self.body.append(self.defs['title_reference'][1])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1117

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1118 def visit_topic(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1119 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1120

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1121 def depart_topic(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1122 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1123

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1124 def visit_sidebar(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1125 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1126

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1127 def depart_sidebar(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1128 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1129

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1130 def visit_rubric(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1131 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1132

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1133 def depart_rubric(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1134 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1135

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1136 def visit_transition(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1137 # .PP Begin a new paragraph and reset prevailing indent.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1138 # .sp N leaves N lines of blank space.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1139 # .ce centers the next line

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1140 self.body.append('\n.sp\n.ce\n----\n')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1141

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1142 def depart_transition(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1143 self.body.append('\n.ce 0\n.sp\n')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1144

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1145 def visit_version(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1146 self.visit_docinfo_item(node, 'version')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1147

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1148 def visit_warning(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1149 self.visit_admonition(node, 'warning')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1150

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1151 depart_warning = depart_admonition

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1152

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1153 def unimplemented_visit(self, node):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1154 raise NotImplementedError('visiting unimplemented node type: %s'

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1155 % node.__class__.__name__)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1156

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1157 # vim: set fileencoding=utf-8 et ts=4 ai :

Mercurial > repos > bcclaywell > argo_navis

annotate venv/lib/python2.7/site-packages/docutils/writers/manpage.py @ 0:d67268158946 draft