doc/wrs_failures: add index of snmp objects

Signed-off-by: Adam Wujek <adam.wujek@cern.ch>

doc/wrs_failures/Makefile

@@ -4,7 +4,7 @@ all : wrs_failures.pdf
 
 RELEASE = $(shell git describe --always --dirty)
 
-wrs_failures.pdf : wrs_failures.tex fail.tex intro.tex snmp_exports.tex
+wrs_failures.pdf : wrs_failures.tex fail.tex intro.tex snmp_exports.tex snmp_objects.tex
 	@echo '\\newcommand{\\gitrevinfo}{'$(RELEASE)'}' > revinfo.tex
 	pdflatex wrs_failures.tex
 	pdflatex wrs_failures.tex

doc/wrs_failures/wrs_failures.tex

@@ -22,6 +22,9 @@
 \definecolor{light-gray}{gray}{0.95}
 %\usepackage[firstpage]{draftwatermark}
 
+% for glossary
+% nopostdot - no dot at the end of index entires
+\usepackage[nogroupskip,nopostdot,counter=subsubsection]{glossaries}
 
 \usepackage{listings}
 \usepackage{cancel}
@@ -71,6 +74,102 @@
 \newcommand{\eqdelay}[1]{{\text{delay}}_{#1}}
 \newcommand{\eqasymm}{{\text{asymmetry}}}
 
+% for glossary, set way of sorting entries
+\makenoidxglossaries
+% don't bold entries, texttt them
+\renewcommand*{\glsnamefont}[1]{\texttt{\textmd{#1}}}
+
+\newglossary*{snmp_status}{SNMP's status objects}
+\newglossary*{snmp_expert}{SNMP's expert objects}
+\newglossary*{snmp_other}{Objects from other MIBs}
+
+% macro to add entires
+\newcommand{\snmpadd}[1]{
+  \texttt{\glspl{#1}}%
+}
+
+% helpers to add glossary entries
+% add space and dash to non empty strings. For descriptions.
+\newcommand{\descr}[1]{
+  \ifx&#1&%
+    %
+  \else% put fixed space
+    --\kern 0.33em#1
+  \fi
+}
+
+% {MIB}{parent}{object}{comment}
+\newcommand{\snmpentry}[5]{%
+  \ifx&#2&% if parameter 2 is empty don't add parent
+    \newglossaryentry{#1::#3}{%
+      type=#5,%
+      name={#3},%
+      plural={#1::#3},% used to display name not plural
+      description={\descr{#4}}%
+      }%
+  \else
+      \newglossaryentry{#1::#3}{%
+      type=#5,%
+      name={#3},%
+      description={\descr{#4}},%
+      plural={#1::#3},% used to display name not plural
+      parent={#1::#2}%
+      }%
+  \fi
+}
+
+% {MIB}{parent}{object}{comment}
+\newcommand{\snmpentrye}[4]{%
+  \snmpentry{#1}{#2}{#3}{#4}{snmp_expert}
+}
+
+% {MIB}{parent}{object}{comment}
+\newcommand{\snmpentrys}[4]{%
+  \snmpentry{#1}{#2}{#3}{#4}{snmp_status}
+}
+
+% command to add snmp objects from other MIBs
+% {MIB}{parent}{object}{comment}
+\newcommand{\snmpentryo}[4]{%
+  \snmpentry{#1}{#2}{#3}{#4}{snmp_other}
+}
+
+% load glossary definitions from snmp_objects.tex
+\loadglsentries{snmp_objects}
+
+% use \kern 0.33em instead of \space to have fixed width space
+\newglossarystyle{objtree}{%
+  \renewenvironment{theglossary}%
+    {\setlength{\parindent}{0pt}%
+     \setlength{\parskip}{0pt plus 0.3pt}}%
+    {}%
+  \renewcommand*{\glossaryheader}{}%
+  \renewcommand*{\glsgroupheading}[1]{}%
+  \renewcommand{\glossentry}[2]{%
+    \hangindent30pt\relax
+    \parindent0pt\relax
+    --\kern 0.33em\glsentryitem{##1}\glstreenamefmt{\glstarget{##1}{\glossentryname{##1}}}%
+    \ifglshassymbol{##1}{\kern 0.33em(\glossentrysymbol{##1})}{}%
+    \glossentrydesc{##1}\glspostdescription\kern 0.33em##2\par
+  }%
+  \renewcommand{\subglossentry}[3]{%
+    \hangindent##1\glstreeindent\relax
+    \addtolength{\hangindent}{30pt}
+    \parindent##1\glstreeindent\relax
+    --\kern 0.33em%
+    \ifnum##1=1\relax
+      \glssubentryitem{##2}%
+    \fi
+    \glstreenamefmt{\glstarget{##2}{\glossentryname{##2}}}%
+    \ifglshassymbol{##2}{\kern 0.33em(\glossentrysymbol{##2})}{}%
+    \glossentrydesc{##2}\glspostdescription\kern 0.33em##3\par
+  }%
+}
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 \begin{document}
 \setcounter{tocdepth}{2}
 \input{revinfo.tex}
@@ -110,4 +209,21 @@
 %\bibliographystyle{unsrt}
 %\bibliography{references}
 
+\newcommand{\ignore}[1]{}
+% print glossary index
+% SNMP status objects
+\printnoidxglossary[type=snmp_status,style=objtree,sort=def]
+% SNMP expert objects
+\printnoidxglossary[type=snmp_expert,style=objtree,sort=def]
+% other objects
+\printnoidxglossary[type=snmp_other,style=objtree,sort=def]
+
+% add not used entries, but don't display their's section
+% based on:
+% http://tex.stackexchange.com/questions/115635/glossaries-suppress-pages-when-using-glsaddall
+\forallglsentries{\thislabel}%
+{%
+  \ifglsused{\thislabel}{}{\glsadd[format=ignore]{\thislabel}}%
+}
+
 \end{document}