← Back to branch summary

~ubuntu-branches/ubuntu/raring/python-docutils/raring-201211091312

« back to all changes in this revision

Viewing changes to docs/user/config.txt

  • Committer: Bazaar Package Importer
  • Author(s): Jakub Wilk
  • Date: 2010-07-24 09:03:32 UTC
  • mfrom: (11.1.1 experimental)
  • Revision ID: james.westby@ubuntu.com-20100724090332-n30aqcft3axs8xd3
* Upload to unstable.
* Replace patch to fix --local option for tools/buildhtml.py
  (17_revert_buildhtml.diff) with the one that was applied upstream
  (buildhtml-local.diff).

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/user/config.txt
4
4
 
5
5
:Author: David Goodger
6
6
:Contact: goodger@python.org
7
 
:Revision: $Revision: 6156 $
8
 
:Date: $Date: 2009-10-08 11:42:38 +0200 (Don, 08 Okt 2009) $
 
7
:Revision: $Revision: 6333 $
 
8
:Date: $Date: 2010-06-01 14:18:37 +0200 (Die, 01 Jun 2010) $
9
9
:Copyright: This document has been placed in the public domain.
10
10
 
11
11
.. sidebar:: Docutils Security for Web Applications
746
746
    __ `embed_stylesheet [html4css1 writer]`_
747
747
    __ `stylesheet_path [latex2e writer]`_
748
748
 
 
749
.. _table_style [html4css1 writer]:
 
750
 
 
751
table_style
 
752
    Added to standard table classes to allow styling with CSS.
 
753
    The default sylesheet defines:
 
754
 
 
755
    borderless
 
756
      no borders around the table.
 
757
 
 
758
    .. TODO: booktabs
 
759
               a line above and below the table and one after the head.
 
760
 
 
761
    Default: "".  Option: ``--table-style``.
 
762
 
749
763
.. _template [html4css1 writer]:
750
764
 
751
765
template
888
902
 
889
903
    Default: off.  Options: ``--use-latex-docinfo, --use-docutils-docinfo``
890
904
 
 
905
_`docutils_footnotes`
 
906
    Use the Docutils-specific macros ``\DUfootnote`` and
 
907
    ``\DUfootnotetext`` for footnotes.
 
908
 
 
909
    Default: on.  Option: ``--docutils-footnotes``.
 
910
 
891
911
_`use_latex_footnotes`
892
 
    Use \DUfootnote and \DUfootnotetext for footnotes instead of the
893
 
    deprecated simulation with figure-floats.
894
 
 
895
 
    *Note* this will change to use the \footnote command and footnote
896
 
    numbering by LaTeX in the future.
897
 
 
898
 
    Default: on.  Options: ``--use-latex-footnotes, --figure-footnotes``.
 
912
    Backwards-compatibility alias for docutils_footnotes_ (deprecated).
 
913
 
 
914
    *Note*: the planned new option _`latex_footnotes` will use the
 
915
    ``\footnote`` command and footnote numbering by LaTeX.
 
916
 
 
917
_`figure_footnotes`
 
918
    Typeset footnote text in a figure float.
 
919
    This may lead to footnotes, citations, and figures being
 
920
    mixed at page foot.
 
921
 
 
922
    *Deprecated:* This setting will be removed in a future Docutils
 
923
    version.
 
924
 
 
925
    Default: off.  Option: ``--figure-footnotes``.
899
926
 
900
927
_`use_latex_citations`
901
928
    Use \cite for citations instead of a simulation with figure-floats.
914
941
    Default: "blue".  Option: ``--hyperlink-color``.
915
942
 
916
943
_`documentclass`
917
 
    Specify latex documentclass, *but* beaware that books have chapters
918
 
    articles not.
 
944
    Specify latex documentclass.
919
945
 
920
946
    Default: "article".  Option: ``--documentclass``.
921
947
 
928
954
_`font_encoding`
929
955
    Specify LaTeX font encoding. Multiple options can be given, separated
930
956
    by commas. Possible values are "", "T1", "OT1", "LGR,T1" or any other
931
 
    combination of options to the `fontenc` package.
 
957
    combination of `LaTeX font encodings`_.
932
958
 
933
959
    Default: "T1".  Option: ``--font-encoding``.
934
960
 
 
961
    .. _LaTeX font encodings:
 
962
       http://mirror.ctan.org/macros/latex/doc/encguide.pdf
935
963
 
936
964
.. _embed_stylesheet [latex2e writer]:
937
965
 
938
966
embed_stylesheet
939
967
    Embed the stylesheet(s) in the header of the output file.  The
940
 
    stylesheets must be accessible during processing. Also defined for
941
 
    the `HTML Writer`__ (with default *on*).
 
968
    stylesheets must be accessible during processing.  Currently, this
 
969
    fails if the file is not available via the given path (i.e. the
 
970
    file is *not* searched in the `TeX input path`_).
 
971
    Also defined for the `HTML Writer`__ (with default *on*).
942
972
 
943
973
    Default: off.  Options: ``--embed-stylesheet, --link-stylesheet``.
944
974
 
956
986
    referenced with ``\usepackage`` (extension ``.sty`` or no extension) or
957
987
    ``\input`` (any other extension).
958
988
 
 
989
    LaTeX will search the specified files in the `TeX input path`_.
 
990
 
959
991
    Default: no stylesheet ("").  Option: ``--stylesheet``.
960
992
 
961
 
 
962
993
    __ `stylesheet_path [latex2e writer]`_
963
994
    __ `embed_stylesheet [latex2e writer]`_
964
995
    __ `stylesheet [html4css1 writer]`_
 
996
    .. _TeX input path:
 
997
       http://www.tex.ac.uk/cgi-bin/texfaq2html?label=what-TDS
 
998
 
965
999
 
966
1000
.. _stylesheet_path [latex2e writer]:
967
1001
 
982
1016
    __
983
1017
    __ `stylesheet [latex2e writer]`_
984
1018
 
 
1019
 
 
1020
_`latex_preamble`
 
1021
    LaTeX code that will be inserted in the document preamble.
 
1022
    Can be used to load packages with options or (re-) define LaTeX
 
1023
    macros without writing a custom style file (new in Docutils 0.7).
 
1024
 
 
1025
    Default: Load the "PDF standard fonts" (Times, Helvetica,
 
1026
    Courier)::
 
1027
 
 
1028
      \usepackage{mathptmx} % Times
 
1029
      \usepackage[scaled=.90]{helvet}
 
1030
      \usepackage{courier}
 
1031
 
 
1032
    Option: ``--latex-preamble``
 
1033
 
 
1034
 
985
1035
.. _template [latex2e writer]:
986
1036
 
987
1037
template
1026
1076
    Default: disabled (None).  Options: ``--compound-enumerators``,
1027
1077
    ``--no-compound-enumerators``.
1028
1078
 
 
1079
_`literal_block_env`
 
1080
    When possibile\ [#]_, use the specified environment for literal-blocks.
 
1081
 
 
1082
    Default: "" (quoting of whitespace and special chars)
 
1083
    Option: ``--literal-block-env``
 
1084
 
 
1085
   .. [#] A literal-block element, when processed by a Docutils writer might
 
1086
      have it's origin in a markup with "::" syntax or a "..
 
1087
      parsed-literal::" directive.
 
1088
 
 
1089
      A LaTeX verbatim environment is only usable if there is no other
 
1090
      markup contained in the literal-block.
 
1091
 
 
1092
 
1029
1093
_`section_prefix_for_enumerators`
1030
1094
    Enable or disable section ("." subsection ...) prefixes for
1031
1095
    compound enumerators.  This has no effect unless
1049
1113
 
1050
1114
    Default: "-".  Option: ``--section-enumerator-separator``.
1051
1115
 
1052
 
_`table_style`
 
1116
.. _table_style [latex2e writer]:
 
1117
 
 
1118
table_style
1053
1119
    Specify the drawing of separation lines.
 
1120
    Supported values:
1054
1121
 
1055
 
    - "standard" lines around and between cells.
1056
 
    - "booktabs" a line above and below the table and one after the
1057
 
      head.
1058
 
    - "nolines".
 
1122
    standard
 
1123
      lines around and between cells.
 
1124
    booktabs
 
1125
      a line above and below the table and one after the head.
 
1126
    borderless
 
1127
      no lines.
1059
1128
 
1060
1129
    Default: "standard".  Option: ``--table-style``.
1061
1130
 
1163
1232
    Default: stdin (None).  No command-line options.
1164
1233
 
1165
1234
 
1166
 
.. _ISO 639: http://www.loc.gov/standards/iso639-2/englangn.html
 
1235
.. _ISO 639: http://www.loc.gov/standards/iso639-2/php/English_list.php
1167
1236
 
1168
1237
.. [#pwd] Path relative to the working directory of the process at
1169
1238
   launch.