diff options
| author | goodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2004-05-16 00:41:56 +0000 |
|---|---|---|
| committer | goodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2004-05-16 00:41:56 +0000 |
| commit | 916db3738fc6be21c244168d129589c4afd228fe (patch) | |
| tree | b323beec3f38b476e0237095f3958b4a7fd6fa50 /FAQ.txt | |
| parent | 114e74a2a2bfba9c118723f2588f944dddafa08b (diff) | |
| download | docutils-916db3738fc6be21c244168d129589c4afd228fe.tar.gz | |
minor edit
git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk/docutils@2103 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'FAQ.txt')
| -rw-r--r-- | FAQ.txt | 18 |
1 files changed, 10 insertions, 8 deletions
@@ -527,7 +527,7 @@ If there's only one highest-level section title at the beginning of a document, it is treated specially, as the document title. (Similarly, a lone second-highest-level section title may become the document subtitle.) See `How can I indicate the document title? Subtitle?`_ for -details. Rather than use a plain H1 for that, we use ``<h1 +details. Rather than use a plain H1 for the document title, we use ``<h1 class="title">`` so that we can use H1 again within the document. Why do we do this? HTML only has H1-H6, so by making H1 do double duty, we effectively reserve these tags to provide 6 levels of heading beyond the @@ -546,13 +546,15 @@ ordinary ``<h1>`` and ``<h2>``:: h2.subtitle { text-align: center } -If you don't want the top section heading to be interpretted as a title -at all, disable the `doctitle-xform`_ option (but this will interpret -you document differently from the standard settings, which might not be -a good idea). If you don't like the reuse of the H1 in the HTML output, -you can tweak the `initial-header-level`_ option - but unless you match -its value to your specific document, you might end up with invalid HTML -(e.g. H3 without H2). +If you don't want the top section heading to be interpretted as a +title at all, disable the `doctitle_xform`_ setting +(``--no-doc-title`` option). This will interpret your document +differently from the standard settings, which might not be a good +idea. If you don't like the reuse of the H1 in the HTML output, you +can tweak the `initial_header_level`_ setting +(``--initial-header-level`` option) -- but unless you match its value +to your specific document, you might end up with invalid HTML (e.g. H3 +without H2). .. _doctitle-xform: docs/config.html#doctitle-xform .. _initial-header-level: docs/config.html#initial-header-level |
