aboutsummaryrefslogtreecommitdiff
path: root/MANUAL.txt
diff options
context:
space:
mode:
authorNils Carlson <nils@nilscarlson.se>2020-12-05 18:00:04 +0000
committerGitHub <noreply@github.com>2020-12-05 10:00:04 -0800
commitc161893f442a3e001b64af1421e9f62376d71c92 (patch)
tree7c10d75b6c5d69169fb300bd803764daccb6d7f5 /MANUAL.txt
parentddb76cb356a82f6a9e51a6f3626dd154816e9205 (diff)
downloadpandoc-c161893f442a3e001b64af1421e9f62376d71c92.tar.gz
OpenDocument writer: Allow references for internal links (#6774)
This commit adds two extensions to the OpenDocument writer, `xrefs_name` and `xrefs_number`. Links to headings, figures and tables inside the document are substituted with cross-references that will use the name or caption of the referenced item for `xrefs_name` or the number for `xrefs_number`. For the `xrefs_number` to be useful heading numbers must be enabled in the generated document and table and figure captions must be enabled using for example the `native_numbering` extension. In order for numbers and reference text to be updated the generated document must be refreshed. Co-authored-by: Nils Carlson <nils.carlson@ludd.ltu.se>
Diffstat (limited to 'MANUAL.txt')
-rw-r--r--MANUAL.txt37
1 files changed, 37 insertions, 0 deletions
diff --git a/MANUAL.txt b/MANUAL.txt
index fad885fed..4e1615ff2 100644
--- a/MANUAL.txt
+++ b/MANUAL.txt
@@ -3027,6 +3027,43 @@ This extension can be enabled/disabled for the following formats:
output formats
: `odt`, `opendocument`
+#### Extension: `xrefs_name` ####
+
+Links to headings, figures and tables inside the document are
+substituted with cross-references that will use the name or caption
+of the referenced item. The original link text is replaced once
+the generated document is refreshed. This extension can be combined
+with `xrefs_number` in which case numbers will appear before the
+name.
+
+Text in cross-references is only made consistent with the referenced
+item once the document has been refreshed.
+
+This extension can be enabled/disabled for the following formats:
+
+output formats
+: `odt`, `opendocument`
+
+#### Extension: `xrefs_number` ####
+
+Links to headings, figures and tables inside the document are
+substituted with cross-references that will use the number
+of the referenced item. The original link text is discarded.
+This extension can be combined with `xrefs_name` in which case
+the name or caption numbers will appear after the number.
+
+For the `xrefs_number` to be useful heading numbers must be enabled
+in the generated document, also table and figure captions must be enabled
+using for example the `native_numbering` extension.
+
+Numbers in cross-references are only visible in the final document once
+it has been refreshed.
+
+This extension can be enabled/disabled for the following formats:
+
+output formats
+: `odt`, `opendocument`
+
#### Extension: `styles` #### {#ext-styles}
When converting from docx, read all docx styles as divs (for