automeris-io / WebPlotDigitizer

Computer vision assisted tool to extract numerical data from plot images.
https://automeris.io
GNU Affero General Public License v3.0
2.67k stars 363 forks source link

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

Closed nbehrnd closed 2 years ago

nbehrnd commented 2 years ago

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.

nbehrnd commented 2 years ago

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 commented 2 years ago

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.

nbehrnd commented 2 years ago

Yes, to update and even more so, to correct the files with a systematic search and replace, thankfully the elders shared sed, awk (for which Brian Kernighan in May improved the support of unicode characters), and regexes.