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

tech note about pandoc troubleshooting #531

Merged
merged 73 commits into from
Jun 1, 2023
Merged

tech note about pandoc troubleshooting #531

merged 73 commits into from
Jun 1, 2023

Conversation

maelle
Copy link
Member

@maelle maelle commented Mar 28, 2023

TODO for @maelle

  • Add French translation

Copy link
Contributor

@cderv cderv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

First review.

Overall I like this post.

I wonder if we are missing to big part (but that would make the post longer)

  • A better intro to the "Why of the pandoc package" as we mention it a lot. Wondering about this because most of the function are intented to be run for debugging, with self installed pandoc, and not the quarto one, or the system one. Just a warning to user of the context and how they install and manage their pandoc to help them debug

  • A part on Quarto as

    • A good alternative to further with pandoc
    • A warning of more difficulties to debug pandoc itself when from Quarto becasue Quarto adds a lot to it!

Not sure if I am clear enough, but hoepfully you get the rough ideas 😅

Copy link
Member

@steffilazerte steffilazerte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @maelle, Hi @cderv!

What a post! I've learned so much and am so excited to up my Quarto/Pandoc game, thank you 😁

The post is really well organized and covered a lot of really useful details. My suggestions are mostly fiddly wording tweaks, as well as some clarifications for readers who may be less technically inclined. See what you think (and whether I've understood correctly!).

Let me know if you have any questions!

  • post follows Content Guidelines
  • post follows Style Guide
  • title is in Title Case -> See my suggestion
  • publication date is ok
  • alternative text of images is informative
  • author metadata is provided with correct folder name
  • html not included in pull request of Rmd post
  • I ran roblog::ro_lint_md() on index.md
  • I ran roblog::ro_check_urls() on index.md
  • I ran a spell-check on index.md
  • YAML subject tags are ok ("tech notes" for tech notes; "community" for non-staff non-editor)
    • Should there be a community tag because of Christophe?
  • YAML field 'preface' is present if necessary

## Conclusion

In this post we shared some useful resources for troubleshooting your Pandoc problems.
It's crucial to remember your Pandoc skills and vocabulary will improve with practice.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
It's crucial to remember your Pandoc skills and vocabulary will improve with practice.
It's crucial to remember that while this can seem like a lot, your Pandoc skills and vocabulary will improve with practice!

Copy link
Member

@steffilazerte steffilazerte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @maelle, Hi @cderv!

What a post! I've learned so much and am so excited to up my Quarto/Pandoc game, thank you 😁

The post is really well organized and covered a lot of really useful details. My suggestions are mostly fiddly wording tweaks, as well as some clarifications for readers who may be less technically inclined. See what you think (and whether I've understood correctly!).

Let me know if you have any questions!

  • post follows Content Guidelines
  • post follows Style Guide
  • title is in Title Case -> See my suggestion
  • publication date is ok
  • alternative text of images is informative
  • author metadata is provided with correct folder name
  • html not included in pull request of Rmd post
  • I ran roblog::ro_lint_md() on index.md
  • I ran roblog::ro_check_urls() on index.md
  • I ran a spell-check on index.md
  • YAML subject tags are ok ("tech notes" for tech notes; "community" for non-staff non-editor)
    • Should there be a community tag because of Christophe?
  • YAML field 'preface' is present if necessary


Some options might be hidden by the tool you use to call Pandoc, or handily exposed as argument: for instance, the `to` argument of the [`pandoc::pandoc_convert()`](https://cderv.github.io/pandoc/reference/pandoc_convert.html) function is actually a Pandoc option.

Below, we use an option to shift heading levels by 1 which increases the heading level number thereby reducing the heading importance.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Below, we use an option to shift heading levels by 1 which increases the heading level number thereby reducing the heading importance.
However, most options can be specified using the `args` argument of [`pandoc::pandoc_convert()`](https://cderv.github.io/pandoc/reference/pandoc_convert.html). In this example, we use an option to shift heading levels by 1 which increases the heading level number thereby reducing the heading importance.

Copy link
Member

@Bisaloo Bisaloo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for sharing! It really helped me organize my mental model about Pandoc and the different ways we can change its behaviour.

I've made a couple of suggestions. Some of them might not be great because I'm just not used to reading technical content in French 😬. Feel free to ignore anything you disagree with!


## Suivre l'évolution de Pandoc, ou geler Pandoc !

Suivre l'évolution de Pandoc n'est vraiment pas obligatoire et la lecture du "changelog" (journal des modifications) pourrait être difficile à suivre sans une bonne compréhension du fonctionnement de Pandoc.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Question de style que je n'ai pas relevée plus tôt : quand tu donnes à la fois les termes anglais et français, c'est mieux de commencer par l'anglais ou le français ? Qu'est-ce qui est fait dans les autres billets du blog ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellente question, je vais me renseigner 😸

@maelle
Copy link
Member Author

maelle commented May 29, 2023

@Bisaloo thanks a ton!! Super useful comments.

@maelle maelle merged commit 8d482ac into main Jun 1, 2023
5 checks passed
@maelle maelle deleted the pandoc branch June 1, 2023 06:47
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

Successfully merging this pull request may close these issues.

None yet

4 participants