search

joostkremers / pandoc-mode

An Emacs minor mode for interacting with Pandoc.
https://joostkremers.github.io/pandoc-mode/
177 stars 14 forks source link

--reference-docx has been removed. Use --reference-doc instead #109

Open tblesik opened 2 years ago

tblesik commented 2 years ago

Hey everyone,

I like to use a reference docx file when exporting. It seems that they changed the argument, because I get the following error when I try to export with a reference doc set:

--reference-docx has been removed. Use --reference-doc instead.
Try pandoc --help for more information.

This is in line with using pandoc via CLI directly. I guess simply changing the command would solve the issue.

joostkremers commented 2 years ago

The reference-doc option already exists in pandoc-mode, at least since version 2.24. If you have an older version of pandoc-mode, you should upgrade. Otherwise, just check pandoc-mode's menu, under "Options | Options for specific writers". It's listed right under 'reference-docx'.

I've kept the reference-docx option around in case people need to work with older versions of Pandoc

Though I admit it might be a good idea to make them less prominent, so that the options for the current Pandoc version are more visible.

TiFaBl commented 2 years ago

now that you say it, I see it as well. I think backwards compatibility is important and it might be sufficient to swap the order, simply because I just went with the first thing that sounded appropriate, which was the outdated version. Furthermore: is the new --reference-doc more generic or is there another reason that "Doc" is capitalized and "docx" is not? I think that also suggested to me to not be the right choice for an MS Word docx. The last thing that threw me off: the short cut key to specify the Word as output format is "d" and to specify the --reference-docx is also "d" - that suggested a good fit for me.

Anyhow, thanks for clarification. It works and the rest is UI.

joostkremers commented 2 years ago

now that you say it, I see it as well. I think backwards compatibility is important and it might be sufficient to swap the order, simply because I just went with the first thing that sounded appropriate, which was the outdated version.

I changed the order yesterday, putting all obsolete options at the bottom of their respective menus.

Furthermore: is the new --reference-doc more generic or is there another reason that "Doc" is capitalized and "docx" is not?

No, that's exactly the reason. -reference-doc is also used for odt and pptx output, so "doc" in --reference-doc is short for "document".

I think that also suggested to me to not be the right choice for an MS Word docx.

Yeah, that's understandable. I'm not sure how to improve that, though, UI-wise.

One thing I could do is to check the version of Pandoc that is being used and adjust the UI to match. That would be some work, though, especially in tracking down when each option was added and possibly removed again...

The last thing that threw me off: the short cut key to specify the Word as output format is "d" and to specify the --reference-docx is also "d" - that suggested a good fit for me.

Yes, originally it was, of course. Both keys were assigned because they refer to docx. But that doesn't really work anymore, of course. Perhaps I could reassign some of the keys in the "Specific Writers" submenu.