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.

Sign up for GitHub

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

Jump to bottom

📝 Typst template documentation #1179

Draft

roaldarbol wants to merge 1 commit into jupyter-book:main from roaldarbol:typst-template-docs

Contributor

roaldarbol commented May 2, 2024

Beginning to document how to create Typst templates. Will be accompanied by a new copier template (that will initially live on my Github, but that we can later transfer over to https://github.com/myst-templates/.


          Begin Typst template documentation

bd7cb61

roaldarbol changed the title ~~Begin Typst template documentation~~ 📝 Begin Typst template documentation

roaldarbol changed the title ~~📝 Begin Typst template documentation~~ 📝 Typst template documentation

rowanc1 force-pushed the main branch from 1c1a6ed to e1e1988 Compare

July 16, 2024 02:43

agoose77 reviewed

View reviewed changes

packages/jtex/docs/create-a-latex-template.md

@@ @@ -1,5 +1,5 @@ @@
               ---
-              title: Create a Template
+              title: Create a LaTeX Template
               description: jtex templates have a template.yml, template.tex, and any other images, class or definition files required for the template to render.

Contributor

agoose77 Dec 9, 2024

Suggested change

      
            description: jtex templates have a template.yml, template.tex, and any other images, class or definition files required for the template to render.
          
            description: LaTeX templates have a template.yml, template.tex, and any other images, class or definition files required for the template to render.

agoose77 reviewed

View reviewed changes

packages/jtex/docs/create-a-typst-template.md

@@ @@ -0,0 +1,324 @@ @@
+              ---
+              title: Create a Typst Template
+              description: jtex templates have a template.yml, template.typ, and any other images, class or definition files required for the template to render.

Contributor

agoose77 Dec 9, 2024

Suggested change

      
            description: jtex templates have a template.yml, template.typ, and any other images, class or definition files required for the template to render.
          
            description: Typst templates have a template.yml, template.typ, and any other images, class or definition files required for the template to render.

agoose77 reviewed

View reviewed changes

packages/jtex/docs/create-a-typst-template.md

+              ---
+              A `jtex` template contains everything necessary to create a $\LaTeX$ document, including a `template.yml`, the main `template.typ`, and any associated files such as classes (`*.cls`), definitions (`*.def`), or images (`*.png`).
+              These $\LaTeX$ templates are data-driven, in that they record all of the options in a `template.yml` which you create as you are working through moving your $\LaTeX$ document to a `jtex` template.

Contributor

agoose77 Dec 9, 2024

Suggested change

      
            These $\LaTeX$ templates are data-driven, in that they record all of the options in a `template.yml` which you create as you are working through moving your $\LaTeX$ document to a `jtex` template.
          
            These Typst templates are data-driven, in that they record all of the options in a `template.yml` which you create as you are working through moving your Typst document to a `jtex` template.

agoose77 reviewed

View reviewed changes

packages/jtex/docs/create-a-typst-template.md

Comment on lines +174 to +206

+              ## Update the authors and affiliations
+              The authors and affiliations are usually the hardest part to template as many journals do these differently.
+              If you are looking for inspiration, take a look at some of the existing templates in the [myst-templates](https://github.com/myst-templates) organization on GitHub.
+              For example, to create the following author/affiliations list:
+              ```latex
+              \authors{First Author\affil{1}, Author\affil{1,2}}
+              \affiliation{1}{First Affiliation}
+              \affiliation{2}{Second Affiliation}
+              ```
+              The `jtex` template is as follows:
+              ```latex
+              \authors{
+              [#- for author in doc.authors -#]
+              [-- author.name --]
+              [#- if author.affiliations -#]
+              \affil{
+              [-- author.affiliations|join(",", "index") --]
+              }
+              [#- endif -#]
+              [#- if not loop.last #], [# endif -#]
+              [#- endfor -#]
+              }
+              [# for affiliation in doc.affiliations #]
+              \affiliation{[-affiliation.index-]}{[-affiliation.value-]}
+              [# endfor #]
+              ```

Contributor

agoose77 Dec 9, 2024

TODO: refer to the frontmatter plugin from Curvenote for typst

agoose77 reviewed

View reviewed changes

packages/jtex/docs/create-a-typst-template.md

+              myst build my-document.md --tex
+              ```
+              By default these are put in a `_build` folder. If you want to control that, use the `output:` field in the appropriate export. If you have $\LaTeX$ installed, you can also try changing the format to `pdf` or `pdf+tex` to keep the source files. See [](/guide/creating-pdf-documents) for more information on using MyST templates for $\LaTeX$.

Contributor

agoose77 Dec 9, 2024

Suggested change

      
            By default these are put in a `_build` folder. If you want to control that, use the `output:` field in the appropriate export. If you have $\LaTeX$ installed, you can also try changing the format to `pdf` or `pdf+tex` to keep the source files. See [](/guide/creating-pdf-documents) for more information on using MyST templates for $\LaTeX$.
          
            By default these are put in a `_build` folder. If you want to control that, use the `output:` field in the appropriate export. If you have Typst installed, you can also try changing the format to `pdf` or `pdf+typst` to keep the source files. See [](/guide/creating-pdf-documents) for more information on using MyST templates for Typst.

agoose77 reviewed

View reviewed changes

packages/jtex/docs/create-a-typst-template.md

+              ---
+              ```
+              Ensure that the exports list has a `format: tex` in it. To also have your `parts` defined, use blocks with JSON metadata:

Contributor

agoose77 Dec 9, 2024

Suggested change

      
            Ensure that the exports list has a `format: tex` in it. To also have your `parts` defined, use blocks with JSON metadata:
          
            Ensure that the exports list has a `format: typst` in it. To also have your `parts` defined, use blocks with JSON metadata:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet