clarkzjw / TexCITemplate

Sample TeX Project Workflow

Tools

• TexLive
• VSCode
• LaTeX Workshop
• Zotero
• Zotero Connector
• Zotero Better BibTeX

Optional:

• VSCode LaTeX Workshop setting:

• Zotero Better BibTeX can keep the .bib file in the project folder automatically updated with the references in Zotero.

Workflow

• Write content in tex directory, split into multiple files based on chapters or sections, and include them with \input{} in main.tex.

• VSCode LaTeX Workshop will compile tex files automatically on save. The generated PDF file can be previewed either in the VSCode side panel or in a browser.

• Alternatively, the PDF file can be generated manually by running make using the Makefile, using the latexmk command.

• Same as the workflow of software development, once *.tex files and corresponding figures are commited with git, and pushed to GitHub, the GitHub action workflow defined in build.yaml will be triggered automatically to compile the PDF file and upload it as an artifact, e.g., https://github.com/clarkzjw/TexCITemplate/actions/runs/9944573878. It ensures reproducibility and version control of not only code, but also the figures and tex files.

• Once a major version is ready, i.e., ready for requesting for internal/external feedback, or submitted to reviewer, a release/tag can be created in GitHub, which also triggers the GitHub action workflow to compile the PDF file and upload it as an artifact in the release page, e.g., https://github.com/clarkzjw/TexCITemplate/releases/tag/20240715.

• Once feedback is received and major revisions are made, diff files can be generated using the latexdiff command in the Makefile.