implement lof and lot for docx #10029
Conversation
|
@iandol if you get the chance I would love for you to try this PR out. |
|
I don't have a build environment for haskell, so once there is a build for macOS I can test... |
lotTitle <- T.text <$> translateTerm Term.ListOfTablesis raising an error. lotTitle <- translateTerm Term.ListOfTablesIf you want import qualified Text.Pandoc.Builder as B
...
lotTitle <- B.text <$> translateTerm Term.ListOfTablesBut I think it will work for you if it's just a Text, because you just need to stuff it into an XML attribute. |
|
@jgm Again thanks for your help on this. Neither of those options will work as we don't want a As mentioned in the review comments, the solution is to pass the |
|
Now that we've iterated on the suggestions. Is there anything else left in this PR, before we add the snippet mentioned in the OP regarding Also would like a confirmation if any more changes are required in the docs/manual due to this change? There is also the latex issue (i.e. latex using the command line options) as well, but that is prob best handled in a follow up PR. Again thanks for reviewing this work @jgm |
|
You've tested this and the lot and lof appear correctly in Word documents? |
|
I tried to check this out locally, but it seems it needs to be rebased on main. |
|
@jgm rebased! The output you see in the OP is the result of this PR. I'd like for you to try it locally (if you can) before we merge it in however, just so we have another user as a datapoint. |
|
Thanks. Tested it locally and it works well. But we do need to make sure that it works the same for LaTeX and ConTeXt, too. Here's how to do it: diff --git a/MANUAL.txt b/MANUAL.txt
index ba965cf37..2fd2ce152 100644
--- a/MANUAL.txt
+++ b/MANUAL.txt
@@ -872,18 +872,18 @@ header when requesting a document from a URL:
`--lof[=true|false]`, `--list-of-figures[=true|false]`
: Include an automatically generated list of figures (or, in
- the case of `latex` or `docx`, an instruction to create
- one) in the output document. This option has no effect
- unless `-s/--standalone` is used, and it only has an effect
- on `latex` or `docx` output.
+ some formats, an instruction to create one) in the output
+ document. This option has no effect unless `-s/--standalone`
+ is used, and it only has an effect on `latex`, `context`, and
+ `docx` output.
`--lot[=true|false]`, `--list-of-tables[=true|false]`
: Include an automatically generated list of tables (or, in
- the case of `latex` or `docx`, an instruction to create
- one) in the output document. This option has no effect
- unless `-s/--standalone` is used, and it only has an effect
- on `latex` or `docx` output.
+ some formats, an instruction to create one) in the output
+ document. This option has no effect unless `-s/--standalone`
+ is used, and it only has an effect on `latex`, `context`, and
+ `docx` output.
`--strip-comments[=true|false]`
diff --git a/src/Text/Pandoc/Writers/ConTeXt.hs b/src/Text/Pandoc/Writers/ConTeXt.hs
index 6c4bab355..9e35c803b 100644
--- a/src/Text/Pandoc/Writers/ConTeXt.hs
+++ b/src/Text/Pandoc/Writers/ConTeXt.hs
@@ -104,6 +104,8 @@ pandocToConTeXt options (Pandoc meta blocks) = do
mblang <- fromBCP47 (getLang options meta)
st <- get
let context = defField "toc" (writerTableOfContents options)
+ $ defField "lof" (writerListOfFigures options)
+ $ defField "lot" (writerListOfTables options)
$ defField "placelist"
(mconcat . intersperse ("," :: Doc Text) $
take (writerTOCDepth options +
diff --git a/src/Text/Pandoc/Writers/LaTeX.hs b/src/Text/Pandoc/Writers/LaTeX.hs
index 04e0ab3db..edbc40aaf 100644
--- a/src/Text/Pandoc/Writers/LaTeX.hs
+++ b/src/Text/Pandoc/Writers/LaTeX.hs
@@ -194,6 +194,8 @@ pandocToLaTeX options (Pandoc meta blocks) = do
$ lookupMetaInlines "nocite" meta
let context = defField "toc" (writerTableOfContents options) $
+ defField "lof" (writerListOfFigures options) $
+ defField "lot" (writerListOfTables options) $
defField "toc-depth" (tshow
(writerTOCDepth options -
if stHasChapters stAlso, I think that before merging it might make sense to squash everything into a single commit. |
|
@jgm done! |
There was a problem hiding this comment.
I think it looks great! I'm sorry, one more request. Can you update your commit message so that it indicates clearly what has changed? I will need this later to add these items to the changelog. It is especially important to note the new command-line options and any API changes (new fields in WriterOptions and Opt for example).
API chages should be marked as [API change].
|
Of course, I want to make sure this PR is done properly. Changed the commit message. Let me know if there is anything else. |
use lof and lot options in latex and context implement lof and lot for docx [command line] add `--lof[=true|false]`, `--list-of-figures[=true|false]` [command line] add `--lot[=true|false]`, `--list-of-tables[=true|false]` [API change] `WriterOptions`: add property `list_of_figures` [API change] `WriterOptions`: add property `list_of_tables` [API change] `Options`: add `writerListOfFigures :: Bool` [API change] `Options`: add `writerListOfTables :: Bool` [API change] `App/Opt`: add `optListOfFigures :: Bool` [API change] `App/Opt`: add `optListOfTables :: Bool` Co-authored-by: John MacFarlane <jgm@berkeley.edu>
|
Thanks! I rewrote the commit message a bit to fit what I like for the changelog. |
|
Tried looking at your previous commits to get a feel for it, but what you wrote is cleaner. Thanks for taking the cycles working with me to get this merged in, @jgm! I really appreciate it. |
I hope you will. |
…0029) Two new command-line options are added: `--lof[=true|false]`, `--list-of-figures[=true|false]` `--lot[=true|false]`, `--list-of-tables[=true|false]` Only docx, latex, and context are supported at this point. Setting the `lof` and `lot` variables will also work for the formats that are currently supported. [API changes] + Lua: `list_of_figures` and `list_of_tables` can now be used in writer options. + Text.Pandoc.Options: add `writerListOfFigures` and `writerListOfTables` fields to `WriterOptions`. + Text.Pandoc.App.Opt: add `optListOfFigures` and `optListOfTables` to `Opt`. Closes jgm#8245. Co-authored-by: John MacFarlane <jgm@berkeley.edu>
…0029) Two new command-line options are added: `--lof[=true|false]`, `--list-of-figures[=true|false]` `--lot[=true|false]`, `--list-of-tables[=true|false]` Only docx, latex, and context are supported at this point. Setting the `lof` and `lot` variables will also work for the formats that are currently supported. [API changes] + Lua: `list_of_figures` and `list_of_tables` can now be used in writer options. + Text.Pandoc.Options: add `writerListOfFigures` and `writerListOfTables` fields to `WriterOptions`. + Text.Pandoc.App.Opt: add `optListOfFigures` and `optListOfTables` to `Opt`. Closes jgm#8245. Co-authored-by: John MacFarlane <jgm@berkeley.edu>
lof and lot have been implemented for LaTeX for a while now.
This PR adds support for lof and lot in docx, closing #8245
In doing so, lof and lot are also exposed to the command line and corresponding documentation is added.
Please if you could review any instances where I have missed documentation regarding lof and lot, I would much appreciate it, @jgm. I did my best, but I would appreciate another pair of eyes.
A specific question:
Should I be adding in
lof/lotandlof-title/lot-titlehere based on the changes that this PR has?pandoc/MANUAL.txt
Lines 3337 to 3344 in 2f36df6
Note: the latex writer prob needs to be modified to use these command line args. This wasn't obvious for me to do. I'll need some help if this change needs to be done in this PR. See: 64c7a0a for more info.
Also note that the default.openxml template needs to be modified as well.
(Edit: has been modified)
Example:
Pandoc Markdown File:
Output Docx File:
