summaryrefslogtreecommitdiff
path: root/docs/ref
diff options
context:
space:
mode:
authormilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2009-05-25 14:04:55 +0000
committermilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2009-05-25 14:04:55 +0000
commit0e299c1677e758a97a6a5a01f06b3d4a645bd150 (patch)
tree01e0fc79279597d7c3316fe363184f70edc6e6fc /docs/ref
parentf5d074887c4df21995bfccf2a903aec662ac5f95 (diff)
downloaddocutils-0e299c1677e758a97a6a5a01f06b3d4a645bd150.tar.gz
Fix description of length specifications.
The default unit (added to length without units) depends on the writer. git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk/docutils@5963 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docs/ref')
-rw-r--r--docs/ref/rst/directives.txt38
-rw-r--r--docs/ref/rst/restructuredtext.txt5
2 files changed, 22 insertions, 21 deletions
diff --git a/docs/ref/rst/directives.txt b/docs/ref/rst/directives.txt
index 1484fd815..7f41d1dd2 100644
--- a/docs/ref/rst/directives.txt
+++ b/docs/ref/rst/directives.txt
@@ -183,9 +183,9 @@ Optionally, the image link block may contain a flat field list, the
_`image options`. For example::
.. image:: picture.jpeg
- :height: 100
- :width: 200
- :scale: 50
+ :height: 100px
+ :width: 200 px
+ :scale: 50 %
:alt: alternate text
:align: right
@@ -196,26 +196,23 @@ The following options are recognized:
applications that cannot display images, or spoken by applications
for visually impaired users.
-``height`` : integer
- The desired height of the image in pixels or as `length value`_.
+``height`` : `length`_
+ The desired height of the image.
Used to reserve space or scale the image vertically. When the "scale"
option is also specified, they are combined. For example, a height of
- 200 and a scale of 50 is equivalent to a height of 100 with no scale.
+ 200px and a scale of 50 is equivalent to a height of 100px with no scale.
-``width`` : integer
- The width of the image in pixels or as length_ or `percentage value`_
- (relative to the current line width).
+``width`` : `length`_ or `percentage`_ of the current line width
+ The width of the image.
Used to reserve space or scale the image horizontally. As with "height"
above, when the "scale" option is also specified, they are combined.
- .. _length:
- .. _length value: restructuredtext.html#length-units
- .. _percentage value: restructuredtext.html#percentage-units
+ .. _length: restructuredtext.html#length-units
+ .. _percentage: restructuredtext.html#percentage-units
-``scale`` : integer
- The uniform scaling factor of the image, an integer percentage
- (the "%" symbol is optional). "100" means full-size, and is
- equivalent to omitting a "scale" option.
+``scale`` : integer percentage (the "%" symbol is optional)
+ The uniform scaling factor of the image. The default is "100 %", i.e.
+ no scaling.
If no "height" or "width" options are specified, the `Python Imaging
Library`_ (PIL) may be used to determine them, if it is installed and
@@ -258,7 +255,7 @@ position if this helps the page layout.
::
.. figure:: picture.png
- :scale: 50
+ :scale: 50 %
:alt: map to buried treasure
This is the caption of the figure (a simple paragraph).
@@ -292,10 +289,9 @@ directive (see `image options`_ above). These options (except
In addition, the following options are recognized:
-``figwidth`` : integer or "image"
- The width of the figure in pixels or as or as length_ or `percentage
- value`_ (which is relative to the current line width). Limits the
- horizontal space used by the figure.
+``figwidth`` : "image", length_, or percentage_ of current line width
+ The width of the figure.
+ Limits the horizontal space used by the figure.
A special value of "image" is allowed, in which case the
included image's actual width is used (requires the `Python Imaging
Library`_). If the image file is not found or the required software is
diff --git a/docs/ref/rst/restructuredtext.txt b/docs/ref/rst/restructuredtext.txt
index 57a8c96c2..c594575bb 100644
--- a/docs/ref/rst/restructuredtext.txt
+++ b/docs/ref/rst/restructuredtext.txt
@@ -2900,6 +2900,8 @@ parser:
* pt (points; 1pt=1/72in)
* pc (picas; 1pc=12pt)
+This set corresponds to the `length units in CSS`_.
+
(List and explanations taken from
http://www.htmlhelp.com/reference/css/units.html#length.)
@@ -2909,6 +2911,9 @@ Length values without unit are completed with a writer-dependent
default (e.g. px with `html4css1`, pt with `latex2e`). See the writer
specific documentation in the `user doc`__ for details.
+.. _length units in CSS:
+ http://www.w3.org/TR/CSS2/syndata.html#length-units
+
__ ../../user/
Percentage Units