[Docutils-checkins] SF.net SVN: docutils:[8392] trunk/docutils

[<mi...@us...>]

Revision: 8392
          http://sourceforge.net/p/docutils/code/8392
Author:   milde
Date:     2019-09-17 08:41:21 +0000 (Tue, 17 Sep 2019)
Log Message:
-----------
LaTeX writer: Deprecation warning for ``\docutilsrole``-prefix.

Modified Paths:
--------------
    trunk/docutils/HISTORY.txt
    trunk/docutils/RELEASE-NOTES.txt
    trunk/docutils/docs/user/latex.txt
    trunk/docutils/docutils/writers/latex2e/__init__.py
    trunk/docutils/test/functional/expected/latex_literal_block.tex
    trunk/docutils/test/functional/expected/latex_literal_block_fancyvrb.tex
    trunk/docutils/test/functional/expected/latex_literal_block_listings.tex
    trunk/docutils/test/functional/expected/latex_literal_block_verbatim.tex
    trunk/docutils/test/functional/expected/latex_literal_block_verbatimtab.tex
    trunk/docutils/test/functional/expected/standalone_rst_latex.tex
    trunk/docutils/test/functional/expected/standalone_rst_xetex.tex
    trunk/docutils/test/test_writers/test_latex2e.py

Modified: trunk/docutils/HISTORY.txt
===================================================================
--- trunk/docutils/HISTORY.txt	2019-09-14 12:32:44 UTC (rev 8391)
+++ trunk/docutils/HISTORY.txt	2019-09-17 08:41:21 UTC (rev 8392)
@@ -50,6 +50,7 @@
   - Make "rubric" bold-italic and left aligned.
   - Fix [ 339 ] don't use "alltt" or literal-block-environment
     in admonitions and footnotes.
+  - Deprecation warning for ``\docutilsrole``-prefixed styling commands.
 
 * docutils/writers/odf_odt/__init__.py:
 

Modified: trunk/docutils/RELEASE-NOTES.txt
===================================================================
--- trunk/docutils/RELEASE-NOTES.txt	2019-09-14 12:32:44 UTC (rev 8391)
+++ trunk/docutils/RELEASE-NOTES.txt	2019-09-17 08:41:21 UTC (rev 8392)
@@ -22,12 +22,13 @@
 Future changes
 ==============
 
-* The "latex" writer will handle admonitions like other block-level elements
-  and wrap them in a "DUclass" environment. The current implementation fails
-  with some content, see docs/user/latex.txt and
-  https://sourceforge.net/p/docutils/bugs/339/
+* The "latex" writer will wrap admonitions in a "DUclass" environment.
   If your custom stylesheets modify "\DUadmonition" to style admonitions,
-  you will need to adapt them after upgrading to versions > 0.15.
+  you will need to adapt them after upgrading to versions > 0.16.
+  Styling commands using ``\docutilsrole`` prefix will be ignored
+  in versions > 0.16 (see `Generating LaTeX with Docutils`__).
+  
+  __ docs/user/latex.html#classes
 
 * Remove the `handle_io_errors` option from io.FileInput/Output.
   Used by Sphinx up to version 1.3.1, fixed in 1.3.2 (Nov 29, 2015).
@@ -72,7 +73,13 @@
 
   __ http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#escaping-mechanism
 
+* LaTeX writer:
 
+  - Informal titles of type "rubric" default to bold-italic and left aligned.
+  - Deprecate ``\docutilsrole`` prefix for styling commands:
+    use ``\DUrole`` instead.
+
+
 Release 0.15
 ============
 

Modified: trunk/docutils/docs/user/latex.txt
===================================================================
--- trunk/docutils/docs/user/latex.txt	2019-09-14 12:32:44 UTC (rev 8391)
+++ trunk/docutils/docs/user/latex.txt	2019-09-17 08:41:21 UTC (rev 8392)
@@ -468,17 +468,22 @@
    ../ref/rst/directives.html#specific-admonitions
 
 Example 2:
-  Use ``.. note::`` for a margin note::
+  Print admonitions in the margin::
 
+    \newcommand{\DUadmonition}[2][class-arg]{\marginpar{#2}}
+
+  Make sure there is enough space to fit the note.
+  See also the marginnote_ package.
+
+Example 3:
+  Use the ``.. note::`` admonition for a margin note::
+
     \newcommand{\DUadmonitionnote}[1]{\marginpar{#1}}
 
   Make sure there is enough space to fit the note.
-  See also the marginnote_ and pdfcomment_ packages.
 
 .. _marginnote:
    http://mirror.ctan.org/help/Catalogue/entries/marginnote.html
-.. _pdfcomment:
-   http://mirror.ctan.org/help/Catalogue/entries/pdfcomment.html
 
 
 .. _custom role:

Modified: trunk/docutils/docutils/writers/latex2e/__init__.py
===================================================================
--- trunk/docutils/docutils/writers/latex2e/__init__.py	2019-09-14 12:32:44 UTC (rev 8391)
+++ trunk/docutils/docutils/writers/latex2e/__init__.py	2019-09-17 08:41:21 UTC (rev 8392)
@@ -578,6 +578,8 @@
   \else
     % backwards compatibility: try \docutilsrole#1{#2}
     \ifcsname docutilsrole#1\endcsname%
+      \PackageWarningNoLine{docutils}{Command prefix "docutilsrole" is
+         deprecated, \MessageBreak use `\protect\DUrole #1`}
       \csname docutilsrole#1\endcsname{#2}%
     \else%
       #2%

Modified: trunk/docutils/test/functional/expected/latex_literal_block.tex
===================================================================
--- trunk/docutils/test/functional/expected/latex_literal_block.tex	2019-09-14 12:32:44 UTC (rev 8391)
+++ trunk/docutils/test/functional/expected/latex_literal_block.tex	2019-09-17 08:41:21 UTC (rev 8392)
@@ -64,6 +64,8 @@
   \else
     % backwards compatibility: try \docutilsrole#1{#2}
     \ifcsname docutilsrole#1\endcsname%
+      \PackageWarningNoLine{docutils}{Command prefix "docutilsrole" is
+         deprecated, \MessageBreak use `\protect\DUrole #1`}
       \csname docutilsrole#1\endcsname{#2}%
     \else%
       #2%

Modified: trunk/docutils/test/functional/expected/latex_literal_block_fancyvrb.tex
===================================================================
--- trunk/docutils/test/functional/expected/latex_literal_block_fancyvrb.tex	2019-09-14 12:32:44 UTC (rev 8391)
+++ trunk/docutils/test/functional/expected/latex_literal_block_fancyvrb.tex	2019-09-17 08:41:21 UTC (rev 8392)
@@ -64,6 +64,8 @@
   \else
     % backwards compatibility: try \docutilsrole#1{#2}
     \ifcsname docutilsrole#1\endcsname%
+      \PackageWarningNoLine{docutils}{Command prefix "docutilsrole" is
+         deprecated, \MessageBreak use `\protect\DUrole #1`}
       \csname docutilsrole#1\endcsname{#2}%
     \else%
       #2%

Modified: trunk/docutils/test/functional/expected/latex_literal_block_listings.tex
===================================================================
--- trunk/docutils/test/functional/expected/latex_literal_block_listings.tex	2019-09-14 12:32:44 UTC (rev 8391)
+++ trunk/docutils/test/functional/expected/latex_literal_block_listings.tex	2019-09-17 08:41:21 UTC (rev 8392)
@@ -70,6 +70,8 @@
   \else
     % backwards compatibility: try \docutilsrole#1{#2}
     \ifcsname docutilsrole#1\endcsname%
+      \PackageWarningNoLine{docutils}{Command prefix "docutilsrole" is
+         deprecated, \MessageBreak use `\protect\DUrole #1`}
       \csname docutilsrole#1\endcsname{#2}%
     \else%
       #2%

Modified: trunk/docutils/test/functional/expected/latex_literal_block_verbatim.tex
===================================================================
--- trunk/docutils/test/functional/expected/latex_literal_block_verbatim.tex	2019-09-14 12:32:44 UTC (rev 8391)
+++ trunk/docutils/test/functional/expected/latex_literal_block_verbatim.tex	2019-09-17 08:41:21 UTC (rev 8392)
@@ -63,6 +63,8 @@
   \else
     % backwards compatibility: try \docutilsrole#1{#2}
     \ifcsname docutilsrole#1\endcsname%
+      \PackageWarningNoLine{docutils}{Command prefix "docutilsrole" is
+         deprecated, \MessageBreak use `\protect\DUrole #1`}
       \csname docutilsrole#1\endcsname{#2}%
     \else%
       #2%

Modified: trunk/docutils/test/functional/expected/latex_literal_block_verbatimtab.tex
===================================================================
--- trunk/docutils/test/functional/expected/latex_literal_block_verbatimtab.tex	2019-09-14 12:32:44 UTC (rev 8391)
+++ trunk/docutils/test/functional/expected/latex_literal_block_verbatimtab.tex	2019-09-17 08:41:21 UTC (rev 8392)
@@ -64,6 +64,8 @@
   \else
     % backwards compatibility: try \docutilsrole#1{#2}
     \ifcsname docutilsrole#1\endcsname%
+      \PackageWarningNoLine{docutils}{Command prefix "docutilsrole" is
+         deprecated, \MessageBreak use `\protect\DUrole #1`}
       \csname docutilsrole#1\endcsname{#2}%
     \else%
       #2%

Modified: trunk/docutils/test/functional/expected/standalone_rst_latex.tex
===================================================================
--- trunk/docutils/test/functional/expected/standalone_rst_latex.tex	2019-09-14 12:32:44 UTC (rev 8391)
+++ trunk/docutils/test/functional/expected/standalone_rst_latex.tex	2019-09-17 08:41:21 UTC (rev 8392)
@@ -109,6 +109,8 @@
   \else
     % backwards compatibility: try \docutilsrole#1{#2}
     \ifcsname docutilsrole#1\endcsname%
+      \PackageWarningNoLine{docutils}{Command prefix "docutilsrole" is
+         deprecated, \MessageBreak use `\protect\DUrole #1`}
       \csname docutilsrole#1\endcsname{#2}%
     \else%
       #2%

Modified: trunk/docutils/test/functional/expected/standalone_rst_xetex.tex
===================================================================
--- trunk/docutils/test/functional/expected/standalone_rst_xetex.tex	2019-09-14 12:32:44 UTC (rev 8391)
+++ trunk/docutils/test/functional/expected/standalone_rst_xetex.tex	2019-09-17 08:41:21 UTC (rev 8392)
@@ -108,6 +108,8 @@
   \else
     % backwards compatibility: try \docutilsrole#1{#2}
     \ifcsname docutilsrole#1\endcsname%
+      \PackageWarningNoLine{docutils}{Command prefix "docutilsrole" is
+         deprecated, \MessageBreak use `\protect\DUrole #1`}
       \csname docutilsrole#1\endcsname{#2}%
     \else%
       #2%

Modified: trunk/docutils/test/test_writers/test_latex2e.py
===================================================================
--- trunk/docutils/test/test_writers/test_latex2e.py	2019-09-14 12:32:44 UTC (rev 8391)
+++ trunk/docutils/test/test_writers/test_latex2e.py	2019-09-17 08:41:21 UTC (rev 8392)
@@ -84,6 +84,8 @@
   \else
     % backwards compatibility: try \docutilsrole#1{#2}
     \ifcsname docutilsrole#1\endcsname%
+      \PackageWarningNoLine{docutils}{Command prefix "docutilsrole" is
+         deprecated, \MessageBreak use `\protect\DUrole #1`}
       \csname docutilsrole#1\endcsname{#2}%
     \else%
       #2%

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