summaryrefslogtreecommitdiff
path: root/docutils/docs
diff options
context:
space:
mode:
authormilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2021-03-09 12:54:13 +0000
committermilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2021-03-09 12:54:13 +0000
commit5c3b677b4a8d596e73541dc85d6809207242589f (patch)
treef0e6a0c2e123717f85a40e5849c993c50f5d5a95 /docutils/docs
parentd8b162c12527422e33fdc3e21b34c2d6c69fc2b7 (diff)
downloaddocutils-5c3b677b4a8d596e73541dc85d6809207242589f.tar.gz
Small documentation updates and fixes.
git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8633 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docutils/docs')
-rw-r--r--docutils/docs/ref/rst/directives.txt16
1 files changed, 12 insertions, 4 deletions
diff --git a/docutils/docs/ref/rst/directives.txt b/docutils/docs/ref/rst/directives.txt
index 353e85436..b38493529 100644
--- a/docutils/docs/ref/rst/directives.txt
+++ b/docutils/docs/ref/rst/directives.txt
@@ -1868,12 +1868,13 @@ Metadata
:Directive Content: Must contain a flat field list.
The "meta" directive is used to specify metadata\ [#]_ to be stored
-in, e.g., HTML META tags or as ODT file properties. If the output
-format does not support "invisible" metadata, it is silently
-dropped by the writer.
+in, e.g., `HTML meta elements`_ or as `ODT file properties`_. The
+LaTeX writer passes it to the ``pdfinfo`` option of the hyperref_
+package. If an output format does not support "invisible" metadata,
+content is silently dropped by the writer.
.. note:: Data from some `bibliographic fields`_ is automatically
- extracted and stored in META tags, too. However, Bibliographic
+ extracted and stored as metadata, too. However, Bibliographic
Fields are also visible in the document's screen rendering or
printout.
@@ -1920,11 +1921,18 @@ HTML equivalent::
<meta http-equiv="Content-Type"
content="text/html; charset=ISO-8859-1">
+
.. [#] "Metadata" is data about data, in this case data about the
document. Metadata is, e.g., used to describe and classify web
pages in the World Wide Web, in a form that is easy for search
engines to extract and collate.
+
+.. _HTML meta elements:
+ https://html.spec.whatwg.org/multipage/semantics.html#the-meta-element
+.. _ODT file properties:
+ https://en.wikipedia.org/wiki/OpenDocument_technical_specification#Metadata
+.. _hyperref: http://ctan.org/pkg/hyperref
.. _bibliographic fields: restructuredtext.html#bibliographic-fields