Proposed Scientific Documentation Updates to Quarto#2923
Draft
Proposed Scientific Documentation Updates to Quarto#2923
Conversation
-fixed toc local and global structure -fixed toc alignment - fixed header alignment -reformated compilation structure and separated preamble -checked table formating. One table adjusted in animal - removed label linking, pending updates
…030426 Updates to Formatting of Scientific Document
Insert an italicized note stating the minimum DMI (7.1 kg/d per cow, per Appuhamy et al. 2018) and a small 0.2 cm vertical spacing into both occurrences of the AN.EXC.24 block in docs/scientific/animal.tex to clarify the minimum dry matter intake.
Rebuild compiled documentation for the Animal module. Updated auxiliary files (.aux, .bbl, .bcf, .blg, .fdb_latexmk, .fls, .pdf) to reflect renumbered pages, TOC/LOT/LOF entries and adjusted counters (e.g. part/section/bookmark/etoc ids). Also modified babel/abx auxiliary commands and reference context, and removed the stale animalmoddoc.synctex.gz. These are generated artifacts from a documentation rebuild.
This reverts commit 348d7ca.
Replace plain-text citation 'per Appuhamy et al. 2018.' with a LaTeX citation command '\parencite{appuhamy2018}' in docs/scientific/animal.tex (two occurrences) to ensure consistent bibliography formatting.
Update Scientific Documentation to reflect lower bound for Lactating & Dry Cow DMI used in manure VS excretion prediction
Contributor
|
Quarto licensing is compatible with RuFaS licenses. Quarto v1.4 is licensed under the extremely permissible MIT license. |
Collaborator
|
I'm adding a list of things that we'll want to do before merging into dev:
|
morrowcj
force-pushed
the
quarto_scidoc_updates_0318
branch
from
f53b1cf to
41aabb8
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Context
Issue(s) closed by this pull request: closes #2808 and #2758
We are seeking alternative management of the Scientific Docs to improve workflows for maintaining and updating documentation.
timeline proposal
If Quarto updates move forward, updating the SOP of scientific documentation may be required.
What
This PR contains some suggested document structure, templates, and examples of automation & auditing. I also demonstrates options for tracking within document and how latex may still be incorporated for formatting customization as needed.
Additional sections to highlight changes between versions would be simpler and allow users to track documentations updates more easily. Quarto structure can ease this for maintainers too.
Why
This is an opportunity to review how these changes could function in real time and provide a head start to transfer if that is the direction we want to go.
How
Noted in "What"
Test plan
NA
Input Changes
NA
Output Changes
Filter