Vector figures are nicely supported. You should have a PDF file and an SVG file. The PDF will be used for the latex output and the SVG for the HTML output. The HTML output has a nice zoom feature using Colorbox.
The Sirikata metaverse platform architecture.
See an example in Figure |nbsp| :num:`fig-sirikata-overview`. I suggest making
figures in something like Inkscape. If you have only a vector PDF, you can use
pdf2svg to convert (brew install pdf2svg or apt-get install pdf2svg).
Regular rasterized images work fine too.
The Open3DHub website allows browsing of 3D meshes.
A PNG example is shown in Figure |nbsp| :num:`fig-open3dhub-icons`.
The subfigure directives allow you to place multiple figures side-by-side in the document. Here's an example:
.. subfigstart::
Base Mesh + 128x128 Texture (334 KB)
Base Mesh + 25% Stream + 256x256 Texture (568 KB)
Base Mesh + 50% Stream + 512x512 Texture (923 KB)
Base Mesh + 75% Stream + 1024x1024 Texture (1755 KB)
Base Mesh + 100% Stream + 2048x2048 Texture (4385 KB)
Original Mesh (913 KB)
.. subfigend::
:width: 0.30
:alt: Example Model Resolutions
:label: fig-cc-teddy
Example of a teddy bear model at different resolutions of the
progressive format (1 draw call) and its original format (16 draw
calls). The size in KB assumes downloading progressively, |eg|
:num:`fig-cc-teddy-100`'s size includes lower-resolution textures.
You can reference the entire Figure |nbsp| :num:`fig-cc-teddy` or one of its subfigures, |eg| Figure |nbsp| :num:`fig-cc-teddy-original`.
Tables can be put inside the figtable directive which automatically numbers them, adds a caption, and adds a label.
.. figtable::
:label: table-cc-file-size
:caption: Mean size of progressive format as a fraction of the
original across all test models, shown as a function of the
progressive stream downloaded and texture resolution.
:alt: Mean Size of Progressive Format
:spec: r r r r r r r
=========== ==== ==== ==== ==== ====
Progressive 128 256 512 1024 2048
=========== ==== ==== ==== ==== ====
0% 0.53 0.63 0.81 1.03 1.35
25% 0.65 0.75 0.97 1.16 1.45
50% 0.74 0.85 1.02 1.26 1.58
75% 0.79 0.95 1.11 1.34 1.70
100% 0.88 0.99 1.20 1.44 1.82
=========== ==== ==== ==== ==== ====
Table |nbsp| :num:`table-cc-file-size` has all right-aligned columns.
.. figtable::
:label: table-mixed-align
:caption: This table has mixed alignment
:alt: Mixed Alignment Table
:spec: l r
======================= =========================
Left Align Right Align
======================= =========================
Some text is left align Followed by right-aligned
Some more text here And more text here
And even more text Also even more text here
======================= =========================
Table |nbsp| :num:`table-mixed-align` has one column left-aligned and one column right-aligned.
.. figtable::
:label: table-no-fig
:caption: A table not inside a figure
:alt: Plain Table
:spec: r r r r r r r
:nofig:
=========== ==== ==== ==== ==== ====
Progressive 128 256 512 1024 2048
=========== ==== ==== ==== ==== ====
0% 0.53 0.63 0.81 1.03 1.35
25% 0.65 0.75 0.97 1.16 1.45
50% 0.74 0.85 1.02 1.26 1.58
75% 0.79 0.95 1.11 1.34 1.70
100% 0.88 0.99 1.20 1.44 1.82
=========== ==== ==== ==== ==== ====
Some people don't like tables inside figures, so you can disable it with an argument to the figtable directive. A table not inside a figure is shown in :num:`table-no-fig`. Note this only effects the latex output.
Text wrapping in tables work if you specify the width and either raggedleft or raggedright.
.. figtable::
:label: fig-open3dhub-cfs
:caption: A list of Open3DHub's Cassandra column families and their descriptions
:alt: Open3DHub Cassandra Column Families
:spec: >{\raggedleft\arraybackslash}p{0.25\linewidth} p{0.65\linewidth}
============================== ==============================================================================================================================
Column Family Description
============================== ==============================================================================================================================
**Users** Stores a list of users who have authenticated with OpenID.
**Names** Stores a list of the 3D models in the database with their associated metadata.
**TempFiles** Temporarily stores the binary file data of uploaded files until they have been processed.
**Files** Stores the binary file data for uploaded and verified files.
**Sessions** Stores HTTP session information used by the Django framework to look up session state associated with a user's browser cookie.
**OpenIdAssocs, OpenIdNonces** Stores OpenID authentication information for users.
**CeleryResults** Stores the result of application processing tasks (see Section something).
**APIConsumers** Stores a list of consumers of the API for use with the OAuth protocol.
============================== ==============================================================================================================================
A text wrapping table example is shown in Figure |nbsp| :num:`fig-open3dhub-cfs`.
You can use CSV Table and List table from docutils directives.
.. figtable::
:label: table-csv
:caption: CSV table
:alt: CSV table
:spec: >{\raggedright\arraybackslash}p{0.15\linewidth} p{0.20\linewidth} p{0.30\linewidth}
.. csv-table::
:header: "Treat", "Quantity", "Description"
:widths: 15, 10, 30
"Albatross", 2.99, "On a stick!"
"Crunchy Frog", 1.49, "If we took the bones out, it wouldn't be
crunchy, now would it?"
"Gannet Ripple", 1.99, "On a stick!"
.. figtable::
:label: table-list
:caption: List table
:alt: List table
:spec: >{\raggedright\arraybackslash}p{0.15\linewidth} p{0.20\linewidth} p{0.30\linewidth}
.. list-table::
:widths: 15 10 30
:header-rows: 1
* - Treat
- Quantity
- Description
* - Albatross
- 2.99
- On a stick!
* - Crunchy Frog
- 1.49
- If we took the bones out, it wouldn't be
crunchy, now would it?
* - Gannet Ripple
- 1.99
- On a stick!vvv
A CSV table example is shown in Figure |nbsp| :num:`table-csv` and List table in Figure |nbsp| :num:`table-list`.
We might have a big table (Table |nbsp| :num:`fig-big-table`) which is perfectly fine in the world of HTML how can we deal within it in the world of latex/PDF? Can we rotate the table for PDF only?
One way could perhaps be to let the table to span vertically over multiple pages as done in Table |nbsp| :num:`fig-big-table-vertical`?
.. figtable::
:label: fig-big-table
:caption: A big table
:alt: A big table
:spec: >{\raggedright\arraybackslash}p{0.12\linewidth} p{0.08\linewidth} p{0.08\linewidth} p{0.08\linewidth} p{0.08\linewidth} p{0.08\linewidth} p{0.08\linewidth} p{0.08\linewidth} p{0.08\linewidth} p{0.08\linewidth} p{0.08\linewidth} p{0.08\linewidth}
:nofig:
+----------+------------------+-----------+----------+----------+----------+----------+----------+-----------+----------+----------+-----------+
|Cell 1 |Cell 2 |Cell long |Cell 4 |Cell 5 |Cell 6 |Cell 7 |Cell 8 |Cell long |Cell 10 |Cell 11 |Cell 12 |
| | |header | | | | | |text 9 | | | |
| | |test 3 | | | | | | | | | |
+==========+==================+===========+==========+==========+==========+==========+==========+===========+==========+==========+===========+
|Name 1 |Lorem ipsum dolor |Lorem ipsum|Short |Short |Short |Short |Short |Lorem ipsum|Short |Short |Lorem ipsum|
| |sit amet, |dolor sit | | | | | |dolor sit |short |short |dolor sit |
| |consectetur |amet, | | | | | |amet, | |short |amet. |
| |adipiscing |consectetur| | | | | |consectetur| | | |
| |elit. Pellentesque|adipiscing | | | | | |adipiscing | | | |
| |vitae nisl |elit. | | | | | |elit. | | | |
| |imperdiet. | | | | | | | | | | |
| | | | | | | | | | | | |
+----------+------------------+-----------+----------+----------+----------+----------+----------+-----------+----------+----------+-----------+
|Name 2 |Lorem ipsum dolor |Lorem ipsum|Short |Short |Short |Short |Short |Lorem ipsum|Short |Short |Lorem ipsum|
| |sit amet, |dolor sit | | | | | |dolor sit |short |short |dolor sit |
| |consectetur |amet, | | | | | |amet, | |short |amet. |
| |adipiscing |consectetur| | | | | |consectetur| | | |
| |elit. Pellentesque|adipiscing | | | | | |adipiscing | | | |
| |vitae nisl |elit. | | | | | |elit. | | | |
| |imperdiet. | | | | | | | | | | |
| | | | | | | | | | | | |
+----------+------------------+-----------+----------+----------+----------+----------+----------+-----------+----------+----------+-----------+
|Name 3 |Lorem ipsum dolor |Lorem ipsum|Short |Short |Short |Short |Short |Lorem ipsum|Short |Short |Lorem ipsum|
| |sit amet, |dolor sit | | | | | |dolor sit |short |short |dolor sit |
| |consectetur |amet, | | | | | |amet, | |short |amet. |
| |adipiscing |consectetur| | | | | |consectetur| | | |
| |elit. Pellentesque|adipiscing | | | | | |adipiscing | | | |
| |vitae nisl |elit. | | | | | |elit. | | | |
| |imperdiet. | | | | | | | | | | |
| | | | | | | | | | | | |
+----------+------------------+-----------+----------+----------+----------+----------+----------+-----------+----------+----------+-----------+
|Name 3 |Lorem ipsum dolor |Lorem ipsum|Short |Short |Short |Short |Short |Lorem ipsum|Short |Short |Lorem ipsum|
| |sit amet, |dolor sit | | | | | |dolor sit |short |short |dolor sit |
| |consectetur |amet, | | | | | |amet, | |short |amet. |
| |adipiscing |consectetur| | | | | |consectetur| | | |
| |elit. Pellentesque|adipiscing | | | | | |adipiscing | | | |
| |vitae nisl |elit. | | | | | |elit. | | | |
| |imperdiet. | | | | | | | | | | |
| | | | | | | | | | | | |
+----------+------------------+-----------+----------+----------+----------+----------+----------+-----------+----------+----------+-----------+
.. figtable::
:label: fig-big-table-vertical
:caption: A big table vertical
:alt: A big table vertical
:spec: >{\raggedright\arraybackslash}p{0.15\linewidth} p{0.17\linewidth} p{0.17\linewidth} p{0.17\linewidth} p{0.17\linewidth} p{0.17\linewidth}
:longtable:
+------------------+------------------+----------+----------+------------------+------------------+
|Cell 1 |Cell 2 |Cell 3 |Cell 4 |Cell 5 |Cell 6 |
+==================+==================+==========+==========+==================+==================+
|Lorem ipsum dolor |Lorem ipsum dolor |Short |Short |Lorem ipsum dolor |Lorem ipsum dolor |
|sit amet, |sit amet, | | |sit amet, |sit amet, |
|consectetur |consectetur | | |consectetur |consectetur |
|adipiscing |adipiscing elit. | | |adipiscing elit. |adipiscing |
|elit. Pellentesque| | | | |elit. Pellentesque|
|vitae nisl | | | | |vitae nisl |
|imperdiet. | | | | |imperdiet. |
+------------------+------------------+----------+----------+------------------+------------------+
|Lorem ipsum dolor |Lorem ipsum dolor |Short |Short |Lorem ipsum dolor |Lorem ipsum dolor |
|sit amet, |sit amet, | | |sit amet, |sit amet, |
|consectetur |consectetur | | |consectetur |consectetur |
|adipiscing |adipiscing elit. | | |adipiscing elit. |adipiscing |
|elit. Pellentesque| | | | |elit. Pellentesque|
|vitae nisl | | | | |vitae nisl |
|imperdiet. | | | | |imperdiet. |
+------------------+------------------+----------+----------+------------------+------------------+
|Lorem ipsum dolor |Lorem ipsum dolor |Short |Short |Lorem ipsum dolor |Lorem ipsum dolor |
|sit amet, |sit amet, | | |sit amet, |sit amet, |
|consectetur |consectetur | | |consectetur |consectetur |
|adipiscing |adipiscing elit. | | |adipiscing elit. |adipiscing |
|elit. Pellentesque| | | | |elit. Pellentesque|
|vitae nisl | | | | |vitae nisl |
|imperdiet. | | | | |imperdiet. |
+------------------+------------------+----------+----------+------------------+------------------+
|Lorem ipsum dolor |Lorem ipsum dolor |Short |Short |Lorem ipsum dolor |Lorem ipsum dolor |
|sit amet, |sit amet, | | |sit amet, |sit amet, |
|consectetur |consectetur | | |consectetur |consectetur |
|adipiscing |adipiscing elit. | | |adipiscing elit. |adipiscing |
|elit. Pellentesque| | | | |elit. Pellentesque|
|vitae nisl | | | | |vitae nisl |
|imperdiet. | | | | |imperdiet. |
+------------------+------------------+----------+----------+------------------+------------------+
|Lorem ipsum dolor |Lorem ipsum dolor |Short |Short |Lorem ipsum dolor |Lorem ipsum dolor |
|sit amet, |sit amet, | | |sit amet, |sit amet, |
|consectetur |consectetur | | |consectetur |consectetur |
|adipiscing |adipiscing elit. | | |adipiscing elit. |adipiscing |
|elit. Pellentesque| | | | |elit. Pellentesque|
|vitae nisl | | | | |vitae nisl |
|imperdiet. | | | | |imperdiet. |
+------------------+------------------+----------+----------+------------------+------------------+
|Lorem ipsum dolor |Lorem ipsum dolor |Short |Short |Lorem ipsum dolor |Lorem ipsum dolor |
|sit amet, |sit amet, | | |sit amet, |sit amet, |
|consectetur |consectetur | | |consectetur |consectetur |
|adipiscing |adipiscing elit. | | |adipiscing elit. |adipiscing |
|elit. Pellentesque| | | | |elit. Pellentesque|
|vitae nisl | | | | |vitae nisl |
|imperdiet. | | | | |imperdiet. |
+------------------+------------------+----------+----------+------------------+------------------+
|Lorem ipsum dolor |Lorem ipsum dolor |Short |Short |Lorem ipsum dolor |Lorem ipsum dolor |
|sit amet, |sit amet, | | |sit amet, |sit amet, |
|consectetur |consectetur | | |consectetur |consectetur |
|adipiscing |adipiscing elit. | | |adipiscing elit. |adipiscing |
|elit. Pellentesque| | | | |elit. Pellentesque|
|vitae nisl | | | | |vitae nisl |
|imperdiet. | | | | |imperdiet. |
+------------------+------------------+----------+----------+------------------+------------------+
|Lorem ipsum dolor |Lorem ipsum dolor |Short |Short |Lorem ipsum dolor |Lorem ipsum dolor |
|sit amet, |sit amet, | | |sit amet, |sit amet, |
|consectetur |consectetur | | |consectetur |consectetur |
|adipiscing |adipiscing elit. | | |adipiscing elit. |adipiscing |
|elit. Pellentesque| | | | |elit. Pellentesque|
|vitae nisl | | | | |vitae nisl |
|imperdiet. | | | | |imperdiet. |
+------------------+------------------+----------+----------+------------------+------------------+
|Lorem ipsum dolor |Lorem ipsum dolor |Short |Short |Lorem ipsum dolor |Lorem ipsum dolor |
|sit amet, |sit amet, | | |sit amet, |sit amet, |
|consectetur |consectetur | | |consectetur |consectetur |
|adipiscing |adipiscing elit. | | |adipiscing elit. |adipiscing |
|elit. Pellentesque| | | | |elit. Pellentesque|
|vitae nisl | | | | |vitae nisl |
|imperdiet. | | | | |imperdiet. |
+------------------+------------------+----------+----------+------------------+------------------+
|Lorem ipsum dolor |Lorem ipsum dolor |Short |Short |Lorem ipsum dolor |Lorem ipsum dolor |
|sit amet, |sit amet, | | |sit amet, |sit amet, |
|consectetur |consectetur | | |consectetur |consectetur |
|adipiscing |adipiscing elit. | | |adipiscing elit. |adipiscing |
|elit. Pellentesque| | | | |elit. Pellentesque|
|vitae nisl | | | | |vitae nisl |
|imperdiet. | | | | |imperdiet. |
+------------------+------------------+----------+----------+------------------+------------------+
|Lorem ipsum dolor |Lorem ipsum dolor |Short |Short |Lorem ipsum dolor |Lorem ipsum dolor |
|sit amet, |sit amet, | | |sit amet, |sit amet, |
|consectetur |consectetur | | |consectetur |consectetur |
|adipiscing |adipiscing elit. | | |adipiscing elit. |adipiscing |
|elit. Pellentesque| | | | |elit. Pellentesque|
|vitae nisl | | | | |vitae nisl |
|imperdiet. | | | | |imperdiet. |
+------------------+------------------+----------+----------+------------------+------------------+
|Lorem ipsum dolor |Lorem ipsum dolor |Short |Short |Lorem ipsum dolor |Lorem ipsum dolor |
|sit amet, |sit amet, | | |sit amet, |sit amet, |
|consectetur |consectetur | | |consectetur |consectetur |
|adipiscing |adipiscing elit. | | |adipiscing elit. |adipiscing |
|elit. Pellentesque| | | | |elit. Pellentesque|
|vitae nisl | | | | |vitae nisl |
|imperdiet. | | | | |imperdiet. |
+------------------+------------------+----------+----------+------------------+------------------+
|Lorem ipsum dolor |Lorem ipsum dolor |Short |Short |Lorem ipsum dolor |Lorem ipsum dolor |
|sit amet, |sit amet, | | |sit amet, |sit amet, |
|consectetur |consectetur | | |consectetur |consectetur |
|adipiscing |adipiscing elit. | | |adipiscing elit. |adipiscing |
|elit. Pellentesque| | | | |elit. Pellentesque|
|vitae nisl | | | | |vitae nisl |
|imperdiet. | | | | |imperdiet. |
+------------------+------------------+----------+----------+------------------+------------------+
|Lorem ipsum dolor |Lorem ipsum dolor |Short |Short |Lorem ipsum dolor |Lorem ipsum dolor |
|sit amet, |sit amet, | | |sit amet, |sit amet, |
|consectetur |consectetur | | |consectetur |consectetur |
|adipiscing |adipiscing elit. | | |adipiscing elit. |adipiscing |
|elit. Pellentesque| | | | |elit. Pellentesque|
|vitae nisl | | | | |vitae nisl |
|imperdiet. | | | | |imperdiet. |
+------------------+------------------+----------+----------+------------------+------------------+
|Lorem ipsum dolor |Lorem ipsum dolor |Short |Short |Lorem ipsum dolor |Lorem ipsum dolor |
|sit amet, |sit amet, | | |sit amet, |sit amet, |
|consectetur |consectetur | | |consectetur |consectetur |
|adipiscing |adipiscing elit. | | |adipiscing elit. |adipiscing |
|elit. Pellentesque| | | | |elit. Pellentesque|
|vitae nisl | | | | |vitae nisl |
|imperdiet. | | | | |imperdiet. |
+------------------+------------------+----------+----------+------------------+------------------+
|Lorem ipsum dolor |Lorem ipsum dolor |Short |Short |Lorem ipsum dolor |Lorem ipsum dolor |
|sit amet, |sit amet, | | |sit amet, |sit amet, |
|consectetur |consectetur | | |consectetur |consectetur |
|adipiscing |adipiscing elit. | | |adipiscing elit. |adipiscing |
|elit. Pellentesque| | | | |elit. Pellentesque|
|vitae nisl | | | | |vitae nisl |
|imperdiet. | | | | |imperdiet. |
+------------------+------------------+----------+----------+------------------+------------------+
|Lorem ipsum dolor |Lorem ipsum dolor |Short |Short |Lorem ipsum dolor |Lorem ipsum dolor |
|sit amet, |sit amet, | | |sit amet, |sit amet, |
|consectetur |consectetur | | |consectetur |consectetur |
|adipiscing |adipiscing elit. | | |adipiscing elit. |adipiscing |
|elit. Pellentesque| | | | |elit. Pellentesque|
|vitae nisl | | | | |vitae nisl |
|imperdiet. | | | | |imperdiet. |
+------------------+------------------+----------+----------+------------------+------------------+
|Lorem ipsum dolor |Lorem ipsum dolor |Short |Short |Lorem ipsum dolor |Lorem ipsum dolor |
|sit amet, |sit amet, | | |sit amet, |sit amet, |
|consectetur |consectetur | | |consectetur |consectetur |
|adipiscing |adipiscing elit. | | |adipiscing elit. |adipiscing |
|elit. Pellentesque| | | | |elit. Pellentesque|
|vitae nisl | | | | |vitae nisl |
|imperdiet. | | | | |imperdiet. |
+------------------+------------------+----------+----------+------------------+------------------+