← Back to branch summary

~ubuntu-branches/ubuntu/karmic/python-docutils/karmic

« back to all changes in this revision

Viewing changes to docutils/parsers/rst/directives/parts.py

  • Committer: Bazaar Package Importer
  • Author(s): martin f. krafft
  • Date: 2006-07-10 11:45:05 UTC
  • mfrom: (2.1.4 edgy)
  • Revision ID: james.westby@ubuntu.com-20060710114505-otkhqcslevewxmz5
Tags: 0.4-3
http://bugs.debian.org/377580
Added build dependency on python-central (closes: #377580).

Show diffs side-by-side

added added

removed removed

Lines of Context:
docutils/parsers/rst/directives/parts.py
1
1
# Author: David Goodger, Dmitry Jemerov
2
2
# Contact: goodger@users.sourceforge.net
3
 
# Revision: $Revision: 1.12 $
4
 
# Date: $Date: 2004/03/22 01:08:19 $
 
3
# Revision: $Revision: 3439 $
 
4
# Date: $Date: 2005-06-06 03:20:35 +0200 (Mon, 06 Jun 2005) $
5
5
# Copyright: This module has been placed in the public domain.
6
6
 
7
7
"""
26
26
 
27
27
def contents(name, arguments, options, content, lineno,
28
28
             content_offset, block_text, state, state_machine):
29
 
    """Table of contents."""
 
29
    """
 
30
    Table of contents.
 
31
 
 
32
    The table of contents is generated in two passes: initial parse and
 
33
    transform.  During the initial parse, a 'pending' element is generated
 
34
    which acts as a placeholder, storing the TOC title and any options
 
35
    internally.  At a later stage in the processing, the 'pending' element is
 
36
    replaced by a 'topic' element, a title and the table of contents proper.
 
37
    """
 
38
    if not (state_machine.match_titles
 
39
            or isinstance(state_machine.node, nodes.sidebar)):
 
40
        error = state_machine.reporter.error(
 
41
              'The "%s" directive may not be used within topics '
 
42
              'or body elements.' % name,
 
43
              nodes.literal_block(block_text, block_text), line=lineno)
 
44
        return [error]
30
45
    document = state_machine.document
31
46
    language = languages.get_language(document.settings.language_code)
32
 
 
33
47
    if arguments:
34
48
        title_text = arguments[0]
35
49
        text_nodes, messages = state.inline_text(title_text, lineno)
40
54
            title = None
41
55
        else:
42
56
            title = nodes.title('', language.labels['contents'])
43
 
 
44
 
    topic = nodes.topic(CLASS='contents')
45
 
 
46
 
    cls = options.get('class')
47
 
    if cls:
48
 
        topic.set_class(cls)
49
 
 
 
57
    topic = nodes.topic(classes=['contents'])
 
58
    topic['classes'] += options.get('class', [])
 
59
    if options.has_key('local'):
 
60
        topic['classes'].append('local')
50
61
    if title:
51
62
        name = title.astext()
52
63
        topic += title
53
64
    else:
54
65
        name = language.labels['contents']
55
 
 
56
66
    name = nodes.fully_normalize_name(name)
57
67
    if not document.has_name(name):
58
 
        topic['name'] = name
 
68
        topic['names'].append(name)
59
69
    document.note_implicit_target(topic)
60
 
 
61
70
    pending = nodes.pending(parts.Contents, rawsource=block_text)
62
71
    pending.details.update(options)
63
72
    document.note_pending(pending)
78
87
    state_machine.document.note_pending(pending)
79
88
    return [pending]
80
89
 
81
 
sectnum.options = {'depth': int}
 
90
sectnum.options = {'depth': int,
 
91
                   'start': int,
 
92
                   'prefix': directives.unchanged_required,
 
93
                   'suffix': directives.unchanged_required}
 
94
 
 
95
def header_footer(node, name, arguments, options, content, lineno,
 
96
                  content_offset, block_text, state, state_machine):
 
97
    """Contents of document header or footer."""
 
98
    if not content:
 
99
        warning = state_machine.reporter.warning(
 
100
            'Content block expected for the "%s" directive; none found.'
 
101
            % name, nodes.literal_block(block_text, block_text),
 
102
            line=lineno)
 
103
        node.append(nodes.paragraph(
 
104
            '', 'Problem with the "%s" directive: no content supplied.' % name))
 
105
        return [warning]
 
106
    text = '\n'.join(content)
 
107
    state.nested_parse(content, content_offset, node)
 
108
    return []
 
109
 
 
110
def header(name, arguments, options, content, lineno,
 
111
           content_offset, block_text, state, state_machine):
 
112
    decoration = state_machine.document.get_decoration()
 
113
    node = decoration.get_header()
 
114
    return header_footer(node, name, arguments, options, content, lineno,
 
115
                         content_offset, block_text, state, state_machine)
 
116
 
 
117
header.content = 1
 
118
 
 
119
def footer(name, arguments, options, content, lineno,
 
120
           content_offset, block_text, state, state_machine):
 
121
    decoration = state_machine.document.get_decoration()
 
122
    node = decoration.get_footer()
 
123
    return header_footer(node, name, arguments, options, content, lineno,
 
124
                         content_offset, block_text, state, state_machine)
 
125
 
 
126
footer.content = 1