summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLaurent P. René de Cotret <laurent.decotret@outlook.com>2020-05-22 08:28:57 -0400
committerLaurent P. René de Cotret <laurent.decotret@outlook.com>2020-05-22 08:28:57 -0400
commit6af83d4833b9b9c2f817238fd5d0cf421088798d (patch)
treea44481cb8760d20eaede1b9295aa7d0d6076d230
parentc1588bbeb44e596d86e8f6cc58299f852ddeb9b2 (diff)
[skip ci] Updated documentation0.4.0.0
-rw-r--r--README.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/README.md b/README.md
index f0aac88..d679e6f 100644
--- a/README.md
+++ b/README.md
@@ -14,7 +14,7 @@
* [Captions](#captions)
* [Link to source code](#link-to-source-code)
* [Preamble scripts](#preamble-scripts)
- * [No wasted work](#no-wasted-work)
+ * [Performance](#performance)
* [Compatibility with pandoc-crossref](#compatibility-with-pandoc-crossref)
* [Configuration](#configuration)
* [Toolkit-specific options](#toolkit-specific-options)
@@ -176,9 +176,13 @@ The equivalent LaTeX usage is as follows:
This `preamble` parameter is perfect for longer documents with many plots. Simply define the style you want in a separate script! You can also import packages this way, or define functions you often use.
-### No wasted work
+### Performance
-`pandoc-plot` minimizes work, only generating figures if it absolutely must, i.e. if the content has changed. Therefore, you can confidently run the filter on very large documents containing dozens of figures --- like a book or a thesis --- and only the figures which have changed will be re-generated.
+`pandoc-plot` minimizes work, only generating figures if it absolutely must, i.e. if the content has changed.
+
+`pandoc-plot` will save the hash of the source code used to generate a figure in its filename. Before generating a figure, `pandoc-plot` will check it this figure already exists based on the hash of its source! This also means that there is no way to directly name figures.
+
+Therefore, you can confidently run the filter on very large documents containing hundreds of figures --- like a book or a thesis --- and only the figures which have changed will be re-generated.
### Compatibility with pandoc-crossref