Skip to content

Update plots.md #405

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

Open
wants to merge 1 commit into
base: source
Choose a base branch
from
Open

Update plots.md #405

wants to merge 1 commit into from

Conversation

mdisi2
Copy link
Contributor

@mdisi2 mdisi2 commented Apr 1, 2025

Added sections about Tikz and Inkscape to the plots guide.

I included a short example of Tikz and linked to all the proper websites. Please review what I wrote and feel free to remove the example if you feel it is unnecessary.

@nsryan2 @ZoeRichter

Added sections about Tikz and Inkscape to the plots guide. I included a short example of Tikz in use and linked to all the proper websites. Feel free to remove the example if you feel it is unnecessary.
@ZoeRichter ZoeRichter self-requested a review April 10, 2025 14:53
Copy link
Member

@katyhuff katyhuff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few minor typos, one suggestion. Maybe run a spellchecker (all text editors have them, you just have to find it. In vim, it's <ESC>:set spell

## 6. Inkscape

[Inkscape](https://inkscape.org/about/) is a free vector graphics editor.
It's most notable feature is allowing for percise dimensions and units
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
It's most notable feature is allowing for percise dimensions and units
It's most notable feature is allowing for precise dimensions and units


[Inkscape](https://inkscape.org/about/) is a free vector graphics editor.
It's most notable feature is allowing for percise dimensions and units
for creating shapes, ensuring all figures are to scale. It is especailly
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
for creating shapes, ensuring all figures are to scale. It is especailly
for creating shapes, ensuring all figures are to scale. It is especially

helpful when you need to create graphics that can't easily be made
automatically. Graphics are automatically saved as .svg files, but Inkscape
can also supports .pdf and .png files. While creating graphics, make sure to
follow the accessibility standards in regards to font, linetsyle, and color.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a link you could put here -- maybe to the writing guide where a new paragraph will eventually include an accessibility paragraph or something ? (https://arfc.github.io/manual/guides/writing/)

\usepackage{tikz}
\begin{document}
\begin{tikzpicture}
\draw[red, very thick] (0,2) circle (3cm); %% Draws a circle at (0,2) with radius 3cm - using ';' to mark shape as complete
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line too long.

Tikz tutorials and documentation can be found on both the
[website](https://tikz.dev/tutorials-guidelines) and on
[overleaf](https://www.overleaf.com/learn/latex/TikZ_package). Further examples of
figures made within Tikz can be viewed in the Latex/Tikz [Gallary](https://texample.net/).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
figures made within Tikz can be viewed in the Latex/Tikz [Gallary](https://texample.net/).
figures made within Tikz can be viewed in the Latex/Tikz [Gallery](https://texample.net/).

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