diff options
| -rw-r--r-- | docutils/HISTORY.txt | 1 | ||||
| -rw-r--r-- | docutils/RELEASE-NOTES.txt | 4 | ||||
| -rw-r--r-- | docutils/docs/user/config.txt | 26 | ||||
| -rw-r--r-- | docutils/docutils/writers/_html_base.py | 48 | ||||
| -rw-r--r-- | docutils/docutils/writers/html4css1/__init__.py | 9 | ||||
| -rw-r--r-- | docutils/docutils/writers/html5_polyglot/__init__.py | 9 | ||||
| -rw-r--r-- | docutils/test/functional/expected/embed_images_html5.html | 32 | ||||
| -rw-r--r-- | docutils/test/functional/input/embed_images.txt | 25 | ||||
| -rw-r--r-- | docutils/test/functional/tests/embed_images_html5.py | 14 |
9 files changed, 145 insertions, 23 deletions
diff --git a/docutils/HISTORY.txt b/docutils/HISTORY.txt index 31507c122..d20229244 100644 --- a/docutils/HISTORY.txt +++ b/docutils/HISTORY.txt @@ -25,6 +25,7 @@ Changes Since 0.16 - Installing with ``setup.py`` now requires ``setuptools``. Alternatively, install with `pip`_ (or "manually"). - Apply patch for bug #399 Fixes in Korean translation. + - Implement feature request #40 `Option to embed images as data URI`. * docutils/MANIFEST.in diff --git a/docutils/RELEASE-NOTES.txt b/docutils/RELEASE-NOTES.txt index c405c0d9a..4760b2440 100644 --- a/docutils/RELEASE-NOTES.txt +++ b/docutils/RELEASE-NOTES.txt @@ -78,6 +78,8 @@ Release 0.17 * Installing with ``setup.py`` now requires setuptools_. Alternatively, install with pip_. + +* HTML writers: new option to embed images. * HTML5 writer: @@ -101,8 +103,6 @@ Release 0.17 .. _initial_header_level: docs/user/config.html#initial-header-level __ https://stackoverflow.com/questions/39547412/same-font-size-for-h1-and-h2-in-article - - * LaTeX writer: - New configuration setting `legacy_class_functions`_. diff --git a/docutils/docs/user/config.txt b/docutils/docs/user/config.txt index 2ca4c30c1..641fd977a 100644 --- a/docutils/docs/user/config.txt +++ b/docutils/docs/user/config.txt @@ -956,6 +956,21 @@ attributes (values "compact" and "open") in the document. Default: enabled (True). Options: ``--compact-field-lists, --no-compact-field-lists``. +embed_images +~~~~~~~~~~~~ + +Embed images in the output HTML file. If the image can be read from +the local file system and its MIME type can be determined, it is +base64_ encoded and included as a `data URI`_. + +Default: disabled (False). +Options: ``--embed-images``, ``--link-images`` + +New in Docutils 0.17. + +.. _base64: https://en.wikipedia.org/wiki/Base64 +.. _data URI: https://en.wikipedia.org/wiki/Data_URI_scheme + .. _embed_stylesheet [html writers]: @@ -1033,7 +1048,7 @@ the output document. Supported values are (case insensitive): * It is recommended to install__ the MathJax library on the same server as the rest of the deployed site files. - __ http://docs.mathjax.org/en/latest/installation.html + __ https://www.mathjax.org/#installnow Example: Install the library at the top level of the web server’s hierarchy in the directory ``MathJax`` and set:: @@ -1046,13 +1061,14 @@ the output document. Supported values are (case insensitive): Downside: Downloads JavaScript code from a third-party site --- opens the door to cross-site scripting attacs! - Example: MathJax.org recommends ``cdnjs.cloudflare.com``:: + Example: MathJax `getting started`__ documentation uses:: math-output: mathjax - https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js + https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js - See https://cdnjs.com/about and https://www.cloudflare.com/terms/ for - details and terms of use. + See https://www.jsdelivr.com/ for details and terms of use. + + __ https://www.mathjax.org/#gettingstarted * Use a local MathJax installation on the *client* machine, e.g.:: diff --git a/docutils/docutils/writers/_html_base.py b/docutils/docutils/writers/_html_base.py index 4352eb346..c7ff96e81 100644 --- a/docutils/docutils/writers/_html_base.py +++ b/docutils/docutils/writers/_html_base.py @@ -17,9 +17,11 @@ """common definitions for Docutils HTML writers""" -import sys -import os.path +import base64 +import mimetypes +import os, os.path import re +import sys try: # check for the Python Imaging Library import PIL.Image @@ -905,19 +907,10 @@ class HTMLTranslator(nodes.NodeVisitor): self.header.extend(header) del self.body[start:] - # Image types to place in an <object> element - object_image_types = {'.swf': 'application/x-shockwave-flash'} - def visit_image(self, node): atts = {} uri = node['uri'] - ext = os.path.splitext(uri)[1].lower() - if ext in self.object_image_types: - atts['data'] = uri - atts['type'] = self.object_image_types[ext] - else: - atts['src'] = uri - atts['alt'] = node.get('alt', uri) + mimetype = mimetypes.guess_type(uri)[0] # image size if 'width' in node: atts['width'] = node['width'] @@ -966,12 +959,35 @@ class HTMLTranslator(nodes.NodeVisitor): suffix = '' if 'align' in node: atts['class'] = 'align-%s' % node['align'] - if ext in self.object_image_types: + # Embed image file (embedded SVG or data URI): + if self.settings.embed_images or ('embed' in node): + err_msg = '' + if not mimetype: + err_msg = 'unknown MIME type for "%s"' % uri + if not self.settings.file_insertion_enabled: + err_msg = 'file insertion disabled.' + try: + with open(url2pathname(uri), 'rb') as imagefile: + imagedata = imagefile.read() + except IOError as err: + err_msg = str(err) + if not err_msg: + # TODO (test mimetype for SVG and insert directly) + data64 = base64.b64encode(imagedata).decode() + uri = u'data:%s;base64,%s' % (mimetype, data64) + else: + # raise NotImplementedError(os.getcwd() + err_msg) + self.document.reporter.error("Cannot embed image\n "+err_msg) + + if mimetype == 'application/x-shockwave-flash': + atts['type'] = mimetype # do NOT use an empty tag: incorrect rendering in browsers - self.body.append(self.starttag(node, 'object', '', **atts) + - node.get('alt', uri) + '</object>' + suffix) + tag = (self.starttag(node, 'object', '', data=uri, **atts) + + node.get('alt', uri) + '</object>' + suffix) else: - self.body.append(self.emptytag(node, 'img', suffix, **atts)) + atts['alt'] = node.get('alt', node['uri']) + tag = self.emptytag(node, 'img', suffix, src=uri, **atts) + self.body.append(tag) def depart_image(self, node): pass diff --git a/docutils/docutils/writers/html4css1/__init__.py b/docutils/docutils/writers/html4css1/__init__.py index b3af3d996..f5dfd540c 100644 --- a/docutils/docutils/writers/html4css1/__init__.py +++ b/docutils/docutils/writers/html4css1/__init__.py @@ -124,6 +124,15 @@ class Writer(writers._html_base.Writer): ('Disable compact simple field lists.', ['--no-compact-field-lists'], {'dest': 'compact_field_lists', 'action': 'store_false'}), + ('Embed images in the output HTML file, if the image ' + 'files are accessible during processing.', + ['--embed-images'], + {'default': 0, 'action': 'store_true', + 'validator': frontend.validate_boolean}), + ('Link to images in the output HTML file. ' + 'This is the default.', + ['--link-images'], + {'dest': 'embed_images', 'action': 'store_false'}), ('Added to standard table classes. ' 'Defined styles: "borderless". Default: ""', ['--table-style'], diff --git a/docutils/docutils/writers/html5_polyglot/__init__.py b/docutils/docutils/writers/html5_polyglot/__init__.py index e98dba121..311623df0 100644 --- a/docutils/docutils/writers/html5_polyglot/__init__.py +++ b/docutils/docutils/writers/html5_polyglot/__init__.py @@ -114,6 +114,15 @@ class Writer(writers._html_base.Writer): ('Disable compact simple field lists.', ['--no-compact-field-lists'], {'dest': 'compact_field_lists', 'action': 'store_false'}), + ('Embed images in the output HTML file, if the image ' + 'files are accessible during processing.', + ['--embed-images'], + {'default': 0, 'action': 'store_true', + 'validator': frontend.validate_boolean}), + ('Link to images in the output HTML file. ' + 'This is the default.', + ['--link-images'], + {'dest': 'embed_images', 'action': 'store_false'}), ('Added to standard table classes. ' 'Defined styles: borderless, booktabs, ' 'align-left, align-center, align-right, colwidths-auto. ' diff --git a/docutils/test/functional/expected/embed_images_html5.html b/docutils/test/functional/expected/embed_images_html5.html new file mode 100644 index 000000000..a8bcef150 --- /dev/null +++ b/docutils/test/functional/expected/embed_images_html5.html @@ -0,0 +1,32 @@ +<!DOCTYPE html> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> +<meta charset="utf-8"/> +<meta name="generator" content="Docutils 0.17b.dev: http://docutils.sourceforge.net/" /> +<title>Embedded Images</title> +<link rel="stylesheet" href="../../../docutils/writers/html5_polyglot/minimal.css" type="text/css" /> +<link rel="stylesheet" href="../../../docutils/writers/html5_polyglot/plain.css" type="text/css" /> +</head> +<body> +<main id="embedded-images"> +<h1 class="title">Embedded Images</h1> + +<p>The “embed” flag tells Docutils that it should +try to embed the image in the output document.</p> +<p>If the image can be read from the local file system, it is <a class="reference external" href="https://en.wikipedia.org/wiki/Base64">base64</a> +encoded and included as a <a class="reference external" href="https://en.wikipedia.org/wiki/Data_URI_scheme">data URI</a>. +In future, SVG images may be directly inserted into HTML5.</p> +<blockquote> +<figure class="align-center"> +<img alt="biohazard" src="data:image/svg+xml;base64,<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Created with Inkscape (http://www.inkscape.org/) -->

<svg
   xmlns:dc="http://purl.org/dc/elements/1.1/"
   xmlns:cc="http://creativecommons.org/ns#"
   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
   xmlns:svg="http://www.w3.org/2000/svg"
   xmlns="http://www.w3.org/2000/svg"
   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
   sodipodi:docname="biohazard.svg"
   inkscape:version="0.47 r22583"
   sodipodi:version="0.32"
   id="svg24159"
   height="48"
   width="48"
   version="1.0">
  <title
     id="title2837">Biohazard</title>
  <metadata
     id="metadata7">
    <rdf:RDF>
      <cc:Work
         rdf:about="">
        <dc:format>image/svg+xml</dc:format>
        <dc:type
           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
        <dc:title>Biohazard</dc:title>
        <cc:license
           rdf:resource="http://creativecommons.org/licenses/publicdomain/" />
        <dc:description>Standalone biohazard symbol, with no border, background or descriptive text.</dc:description>
        <dc:creator>
          <cc:Agent>
            <dc:title>Silsor</dc:title>
          </cc:Agent>
        </dc:creator>
        <dc:identifier></dc:identifier>
        <dc:source></dc:source>
        <dc:relation>http://de.wikipedia.org/wiki/Datei:Biohazard_symbol.svg</dc:relation>
        <dc:publisher>
          <cc:Agent>
            <dc:title>Wikipedia</dc:title>
          </cc:Agent>
        </dc:publisher>
        <dc:contributor>
          <cc:Agent>
            <dc:title>Bastique, Andux, MarianSigler, GM</dc:title>
          </cc:Agent>
        </dc:contributor>
      </cc:Work>
      <cc:License
         rdf:about="http://creativecommons.org/licenses/publicdomain/">
        <cc:permits
           rdf:resource="http://creativecommons.org/ns#Reproduction" />
        <cc:permits
           rdf:resource="http://creativecommons.org/ns#Distribution" />
        <cc:permits
           rdf:resource="http://creativecommons.org/ns#DerivativeWorks" />
      </cc:License>
    </rdf:RDF>
  </metadata>
  <defs
     id="defs5">
    <inkscape:perspective
       sodipodi:type="inkscape:persp3d"
       inkscape:vp_x="0 : 178.13126 : 1"
       inkscape:vp_y="0 : 1000 : 0"
       inkscape:vp_z="376.4375 : 178.13126 : 1"
       inkscape:persp3d-origin="188.21875 : 118.75417 : 1"
       id="perspective2835" />
  </defs>
  <sodipodi:namedview
     inkscape:current-layer="svg24159"
     inkscape:window-y="33"
     inkscape:window-x="0"
     inkscape:cy="22.455418"
     inkscape:cx="22.152639"
     inkscape:zoom="8.9316693"
     inkscape:window-height="771"
     inkscape:window-width="993"
     inkscape:pageshadow="2"
     inkscape:pageopacity="0.0"
     borderopacity="1.0"
     bordercolor="#666666"
     pagecolor="#ffffff"
     id="base"
     showgrid="false"
     inkscape:window-maximized="0" />
  <path
     id="path7214"
     style="fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none;display:inline"
     d="m 23.585163,1.377771 c -7.3e-5,1.1e-4 6.2e-5,0.0039 0,0.0039 0.0013,-3.54e-4 0.0026,-0.0032 0.0039,-0.0039 -4.78e-4,0 -0.0034,-2.3e-5 -0.0039,0 z m -0.293287,0.01173 c -0.0027,3.39e-4 -0.0051,0.0032 -0.0078,0.0039 0.01047,-6.47e-4 0.0208,-0.0032 0.0313,-0.0039 -0.0026,3.1e-5 -0.0053,-1.18e-4 -0.0078,0 -0.0057,2.6e-4 -0.01016,-6.94e-4 -0.01564,0 z m 1.4234,0.0078 c 0.02085,0.0016 0.04176,0.0023 0.06257,0.0039 -0.02047,-0.0016 -0.04204,-0.0032 -0.06257,-0.0039 z m 0.06257,0.0039 c 5.265987,0.418547 9.412454,4.8332343 9.412454,10.206258 0,5.470767 -4.303553,9.932781 -9.705743,10.210182 l 0,2.096004 c 1.474852,0.23317 2.604371,1.513993 2.604371,3.054059 0,0.376932 -0.06786,0.737393 -0.191614,1.071465 l 1.916125,1.106653 c 2.96118,-4.473042 8.935485,-5.932586 13.643543,-3.214395 4.696858,2.711739 6.431117,8.594706 4.062951,13.389373 3.25012,-6.325927 0.990037,-14.166586 -5.236079,-17.761246 -1.557783,-0.899383 -3.21756,-1.447302 -4.895883,-1.673666 0.642426,-1.566299 0.997159,-3.281384 0.997159,-5.079678 0,-7.1369497 -5.576639,-12.979536 -12.607284,-13.405009 z m -1.716682,0.0078 c -6.995507,0.462047 -12.536897,6.2854693 -12.536897,13.397187 0,1.7471 0.33392,3.416827 0.942418,4.946709 C 9.8382992,19.991498 8.2240722,20.533989 6.7115792,21.40722 0.52714555,24.977806 -1.7383295,32.735989 1.4168439,39.039434 -0.86121285,34.26773 0.88578585,28.463663 5.5423552,25.775186 10.280179,23.039814 16.295416,24.535893 19.236731,29.07561 l 1.849653,-1.06755 c -0.116245,-0.324958 -0.175968,-0.675422 -0.175968,-1.040177 0,-1.474684 1.033904,-2.7081 2.416653,-3.014963 l 0,-2.138998 c -5.354361,-0.327959 -9.604053,-4.769878 -9.604053,-10.206284 0,-5.3484377 4.106511,-9.745581 9.338141,-10.198436 z m 0.5983,12.857539 c -2.702513,0.06215 -5.1939,0.982199 -7.238239,2.479239 0.163319,0.241678 0.3388,0.475581 0.523995,0.699968 0.185211,0.224379 0.381018,0.43966 0.586572,0.64522 0.205552,0.205552 0.420838,0.401368 0.645233,0.586565 0.164974,0.136169 0.34173,0.258763 0.516174,0.383226 1.509041,-0.990801 3.316157,-1.571993 5.263466,-1.571993 1.947286,-8e-6 3.750506,0.581192 5.259545,1.571993 0.174446,-0.124463 0.351193,-0.247057 0.516176,-0.383226 0.22439,-0.185197 0.439673,-0.381013 0.645219,-0.586565 0.205567,-0.20556 0.401375,-0.420841 0.586578,-0.64522 0.185195,-0.224387 0.360669,-0.45829 0.523998,-0.699968 -2.118228,-1.551143 -4.716051,-2.479239 -7.531516,-2.479239 -0.06599,0 -0.133689,-7.88e-4 -0.199445,0 -0.0321,5.04e-4 -0.06572,-7.33e-4 -0.09775,0 z m -12.31791,11.277867 c -0.284223,2.610003 0.211199,5.323971 1.618924,7.76224 1.407734,2.438252 3.510158,4.228056 5.912592,5.286916 0.127648,-0.262284 0.242394,-0.532967 0.344121,-0.805556 0.101731,-0.272573 0.190676,-0.548209 0.265902,-0.828999 0.07525,-0.280797 0.139504,-0.565564 0.187704,-0.852481 0.03545,-0.210964 0.05374,-0.42411 0.07431,-0.637415 -1.612588,-0.811463 -3.018925,-2.087157 -3.992574,-3.773578 -0.973652,-1.686412 -1.374436,-3.539399 -1.270899,-5.341664 -0.194995,-0.08884 -0.390062,-0.179391 -0.590482,-0.254187 -0.272577,-0.10171 -0.548216,-0.190664 -0.829012,-0.265909 -0.280794,-0.07523 -0.565552,-0.135585 -0.852473,-0.183786 -0.286919,-0.04821 -0.577155,-0.08499 -0.868119,-0.105582 z m 25.316234,0.152498 c -0.290976,0.02064 -0.581196,0.05743 -0.868118,0.105592 -0.286924,0.04821 -0.571694,0.108551 -0.852489,0.183796 -0.28078,0.07523 -0.560331,0.164188 -0.832917,0.265916 -0.200416,0.07475 -0.391568,0.169238 -0.586562,0.258079 0.103529,1.802257 -0.297254,3.655268 -1.270904,5.341672 -0.973644,1.686405 -2.379987,2.958198 -3.992556,3.769663 0.02056,0.213296 0.03885,0.42645 0.07429,0.637406 0.0482,0.286925 0.108544,0.571684 0.183787,0.85249 0.07524,0.280789 0.164195,0.560349 0.265917,0.832913 0.10171,0.272598 0.21648,0.539357 0.344115,0.80165 2.402441,-1.05887 4.504863,-2.844756 5.91259,-5.283018 1.407749,-2.438268 1.907058,-5.156151 1.622843,-7.766155 z m -14.984836,3.300424 -1.861376,1.079286 c 2.393175,4.80097 0.67248,10.702448 -4.035564,13.420654 -4.684876,2.704807 -10.6285418,1.281437 -13.6044538,-3.140087 3.861645,5.950286 11.7584698,7.900842 17.9724108,4.31321 1.505271,-0.869071 2.775062,-1.989431 3.793133,-3.273026 1.038062,1.349323 2.351864,2.521178 3.918266,3.425539 6.220932,3.591652 14.127263,1.63317 17.98415,-4.332768 -2.970401,4.440658 -8.922715,5.877231 -13.616174,3.167461 -4.737818,-2.735388 -6.449511,-8.693465 -3.988659,-13.51059 L 26.29902,29.028617 c -0.565692,0.629844 -1.386768,1.028448 -2.299348,1.028448 -0.927577,0 -1.760299,-0.411791 -2.32672,-1.059736 z" />
</svg>
" /> +<figcaption> +<p>SVG image embedded in a figure.</p> +</figcaption> +</figure> +</blockquote> +<p>Embedded inline image <img alt="inline-embedded" src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQAQMAAAAlPW0iAAAABGdBTUEAANkE3LLaAgAAAAlwSFlzAAAOxAAADsQBlSsOGwAAAAZQTFRF////AAAAVcLTfgAAAAF0Uk5TAEDm2GYAAAA2SURBVHicYmBRYOAQYJCQYJC+wSBjAUL2fxjq6hgueTNM7AQh3g0MzAdAiP0BUBYAAAD//wMA4pkLDrFBDzUAAAAASUVORK5CYII=" style="height: 0.8em;" /> scaled to a height of 0.8 em.</p> +<blockquote> +</blockquote> +</main> +</body> +</html> diff --git a/docutils/test/functional/input/embed_images.txt b/docutils/test/functional/input/embed_images.txt new file mode 100644 index 000000000..bd42e35aa --- /dev/null +++ b/docutils/test/functional/input/embed_images.txt @@ -0,0 +1,25 @@ +Embedded Images +--------------- + +The "embed" flag tells Docutils that it should +try to embed the image in the output document. + +If the image can be read from the local file system, it is base64_ +encoded and included as a `data URI`_. +In future, SVG images may be directly inserted into HTML5. + + .. figure:: ../docs/user/rst/images/biohazard.svg + :alt: biohazard + :align: center + + SVG image embedded in a figure. + + +Embedded inline image |inline-embedded| scaled to a height of 0.8 em. + + .. |inline-embedded| image:: ../docs/user/rst/images/biohazard.png + :height: 0.8 em + +.. _base64: https://en.wikipedia.org/wiki/Base64 +.. _data URI: https://en.wikipedia.org/wiki/Data_URI_scheme + diff --git a/docutils/test/functional/tests/embed_images_html5.py b/docutils/test/functional/tests/embed_images_html5.py new file mode 100644 index 000000000..3adac07a7 --- /dev/null +++ b/docutils/test/functional/tests/embed_images_html5.py @@ -0,0 +1,14 @@ +with open('functional/tests/_standalone_rst_defaults.py') as _f: + exec(_f.read()) + +# Source and destination file names. +test_source = "embed_images.txt" +test_destination = "embed_images_html5.html" + +# Keyword parameters passed to publish_file. +writer_name = "html5" + +# Settings: +settings_overrides['smart_quotes'] = 'yes' +settings_overrides['embed_images'] = 'yes' + |