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

small update on the documentation in .tex/.pdf #295

Merged
merged 7 commits into from
Nov 13, 2022

Conversation

nbehrnd
Copy link
Contributor

@nbehrnd nbehrnd commented Oct 24, 2022

Small updates in the documentation leading to the .pdf to reflect the application's current release is version 4.6 including recompilation of the .pdf itself.

Spurred by section 5.3 where figure 12 is cross-referenced, now all
labels about figures are used with the fixed space (tilde sign).
For easier reading of the .tex, use of a blank line prior/after
an itemize/enumerate block.  In reference to IUPAC's Green Book,
use of roman subscripts because the subscripts do not describe a
physical property.
The default installation of git yields an incompliet fork and local
check-out because the project uses git's large file storage.  This
requires an additional installation on top of git which now are
described.
@nbehrnd
Copy link
Contributor Author

nbehrnd commented Oct 24, 2022

With the recent hint about its use in Windows here which might be use an additional note (not yet considered in the present PR), instead of one line per paragraph (in the .tex file), I would like to suggest shorter lines of up to x characters each. In case of e.g., an editor like TeXStudio to use a hard line wrap after e.g., 80 characters. On one hand, LaTeX still would require an explicit new line to start a new paragraph. On the other hand, reading the diff views git provides would be easier + reading the .tex and compiled .pdf side by side would require less screen estate.

Can this suggest fit in your workflow about the digitizer's .tex, or do you have an other preference?

(Obviously, applying fmt -w 80 on the whole .tex file would render the definitions of tables, figures, etc. much less easy to maintain and thus should not be used here.)

@ankitrohatgi
Copy link
Member

Hi, thanks for the edits! I was able to grok the changes quite easily even with the long lines - I don't have a fixed editing workflow for tex files and tend to edit with whatever tool I happen to have on whichever machine I'm on (usually a Mac or Linux). I'll think about imposing the character limits for this file later.

@ankitrohatgi ankitrohatgi merged commit 001ffcd into automeris-io:master Nov 13, 2022
@nbehrnd
Copy link
Contributor Author

nbehrnd commented Nov 14, 2022 via email

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.

2 participants