#! /usr/bin/env python3
# $Id: test_html5_polyglot_parts.py 9081 2022-06-19 20:23:12Z milde $
# Author: reggie dugard
# Copyright: This module has been placed in the public domain.
"""
Test for fragment code in HTML writer.
Note: the 'body' and 'whole' entries have been removed from the parts
dictionaries (redundant), along with 'meta' and 'stylesheet' entries with
standard values, and any entries with empty values.
"""
if __name__ == '__main__':
import __init__ # noqa: F401
from DocutilsTestSupport import (HtmlWriterPublishPartsTestCase,
HtmlPublishPartsTestSuite)
from docutils import __version__
class Html5WriterPublishPartsTestCase(HtmlWriterPublishPartsTestCase):
"""Test case for HTML5 writer via the publish_parts interface."""
writer_name = 'html5'
settings_default_overrides = HtmlWriterPublishPartsTestCase.settings_default_overrides.copy()
settings_default_overrides['section_self_link'] = True
standard_content_type_template = '\n'
standard_generator_template = '\n'
standard_viewport_template = '\n'
standard_html_meta_value = (standard_content_type_template
+ standard_viewport_template
+ standard_generator_template % __version__)
standard_meta_value = standard_html_meta_value % 'utf-8'
standard_html_prolog = '\n'
class Html5PublishPartsTestSuite(HtmlPublishPartsTestSuite):
testcase_class = Html5WriterPublishPartsTestCase
def suite():
s = Html5PublishPartsTestSuite()
s.generateTests(totest)
return s
totest = {}
totest['Title promotion'] = ({'stylesheet_path': '',
'embed_stylesheet': 0}, [
["""\
Simple String
""",
"""\
{'fragment': '''
\\n''',
'html_head': '''...<string>\\n'''}
"""],
["""\
One paragraph.
Two paragraphs.
""",
"""\
{'fragment': '''
One paragraph.
Two paragraphs.
\\n''',
'html_body': '''
One paragraph.
Two paragraphs.
\\n''',
'html_head': '''...<string>\\n'''}
"""],
["""\
A simple `named reference`_ with stuff in between the
reference and the target.
.. _`named reference`: http://www.test.com/test_url
""",
"""\
{'fragment': '''
A simple named reference with stuff in between the
reference and the target.
\\n''',
'html_body': '''
A simple named reference with stuff in between the
reference and the target.
\\n''',
'html_head': '''...<string>\\n'''}
"""],
["""\
+++++
Title
+++++
Subtitle
========
Some stuff
Section
-------
Some more stuff
Another Section
...............
And even more stuff
""",
"""\
{'fragment': '''
\\n''',
'html_head': '''...<string>\\n'''}
"""],
["""\
A simple `named reference`_ with stuff in between the
reference and the target.
.. _`named reference`: http://www.test.com/test_url
""",
"""\
{'fragment': '''
A simple named reference with stuff in between the
reference and the target.
\\n''',
'html_body': '''
A simple named reference with stuff in between the
reference and the target.
\\n''',
'html_head': '''...<string>\\n'''}
"""],
["""\
+++++
Title
+++++
Not A Subtitle
==============
Some stuff
Section
-------
Some more stuff
Another Section
...............
And even more stuff
""",
"""\
{'fragment': '''
\\n''',
'html_head': '''...<string>\\n'''}
"""],
["""\
Not a docinfo.
:This: .. _target:
is
:a:
:simple:
:field: list
""",
"""\
{'fragment': '''
Not a docinfo.
This:
is
a:
simple:
field:
list
\\n''',
'html_body': '''
Not a docinfo.
This:
is
a:
simple:
field:
list
\\n''',
'html_head': '''...<string>\\n'''}
"""],
["""\
Not a docinfo.
:This is: a
:simple field list with loooong field: names
""",
"""\
{'fragment': '''\
Not a docinfo.
This is:
a
simple field list with loooong field:
names
\\n''',
'html_body': '''\
Not a docinfo.
This is:
a
simple field list with loooong field:
names
\\n''',
'html_head': '''...<string>\\n'''}
"""],
["""\
Not a docinfo.
.. class:: field-indent-200
:This: is a
:simple: field list with custom indent.
""",
"""\
{'fragment': '''
Not a docinfo.
This:
is a
simple:
field list with custom indent.
\\n''',
'html_body': '''
Not a docinfo.
This:
is a
simple:
field list with custom indent.
\\n''',
'html_head': '''...<string>\\n'''}
"""],
["""\
Not a docinfo.
.. class:: field-indent-200uf
:This: is a
:simple: field list without custom indent,
because the unit "uf" is invalid.
""",
"""\
{'fragment': '''
Not a docinfo.
This:
is a
simple:
field list without custom indent,
because the unit "uf" is invalid.
\\n''',
'html_body': '''
Not a docinfo.
This:
is a
simple:
field list without custom indent,
because the unit "uf" is invalid.
\\n''',
'html_head': '''...<string>\\n'''}
"""],
["""\
.. figure:: dummy.png
The figure's caption.
A legend.
The legend's second paragraph.
""",
"""\
{'fragment': '''\
The figure's caption.
A legend.
The legend's second paragraph.
\\n''',
'html_body': '''\
The figure's caption.
A legend.
The legend's second paragraph.
\\n''',
'html_head': '''...<string>\\n'''}
"""],
["""\
.. figure:: dummy.png
The figure's caption, no legend.
""",
"""\
{'fragment': '''\
The figure's caption, no legend.
\\n''',
'html_body': '''\
The figure's caption, no legend.
\\n''',
'html_head': '''...<string>\\n'''}
"""],
["""\
.. figure:: dummy.png
..
A legend without caption.
""",
"""\
{'fragment': '''\
A legend without caption.
\\n''',
'html_body': '''\
A legend without caption.
\\n''',
'html_head': '''...<string>\\n'''}
"""],
["""\
.. figure:: dummy.png
No caption nor legend.
""",
"""\
{'fragment': '''\
No caption nor legend.
\\n''',
'html_body': '''\
No caption nor legend.
\\n''',
'html_head': '''...<string>\\n'''}
"""],
])
totest['lazy loading'] = ({'image_loading': 'lazy',
'stylesheet_path': '',
'embed_stylesheet': 0}, [
["""\
.. image:: dummy.png
""",
"""\
{'fragment': '''\
\\n''',
'html_body': '''\
\\n''',
'html_head': '''...<string>\\n'''}
"""],
["""\
.. figure:: dummy.png
""",
"""\
{'fragment': '''\
\\n''',
'html_body': '''\
\\n''',
'html_head': '''...<string>\\n'''}
"""],
])
totest['no backlinks'] = ({'footnote_backlinks': False,
'stylesheet_path': '',
'embed_stylesheet': 0}, [
["""\
Two footnotes [#f1]_ [#f2]_ and two citations [once]_ [twice]_.
The latter are referenced a second time [#f2]_ [twice]_.
.. [#f1] referenced once
.. [#f2] referenced twice
.. [once] citation referenced once
.. [twice] citation referenced twice
""",
"""\
{'fragment': '''\
