summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authormilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2022-12-19 20:43:08 +0000
committermilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2022-12-19 20:43:08 +0000
commitbca77964de34f5c1e94bcdec031b5235e6531d78 (patch)
tree23c5fd24f1daedf233b5a2e04b38913f31f0807b /docs
parent90f7e2e8720673f4c0390f51501aaa0fc16fa5af (diff)
downloaddocutils-bca77964de34f5c1e94bcdec031b5235e6531d78.tar.gz
Fix [bugs:#384]: allow omission of citations with "use_bibtex" setting.
If the "use_bibtex" LaTeX writer setting is active (i.e. not empty), citations are added by LaTeX/BibTeX from a database for all citation references in the document. The reference resolver transform now skips `citation_reference` nodes instead of expecting matching `citation` nodes in this case. "use_bibtex" content is now transformed to a list by the `frontend.validate_comma_separated_list()` validator. As BibTeX works only with "LaTeX citations", the "use_latex_citations" setting is set to True whenever "use_bibtex" is not empty. Update documentation. The test function, added in the last commit, now passes. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9312 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docs')
-rw-r--r--docs/user/config.txt16
1 files changed, 10 insertions, 6 deletions
diff --git a/docs/user/config.txt b/docs/user/config.txt
index 2228177f8..f94c4cb5f 100644
--- a/docs/user/config.txt
+++ b/docs/user/config.txt
@@ -100,8 +100,9 @@ recognized:
List values can be comma- or colon-delimited.
-strip_classes_, strip_elements_with_classes_, stylesheet, and
-stylesheet_path use the comma as delimiter,
+strip_classes_, strip_elements_with_classes_, smartquotes_locales_,
+stylesheet, stylesheet_dirs, stylesheet_path, legacy_class_functions_,
+and use_bibtex_ use the comma as delimiter,
whitespace around list values is stripped. ::
strip-classes: ham,eggs,
@@ -1849,13 +1850,16 @@ See also `template [html writers]`_.
Default: writer dependent (see `[latex2e writer]`_, `[xetex writer]`_).
Option: ``--template``.
-
use_bibtex
~~~~~~~~~~
-Specify style and database for the experimental `BibTeX` support, for
-example::
- --use-bibtex=mystyle,mydb1,mydb2
+Provisional, name, values, and behaviour may change in future versions
+or the option may be removed.
+
+A comma-separated list of style and database(s) for the experimental
+`BibTeX` support, for example::
+
+ --use-bibtex=unsrt,mydb1,mydb2
Default: "" (don't use BibTeX). Option ``--use-bibtex``.