diff options
| author | milde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2022-04-29 16:24:29 +0000 |
|---|---|---|
| committer | milde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2022-04-29 16:24:29 +0000 |
| commit | 41e2b85d6b75b1e52bcfb6fd556a91cdcb51e349 (patch) | |
| tree | d7e2d5619a9c67556bd4d32930aaf8125a323695 /docs | |
| parent | 1fe4aeb87dd71853f5735c9d02d7c6e1312f96a2 (diff) | |
| download | docutils-41e2b85d6b75b1e52bcfb6fd556a91cdcb51e349.tar.gz | |
Minor documentation update
git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9055 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ref/rst/directives.txt | 71 |
1 files changed, 39 insertions, 32 deletions
diff --git a/docs/ref/rst/directives.txt b/docs/ref/rst/directives.txt index 038532829..68805814c 100644 --- a/docs/ref/rst/directives.txt +++ b/docs/ref/rst/directives.txt @@ -166,40 +166,48 @@ value. There are two image directives: "image" and "figure". -It is up to the author to ensure compatibility of the image data format -with the output format or user agent (LaTeX__ engine, `HTML browser`__, -ODT, ...). The following, non exhaustive table provides an overview +.. attention:: + + It is up to the author to ensure compatibility of the image data format + with the output format or user agent (LaTeX engine, `HTML browser`__). + The following, non exhaustive table provides an overview: + + =========== ====== ====== ===== ===== ===== ===== ===== ===== ===== ===== + .. vector image raster image moving image [#]_ + ----------- ------------- ----------------------------- ----------------- + .. SVG PDF PNG JPG GIF APNG AVIF WebM MP4 OGG + =========== ====== ====== ===== ===== ===== ===== ===== ===== ===== ===== + HTML4_ ✓ [#]_ ✓ ✓ ✓ (✓) (✓) + + HTML5_ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ + + LaTeX_ [#]_ ✓ ✓ ✓ + + ODT_ ✓ ✓ ✓ ✓ ✓ + =========== ====== ====== ===== ===== ===== ===== ===== ===== ===== ===== + + .. [#] The `html5 writer`_ uses the ``<video>`` tag if the image URI + ends with an extension matching one of the listed video formats + (since Docutils 0.17). + + .. [#] The html4 writer uses an ``<object>`` tag for SVG images + for better compatibility with older browsers. + + .. [#] When compiling with ``pdflatex``, ``xelatex``, or ``lualatex``. + The original ``latex`` engine supports only the EPS image format. + Some build systems, e.g. rubber_ support additional formats + via on-the-fly image conversion. -========== ====== ====== ===== ===== ===== ===== ===== ===== ===== ===== -.. vector image raster image moving image [#]_ ----------- ------------- ----------------------------- ----------------- -.. SVG PDF PNG JPG GIF APNG AVIF WebM MP4 OGG -========== ====== ====== ===== ===== ===== ===== ===== ===== ===== ===== -HTML4 ✓ [#]_ ✓ ✓ ✓ (✓) (✓) - -HTML5 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ - -LaTeX [#]_ ✓ ✓ ✓ - -ODT ✓ ✓ ✓ ✓ ✓ -========== ====== ====== ===== ===== ===== ===== ===== ===== ===== ===== - -.. [#] The html5 writer uses the ``<video>`` tag if the image URI points - to a file with an extension matching one of the listed video formats - (since Docutils 0.17). - -.. [#] The html4 writer uses an ``<object>`` tag for SVG images for better - compatibility with older browsers. - -.. [#] When compiling with ``pdflatex``, ``xelatex``, or ``lualatex``. - The original ``latex`` engine supports only the EPS image format. - Some build systems, e.g. rubber_ support additional formats via - on-the-fly image conversion. - -__ ../../user/latex.html#image-inclusion __ https://developer.mozilla.org/en-US/docs/Web/Media/Formats/Image_types +.. _HTML4: +.. _html4 writer: ../../user/html.html#html4css1 +.. _HTML5: +.. _html5 writer: ../../user/html.html#html5-polyglot +.. _LaTeX: ../../user/latex.html#image-inclusion +.. _ODT: ../../user/odt.html .. _rubber: https://github.com/petrhosek/rubber + Image ===== @@ -826,7 +834,6 @@ Plus the common options class_ and name_. .. _reStructuredText table: restructuredtext.html#tables .. _table_style: ../../user/config.html#table-style -.. _html5 writer: ../../user/html.html#html5-polyglot .. _csv-table: @@ -1549,7 +1556,7 @@ is up to the Writer. A Writer may ignore any raw output not matching its format. For example, the following input would be passed untouched by an HTML -Writer:: +writer:: .. raw:: html |
