-
Notifications
You must be signed in to change notification settings - Fork 19
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
Add glossary #210
Add glossary #210
Conversation
- \newglossary[skills.glg]{skills}{skills.gls}{skills.glo}{Skill codes} | ||
- \makeglossaries | ||
- \input{glossary.tex} | ||
- \newglossaryentry{DOCBB}{name={DOCBB},type={skills},description={Creating documented code building blocks}} | ||
- \newglossaryentry{LIBS}{name={LIBS},type={skills},description={Building distributable libraries}} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note: I'm defining these acronyms here, because they have a type
, and thus require a \newglossary
call that declares a new skills
namespace with file extension .skills.*
. By keeping these terms separate from the terms defined in glossary.tex
, it is possible to re-use glossary.tex
in the other manuscripts.
@@ -23,12 +24,18 @@ all: $(objects) | |||
-M pdfa-$(MAKE_PDFA)=1 \ | |||
-M date="`date "+%B %e, %Y"`" \ | |||
-M datexmp="`date "+%F"`" \ | |||
-M linkcolor=darkgray \ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This color is almost black, so that acronyms and terms do not attract too much attention, while still being perceptible as links. One could also make this color black
, then the terms (and links to figures/tables) would be indistinguishable from the regular text.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I opened in on my home pc with Adobe Acrobat and since it does not give a 'hover preview' I think it makes sense to keep the color as darkgray.
@CaptainSifff, @jpthiele, @MakisH Here is a proof-of-concept for a glossary, as discussed earlier today in the Zoom call. Let me know if this is desirable. If not, no hard feelings; I'll recycle this work in my personal LaTeX guidebook anyway. 😃 I opted not to use tomncooper/pandoc-gls, because it is less flexible, the syntax is cryptic to novice users, and it doesn't work inside LaTeX environments. Instead the Many thanks to @ljgarcia for identifying acronyms in #205, this helped me speed up the process a lot. |
@jngrad Have you thought about presenting your guidebook at deRSE24? |
It looks nice! Do you think, that the abbreviations are complete? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very nice! Works nicely in Okular and Evince. Some minor suggestions to consider.
Closes #158 (which was previously closed as not planned).
I agree with Gerasimos points. On a side note: Adobe Acrobat explicitly tells me the PDF is PDF/A compatible, which is nice! |
Co-authored-by: Gerasimos Chourdakis <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess the two-columns is tricky. Looks already very good!
Tiny suggestion (I cannot make it in GitHub):
- static analysis automated procedure to detect software bugs in source code without actually executing the code.
+ static analysis automated procedure to detect software bugs in source code without executing the code.
to save a "useless" new line that only has the page number "9":
Edit: Edited the file directly, to help merging it faster.
Add a glossary for: