SF.net SVN: docutils:[9669] trunk/docutils/docs/ref/rst/directives.txt

Revision: 9669
          http://sourceforge.net/p/docutils/code/9669
Author:   milde
Date:     2024-05-02 15:55:31 +0000 (Thu, 02 May 2024)
Log Message:
-----------
More precise wording in directives documentation.

Use "caption" instead of "title" for the short description of a table.

While the XML Exchange Model employed in the Docutils Document Tree uses
a <title> element for "historic reasons", the main output formats
HTML and LaTeX both call it a "caption".

Modified Paths:
--------------
    trunk/docutils/docs/ref/rst/directives.txt

Modified: trunk/docutils/docs/ref/rst/directives.txt
===================================================================
--- trunk/docutils/docs/ref/rst/directives.txt	2024-05-02 15:55:23 UTC (rev 9668)
+++ trunk/docutils/docs/ref/rst/directives.txt	2024-05-02 15:55:31 UTC (rev 9669)
@@ -805,7 +805,7 @@
 :Directive Content: Interpreted as body elements.
 
 The "container" directive surrounds its contents (arbitrary body
-elements) with a generic block-level "container" element.  
+elements) with a generic block-level "container" element.
 Combined with the optional argument, this is an
 extension mechanism for users & applications.  For example::
 
@@ -844,13 +844,13 @@
 
 :Directive Type: "table"
 :Doctree Element: `\<table>`_
-:Directive Arguments: one, optional (table title)
+:Directive Arguments: one, optional (table caption)
 :Directive Options: `see below <table options_>`__
 :Directive Content: A normal `reStructuredText table`_.
 :Configuration Setting: table_style_
 
-The "table" directive is used to associate a
-title with a table or specify options, e.g.::
+The "table" directive is used to provide a table caption
+or specify options, e.g.::
 
     .. table:: Truth table for "not"
        :widths: auto
@@ -907,7 +907,7 @@
 
 :Directive Type: "csv-table"
 :Doctree Element: `\<table>`_
-:Directive Arguments: one, optional (table title)
+:Directive Arguments: one, optional (table caption)
 :Directive Options: `see below <csv-table options_>`__
 :Directive Content: A CSV (comma-separated values) table
                     or (with the `file`_ or `url`_ options) none.
@@ -1042,7 +1042,7 @@
 
 :Directive Type: "list-table"
 :Doctree Element: `\<table>`_
-:Directive Arguments: one, optional (table title)
+:Directive Arguments: one, optional (table caption)
 :Directive Options: `see below <list-table options_>`__
 :Directive Content: A uniform two-level bullet list.
 :Configuration Setting: table_style_

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.