search

carpentries / glosario-r

glosario create and retrieve multilingual glossaries.
https://carpentries.github.io/glosario-r
Other
6 stars 5 forks source link

Use Case - Checking a lesson [Consistency Support] #7

Closed ian-flores closed 3 years ago

ian-flores commented 4 years ago
  1. Checking a lesson.
    1. Beatriz has made some changes to a lesson she inherited from Amari, and wants to check that it is still consistent.
    2. She runs a command-line script that:
      1. Reads the R Markdown file.
      2. Extracts the terms under the glossary/defines key.
      3. Searches the body of the document for calls to gdef(...).
      4. Checks that every term listed in glossary/defines is referenced in the document body, and that every term referenced in the document body is mentioned in glossary/defines.
ian-flores commented 4 years ago

validate_document(file_path) is the solution to this.

ian-flores commented 3 years ago

This functionality has been included in the R package. However, it's not shown on the website as the pkgdown Action had an error when building the latest change 9 months ago.