-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Create combined-acronyms.tex Combined acronyms form cdeep_acronyms.tex, acronyms.tex , and acronym_list.md (on spacecoron_design_docs Overleaf repo) files together and added some new ones. * Create latex_acronyms-to-markdown.py Rough script for converting latex acronyms to a markdown list that might be easier to read from (made this in starting weeks for just testing). * Update combined-acronyms.tex Added ERD acronym * Update combined-acronyms files Added acronyms / abbreviations found in spacecoron_design_docs/ICDs/template.md file. * Update combined-acronyms.tex Adding additional acronyms found. * Moving to a utilities directory * Update combined-acronyms.tex * Update combined-acronyms.tex Adding more acronyms. * Update combined-acronyms.tex * Adding more acronyms Updating files with new acronyms added from payload guide. * Updating from ESC Guide Adding new acronyms used in ESC Contamination Control Plan in spacecoron_design_docs. * Adjusting acronym * Adding STIS Missing acronym used in documentation. Adding STIS. * Create combined-acronyms.tex Combined acronyms form cdeep_acronyms.tex, acronyms.tex , and acronym_list.md (on spacecoron_design_docs Overleaf repo) files together and added some new ones. * Create latex_acronyms-to-markdown.py Rough script for converting latex acronyms to a markdown list that might be easier to read from (made this in starting weeks for just testing). * Update combined-acronyms.tex Added ERD acronym * Update combined-acronyms files Added acronyms / abbreviations found in spacecoron_design_docs/ICDs/template.md file. * Update combined-acronyms.tex Adding additional acronyms found. * Moving to a utilities directory * Update combined-acronyms.tex * Update combined-acronyms.tex Adding more acronyms. * Update combined-acronyms.tex * Adding more acronyms Updating files with new acronyms added from payload guide. * Updating from ESC Guide Adding new acronyms used in ESC Contamination Control Plan in spacecoron_design_docs. * Adjusting acronym * Update md-workflow.yml Adding back if statement for updating files portion. * Adding STIS Missing acronym used in documentation. Adding STIS. * Update md-workflow.yml * Update combined_acronyms.tex From ESD Control Plan documentation. * Create glossaries.tex Testing out glossaryentries. Might have to remove. * update markdown acronyms * Update combined_acronyms.tex * Create gitinfo2-hook.sh * Update glossaries.tex Trying to categorize / adding type value. * Draft compile-test.sh * Draft compile-test.tex Not working / not finished yet. * update markdown acronyms * Update combined_acronyms.tex * update markdown acronyms * update markdown acronyms * add scoob combined_acronyms.tex * update markdown acronyms * add iEFC Update combined_acronyms.tex * update markdown acronyms * update markdown acronyms --------- Co-authored-by: Stephanie Rinaldi <srinaldi@arizona.edu> Co-authored-by: sfrinaldi <163890342+sfrinaldi@users.noreply.github.com> Co-authored-by: GitHub Action <action@github.com>
- Loading branch information
4 people
authored
Jan 8, 2025
1 parent
e1dbffa
commit 86303f3
Showing
7 changed files
with
227 additions
and
4 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| # Simply for compiling compile-test.tex to see if it has errors. No error catching at the moment / using latex warnings for troubleshooting if there are problems with edits. | ||
|
|
||
| # Setup gitinfo | ||
| sed -i -e 's/\r$//' gitinfo2-hook.sh | ||
| bash gitinfo2-hook.sh | ||
|
|
||
| # Using -shell-escape in case this repo becomes a latex documentation template and minted is used. | ||
| xelatex -shell-escape compile-test.tex | ||
| xelatex -shell-escape compile-test.tex | ||
|
|
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| %! Author = srinaldi | ||
| %! Date = 9/24/2024 | ||
|
|
||
| % Preamble | ||
| \documentclass[12pt]{book} | ||
|
|
||
| % Packages | ||
| \usepackage{amsmath} | ||
| \usepackage[toc]{glossaries} | ||
| \usepackage[automake]{glossaries-extra} | ||
| \usepackage{gitinfo2} | ||
| \usepackage{hyperref} | ||
| \usepackage{fancyhdr} | ||
| \usepackage{enumitem} | ||
| \usepackage{longtable} | ||
|
|
||
| % Glossary settings / loading | ||
| \loadglsentries[\acronymtype]{combined_acronyms.tex} | ||
| \loadglsentries[term]{glossaries.tex} | ||
| \makeglossaries | ||
|
|
||
| % Set Variables | ||
| \def\title{LaTeX Compiling Test} | ||
| \def\subtitle{Verifying acronyms and glossaries entries made in .tex files compile correctly.} | ||
| \def\repourl{\url{https://github.com/uasal/acronyms/tree/main}} | ||
|
|
||
| \edef\masterBranch{\detokenize{master}} | ||
| \edef\gitBranch{\gitBranch} | ||
|
|
||
| % Setup internal link colors | ||
| \hypersetup{% | ||
| colorlinks=true, | ||
| linkcolor=blue, | ||
| urlcolor=blue, | ||
| filecolor=blue, | ||
| linktoc=all, | ||
| citecolor=blue, | ||
| } | ||
|
|
||
|
|
||
| % Pagestyles | ||
| \cfoot{\thepage\n } | ||
| \pagestyle{fancy} | ||
| \fancyhf{} | ||
| \fancyhead[LE,RO]{Rev: \gitAbbrevHash- \gitDirty\, \gitCommitterDate} | ||
| \fancyhead[RE,LO]{LaTeX Acronyms \& Terms, Page \thepage} | ||
| \fancyfoot[CE,CO]{\rightmark} | ||
| \setlength{\headheight}{14.49998pt} | ||
| \addtolength{\topmargin}{-2.49998pt} | ||
| %\fancyfoot[LE,RO]{} | ||
| \topskip0pt | ||
|
|
||
|
|
||
| % Document | ||
| \begin{document} | ||
|
|
||
| % Making Title Page | ||
| \renewcommand{\maketitle}{ | ||
| \pagestyle{empty} | ||
| \thispagestyle{empty} | ||
| %--- Make title page | ||
| \begin{center} | ||
| \vspace{0.5cm} \mbox{}\hrulefill \mbox{}\\[1cm] | ||
| {\Huge \textbf{\title}\\[1cm]} | ||
| {\LARGE \textit{\subtitle}}\\[2cm] | ||
| %{\small \textbf{Teledoc Link: }\textit{\teledoc}}\\[0.3cm] | ||
| {\small \textbf{Repository: }\textit{\repourl}}\\[0.5cm] | ||
| {\small \textbf{Branch: } \gitBranch} | ||
| {\small \textbf{ | Commit:} \gitDescribe}\\[0.5cm] | ||
| %{\small \textit{\access}} \vfill | ||
| {\small \mbox{}\hrulefill\mbox{}\\[10mm]} | ||
| \footnote{{ Revision: \gitAbbrevHash - \gitDirty\ Date: \gitCommitterDate}} | ||
| \end{center} | ||
| \pagestyle{fancy} | ||
| } | ||
|
|
||
| \maketitle | ||
| \newpage | ||
|
|
||
| \setcounter{secnumdepth}{4} | ||
| \setcounter{tocdepth}{2} | ||
| \tableofcontents | ||
|
|
||
| \chapter{Overview} | ||
| Testing acronyms and glossary entries. | ||
|
|
||
| \chapter{List of Terms and Abbreviations} | ||
| \setglossarysection{section} | ||
| \printglossary[type=\acronymtype] | ||
| \printglossary[type=term] | ||
| %\printglossary[type=\acronymtype] | ||
| %\glsaddallunused[\acronymtype] | ||
|
|
||
| Fin. | ||
|
|
||
| \end{document} |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| #!/bin/sh | ||
| # Copyright 2015 Brent Longborough | ||
| # Part of gitinfo2 package Version 2 | ||
| # Release 2.0.7 2015-11-22 | ||
| # Please read gitinfo2.pdf for licencing and other details | ||
| # ----------------------------------------------------- | ||
| # Post-{commit,checkout,merge} hook for the gitinfo2 package | ||
| # | ||
| # Get the first tag found in the history from the current HEAD | ||
| FIRSTTAG=$(git describe --tags --always --dirty='-*' 2>/dev/null) | ||
| # Get the first tag in history that looks like a Release | ||
| RELTAG=$(git describe --tags --long --always --dirty='-*' --match 'v[0-9]*.*' 2>/dev/null) | ||
| # Hoover up the metadata | ||
| git --no-pager log -1 --date=short --decorate=short \ | ||
| --pretty=format:"\usepackage[% | ||
| shash={%h}, | ||
| lhash={%H}, | ||
| authname={%an}, | ||
| authemail={%ae}, | ||
| authsdate={%ad}, | ||
| authidate={%ai}, | ||
| authudate={%at}, | ||
| commname={%cn}, | ||
| commemail={%ce}, | ||
| commsdate={%cd}, | ||
| commidate={%ci}, | ||
| commudate={%ct}, | ||
| refnames={%d}, | ||
| firsttagdescribe={$FIRSTTAG}, | ||
| reltag={$RELTAG} | ||
| ]{gitexinfo}" HEAD > .git/gitHeadInfo.gin |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| %! Author = srinaldi | ||
| %! Date = 2024-09-23 | ||
|
|
||
| % For recording terms and definitions (separate from acronyms) to be used in latex generating repositories or for reference. | ||
| % Use the following command for adding a new term to the glossary: | ||
| % \newglossaryentry{term}{type={term},name={term},description={term description}} | ||
|
|
||
| \newglossaryentry{assembly} | ||
| { | ||
| type={term}, | ||
| name={assembly}, | ||
| description={A functional subdivision of a component, consisting of parts or subassemblies, which perform functions necessary for the operation of the component as a whole. Examples: regulator assembly, power amplifier assembly, gyro assembly, etc.} | ||
| } | ||
| \newglossaryentry{cheater plug} | ||
| { | ||
| type={term}, | ||
| name={cheater plug}, | ||
| description={An Alternating Current \gls{AC} plug adapter used to connect a three-pronged plug to a two-pronged AC socket. It can be used to separate the ground wire from the socket for testing purposes.} | ||
| } | ||
| \newglossaryentry{component} | ||
| { | ||
| type={term}, | ||
| name={component}, | ||
| description={A functional subdivision of a system, generally a self-contained combination of assemblies performing a function necessary for the system's operation. Examples: power supply, transmitter, gyro package, etc.} | ||
| } | ||
| \newglossaryentry{conductive material}{type={term},name={conductive material},description={A material that has a surface resistivity of <105 ohms per square or a volume resistivity <104 ohms-cm.}} | ||
| \newglossaryentry{electrostatic discharge (ESD)}{type={term},name={electrostatic discharge},description={A transfer of electrostatic charge between bodies at different electrostatic potentials caused by direct contact or induced by an electrostatic field.}} | ||
| \newglossaryentry{ESD-Protective Material}{type={term},name={ESD-Protective Material},description={Material capable of one or more of the following functions: limiting the generation of static electricity; safely dissipating electrostatic charges over its surface or volume; or providing shielding from ESD spark discharge or electrostatic fields.}} | ||
| \newglossaryentry{ESD Protected Area}{type={term},name={ESD Protected Area},description={An area that is constructed and equipped with the necessary ESD-protective materials and equipment to limit ESD voltage below the sensitivity level of ESDS items handled therein. This may include benches, rooms or buildings.}} | ||
| \newglossaryentry{Kit}{type={term},name={Kit},description={A prepared package of parts with instructions for assembly and/or wiring a component or chassis.}} | ||
| \newglossaryentry{Operator}{type={term},name={Operator},description={An individual who is trained and certified to perform tasks in an ESD protected area.}} | ||
| \newglossaryentry{Part}{type={term},name={Part},description={An element of a component, assembly, or subassembly which is not normally subject to further subdivision or disassembly without destruction of its designed use, e.g., a module, Integrated Circuit (IC), resistor, etc.}} | ||
| \newglossaryentry{Soft Ground}{type={term},name={Soft Ground},description={A connection to ground through impedance sufficiently high to limit current flow to safe levels for personnel (normally 5 milliamperes). Impedance needed for a soft ground is dependent upon the voltage levels which could be contacted by personnel near the ground. By this definition a hard ground protected by a functional GFCI is considered a soft ground.}} | ||
| \newglossaryentry{Static Dissipative}{type={term},name={Static Dissipative},description={A property of a material having surface resistivity ≥105 but <1012 ohms per square or a volume resistivity ≥104 but <1011 ohms-cm.}} | ||
| \newglossaryentry{Surface Resistivity}{type={term},name={Surface Resistivity},description={The surface resistivity is an inverse measure of the conductivity of a material. Surface resistivity of a material is numerically equal to the surface resistance between two electrodes forming opposite sides of a square. The size of the square is immaterial. Surface resistivity applies to both surfaces and materials with constant volume conductivity and has the value of ohms per square.}} | ||
| \newglossaryentry{Triboelectric}{type={term},name={Triboelectric},description={Pertaining to electricity generated by friction.}} | ||
| \newglossaryentry{Electrostatic Field}{type={term},name={Electrostatic Field},description={A voltage gradient between an electrostatically charged surface and another surface of a different electrostatic potential.}} | ||
| \newglossaryentry{Ground}{type={term},name={Ground},description={A mass such as earth, a ship, or a vehicle hull, capable of supplying or accepting a large electrical charge.}} | ||
| \newglossaryentry{Groundable Point}{type={term},name={Groundable Point},description={Any point with low impedance to ground where grounding may be attached. Usually it is the common point ground.}} | ||
| \newglossaryentry{Hard Ground}{type={term},name={Hard Ground},description={A connection to earth ground either directly or through low impedance.}} | ||
| \newglossaryentry{Insulative Material}{type={term},name={Insulative Material},description={A material having a surface resistivity ≥1012 ohms/square or a volume resistivity ≥1011 ohms-cm.}} | ||
|
|