Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change in how the documentation is structured for Exporting, Defaults, and Academic Tools #158

Open
do-not-perceive-me opened this issue Nov 6, 2022 · 0 comments

Comments

@do-not-perceive-me
Copy link

This is related to my doc update about word, odt, pptx exports in the defaults documentation. I feel that perhaps it should be placed under another file instead, perhaps in Export or under Academic Tools.

Overall, I think the files could be organized differently and that the page titles could be more clear. I think it could also be a good idea to have a central table of contents page within each of the categories that describes what each page is about. Because I find myself having to click through all the pages back and forth trying to find the information I want. I think the documentation is fine if you know what you need to search for, but if you're not familiar with pandoc or more technical things, then you wouldn't think to check pages like Defaults and Assets Managers for answers to your problems.

I think Presentantations could be renamed to HTML Presentation, to make it clear that it's not for Powerpoint presentations. Similarly, Custom Templates could include LaTeX in the page name. Or a clear note at the top to say which types of export the current page applies to.

Under Exporting, it might make sense to have a section that is more clear about if you need defaults, a template, or a reference doc based on which type of export you want. Right now it just gives a link to defaults or template page without saying which one you would need for a specific type of export.

For example something like this, including the links to the pages:

Export Options based on File Type

HTML, PDF, LaTeX, RTF, HTML presentations (and the others):

  • Defaults file in Assets Manager
  • Custom LaTeX templates
  • YAML

Word, ODT, Powerpoint presentations:

  • Defaults file in Assets Manager
  • custom Reference Document
  • YAML (I don't actually know if this works for word export)

I don't know enough about how all the other types of export work to write a clear summary of what needs to be done for them, but I could help edit the pages to make things more clear if someone else is able to provide the info.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant