Revision 216bb34c
| b/docs/Makefile | ||
|---|---|---|
| 1 |
# Makefile for Sphinx documentation |
|
| 2 |
# |
|
| 3 |
|
|
| 4 |
# You can set these variables from the command line. |
|
| 5 |
SPHINXOPTS = |
|
| 6 |
SPHINXBUILD = sphinx-build |
|
| 7 |
PAPER = |
|
| 8 |
|
|
| 9 |
# Internal variables. |
|
| 10 |
PAPEROPT_a4 = -D latex_paper_size=a4 |
|
| 11 |
PAPEROPT_letter = -D latex_paper_size=letter |
|
| 12 |
ALLSPHINXOPTS = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source |
|
| 13 |
|
|
| 14 |
.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest |
|
| 15 |
|
|
| 16 |
help: |
|
| 17 |
@echo "Please use \`make <target>' where <target> is one of" |
|
| 18 |
@echo " html to make standalone HTML files" |
|
| 19 |
@echo " dirhtml to make HTML files named index.html in directories" |
|
| 20 |
@echo " pickle to make pickle files" |
|
| 21 |
@echo " json to make JSON files" |
|
| 22 |
@echo " htmlhelp to make HTML files and a HTML help project" |
|
| 23 |
@echo " qthelp to make HTML files and a qthelp project" |
|
| 24 |
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" |
|
| 25 |
@echo " changes to make an overview of all changed/added/deprecated items" |
|
| 26 |
@echo " linkcheck to check all external links for integrity" |
|
| 27 |
@echo " doctest to run all doctests embedded in the documentation (if enabled)" |
|
| 28 |
|
|
| 29 |
clean: |
|
| 30 |
-rm -rf build/* |
|
| 31 |
|
|
| 32 |
html: |
|
| 33 |
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html |
|
| 34 |
@echo |
|
| 35 |
@echo "Build finished. The HTML pages are in build/html." |
|
| 36 |
|
|
| 37 |
dirhtml: |
|
| 38 |
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) build/dirhtml |
|
| 39 |
@echo |
|
| 40 |
@echo "Build finished. The HTML pages are in build/dirhtml." |
|
| 41 |
|
|
| 42 |
pickle: |
|
| 43 |
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle |
|
| 44 |
@echo |
|
| 45 |
@echo "Build finished; now you can process the pickle files." |
|
| 46 |
|
|
| 47 |
json: |
|
| 48 |
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) build/json |
|
| 49 |
@echo |
|
| 50 |
@echo "Build finished; now you can process the JSON files." |
|
| 51 |
|
|
| 52 |
htmlhelp: |
|
| 53 |
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp |
|
| 54 |
@echo |
|
| 55 |
@echo "Build finished; now you can run HTML Help Workshop with the" \ |
|
| 56 |
".hhp project file in build/htmlhelp." |
|
| 57 |
|
|
| 58 |
qthelp: |
|
| 59 |
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) build/qthelp |
|
| 60 |
@echo |
|
| 61 |
@echo "Build finished; now you can run "qcollectiongenerator" with the" \ |
|
| 62 |
".qhcp project file in build/qthelp, like this:" |
|
| 63 |
@echo "# qcollectiongenerator build/qthelp/ncclient.qhcp" |
|
| 64 |
@echo "To view the help file:" |
|
| 65 |
@echo "# assistant -collectionFile build/qthelp/ncclient.qhc" |
|
| 66 |
|
|
| 67 |
latex: |
|
| 68 |
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex |
|
| 69 |
@echo |
|
| 70 |
@echo "Build finished; the LaTeX files are in build/latex." |
|
| 71 |
@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ |
|
| 72 |
"run these through (pdf)latex." |
|
| 73 |
|
|
| 74 |
changes: |
|
| 75 |
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes |
|
| 76 |
@echo |
|
| 77 |
@echo "The overview file is in build/changes." |
|
| 78 |
|
|
| 79 |
linkcheck: |
|
| 80 |
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck |
|
| 81 |
@echo |
|
| 82 |
@echo "Link check complete; look for any errors in the above output " \ |
|
| 83 |
"or in build/linkcheck/output.txt." |
|
| 84 |
|
|
| 85 |
doctest: |
|
| 86 |
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) build/doctest |
|
| 87 |
@echo "Testing of doctests in the sources finished, look at the " \ |
|
| 88 |
"results in build/doctest/output.txt." |
|
| b/docs/build/latex/Makefile | ||
|---|---|---|
| 1 |
# Makefile for Sphinx LaTeX output |
|
| 2 |
|
|
| 3 |
ALLDOCS = $(basename $(wildcard *.tex)) |
|
| 4 |
ALLPDF = $(addsuffix .pdf,$(ALLDOCS)) |
|
| 5 |
ALLDVI = $(addsuffix .dvi,$(ALLDOCS)) |
|
| 6 |
|
|
| 7 |
# Prefix for archive names |
|
| 8 |
ARCHIVEPRREFIX = |
|
| 9 |
# Additional LaTeX options |
|
| 10 |
LATEXOPTS = |
|
| 11 |
|
|
| 12 |
all: $(ALLPDF) |
|
| 13 |
all-pdf: $(ALLPDF) |
|
| 14 |
all-dvi: $(ALLDVI) |
|
| 15 |
all-ps: all-dvi |
|
| 16 |
for f in *.dvi; do dvips $$f; done |
|
| 17 |
|
|
| 18 |
zip: all-$(FMT) |
|
| 19 |
mkdir $(ARCHIVEPREFIX)docs-$(FMT) |
|
| 20 |
cp $(ALLPDF) $(ARCHIVEPREFIX)docs-$(FMT) |
|
| 21 |
zip -q -r -9 $(ARCHIVEPREFIX)docs-$(FMT).zip $(ARCHIVEPREFIX)docs-$(FMT) |
|
| 22 |
rm -r $(ARCHIVEPREFIX)docs-$(FMT) |
|
| 23 |
|
|
| 24 |
tar: all-$(FMT) |
|
| 25 |
mkdir $(ARCHIVEPREFIX)docs-$(FMT) |
|
| 26 |
cp $(ALLPDF) $(ARCHIVEPREFIX)docs-$(FMT) |
|
| 27 |
tar cf $(ARCHIVEPREFIX)docs-$(FMT).tar $(ARCHIVEPREFIX)docs-$(FMT) |
|
| 28 |
rm -r $(ARCHIVEPREFIX)docs-$(FMT) |
|
| 29 |
|
|
| 30 |
bz2: tar |
|
| 31 |
bzip2 -9 -k $(ARCHIVEPREFIX)docs-$(FMT).tar |
|
| 32 |
|
|
| 33 |
# The number of LaTeX runs is quite conservative, but I don't expect it |
|
| 34 |
# to get run often, so the little extra time won't hurt. |
|
| 35 |
%.dvi: %.tex |
|
| 36 |
latex $(LATEXOPTS) '$<' |
|
| 37 |
latex $(LATEXOPTS) '$<' |
|
| 38 |
latex $(LATEXOPTS) '$<' |
|
| 39 |
-makeindex -s python.ist '$(basename $<).idx' |
|
| 40 |
-makeindex -s python.ist '$(basename mod$<).idx' |
|
| 41 |
latex $(LATEXOPTS) '$<' |
|
| 42 |
latex $(LATEXOPTS) '$<' |
|
| 43 |
|
|
| 44 |
%.pdf: %.tex |
|
| 45 |
pdflatex $(LATEXOPTS) '$<' |
|
| 46 |
pdflatex $(LATEXOPTS) '$<' |
|
| 47 |
pdflatex $(LATEXOPTS) '$<' |
|
| 48 |
-makeindex -s python.ist '$(basename $<).idx' |
|
| 49 |
-makeindex -s python.ist '$(basename mod$<).idx' |
|
| 50 |
pdflatex $(LATEXOPTS) '$<' |
|
| 51 |
pdflatex $(LATEXOPTS) '$<' |
|
| 52 |
|
|
| 53 |
clean: |
|
| 54 |
rm -f *.pdf *.dvi *.ps |
|
| 55 |
rm -f *.log *.ind *.aux *.toc *.syn *.idx *.out *.ilg *.pla |
|
| 56 |
|
|
| 57 |
.PHONY: all all-pdf all-dvi all-ps clean |
|
| 58 |
|
|
| b/docs/build/latex/fncychap.sty | ||
|---|---|---|
| 1 |
%%% Copyright Ulf A. Lindgren |
|
| 2 |
%%% |
|
| 3 |
%%% Note Premission is granted to modify this file under |
|
| 4 |
%%% the condition that it is saved using another |
|
| 5 |
%%% file and package name. |
|
| 6 |
%%% |
|
| 7 |
%%% Revision 1.1 (1997) |
|
| 8 |
%%% |
|
| 9 |
%%% Jan. 8th Modified package name base date option |
|
| 10 |
%%% Jan. 22th Modified FmN and FmTi for error in book.cls |
|
| 11 |
%%% \MakeUppercase{#}->{\MakeUppercase#}
|
|
| 12 |
%%% Apr. 6th Modified Lenny option to prevent undesired |
|
| 13 |
%%% skip of line. |
|
| 14 |
%%% Nov. 8th Fixed \@chapapp for AMS |
|
| 15 |
%%% |
|
| 16 |
%%% Revision 1.2 (1998) |
|
| 17 |
%%% |
|
| 18 |
%%% Feb. 11th Fixed appendix problem related to Bjarne |
|
| 19 |
%%% Aug. 11th Fixed problem related to 11pt and 12pt |
|
| 20 |
%%% suggested by Tomas Lundberg. THANKS! |
|
| 21 |
%%% |
|
| 22 |
%%% Revision 1.3 (2004) |
|
| 23 |
%%% Sep. 20th problem with frontmatter, mainmatter and |
|
| 24 |
%%% backmatter, pointed out by Lapo Mori |
|
| 25 |
%%% |
|
| 26 |
%%% Revision 1.31 (2004) |
|
| 27 |
%%% Sep. 21th problem with the Rejne definition streched text |
|
| 28 |
%%% caused ugly gaps in the vrule aligned with the title |
|
| 29 |
%%% text. Kindly pointed out to me by Hendri Adriaens |
|
| 30 |
%%% |
|
| 31 |
%%% Revision 1.32 (2005) |
|
| 32 |
%%% Jun. 23th compatibility problem with the KOMA class 'scrbook.cls' |
|
| 33 |
%%% a remedy is a redefinition of '\@schapter' in |
|
| 34 |
%%% line with that used in KOMA. The problem was pointed |
|
| 35 |
%%% out to me by Mikkel Holm Olsen |
|
| 36 |
%%% |
|
| 37 |
%%% Revision 1.33 (2005) |
|
| 38 |
%%% Aug. 9th misspelled ``TWELV'' corrected, the error was pointed |
|
| 39 |
%%% out to me by George Pearson |
|
| 40 |
%%% |
|
| 41 |
%%% Revision 1.34 (2007) |
|
| 42 |
%%% Added an alternative to Lenny provided by Peter |
|
| 43 |
%%% Osborne (2005-11-28) |
|
| 44 |
%%% Corrected front, main and back matter, based on input |
|
| 45 |
%%% from Bas van Gils (2006-04-24) |
|
| 46 |
%%% Jul. 30th Added Bjornstrup option provided by Jean-Marc |
|
| 47 |
%%% Francois (2007-01-05). |
|
| 48 |
%%% Reverted to \MakeUppercase{#} see rev 1.1, solved
|
|
| 49 |
%%% problem with MakeUppercase and MakeLowercase pointed |
|
| 50 |
%%% out by Marco Feuerstein (2007-06-06) |
|
| 51 |
|
|
| 52 |
|
|
| 53 |
%%% Last modified Jul. 2007 |
|
| 54 |
|
|
| 55 |
\NeedsTeXFormat{LaTeX2e}[1995/12/01]
|
|
| 56 |
\ProvidesPackage{fncychap}
|
|
| 57 |
[2007/07/30 v1.34 |
|
| 58 |
LaTeX package (Revised chapters)] |
|
| 59 |
|
|
| 60 |
%%%% For conditional inclusion of color |
|
| 61 |
\newif\ifusecolor |
|
| 62 |
\usecolorfalse |
|
| 63 |
|
|
| 64 |
|
|
| 65 |
|
|
| 66 |
%%%% DEFINITION OF Chapapp variables |
|
| 67 |
\newcommand{\CNV}{\huge\bfseries}
|
|
| 68 |
\newcommand{\ChNameVar}[1]{\renewcommand{\CNV}{#1}}
|
|
| 69 |
|
|
| 70 |
|
|
| 71 |
%%%% DEFINITION OF TheChapter variables |
|
| 72 |
\newcommand{\CNoV}{\huge\bfseries}
|
|
| 73 |
\newcommand{\ChNumVar}[1]{\renewcommand{\CNoV}{#1}}
|
|
| 74 |
|
|
| 75 |
\newif\ifUCN |
|
| 76 |
\UCNfalse |
|
| 77 |
\newif\ifLCN |
|
| 78 |
\LCNfalse |
|
| 79 |
\def\ChNameLowerCase{\LCNtrue\UCNfalse}
|
|
| 80 |
\def\ChNameUpperCase{\UCNtrue\LCNfalse}
|
|
| 81 |
\def\ChNameAsIs{\UCNfalse\LCNfalse}
|
|
| 82 |
|
|
| 83 |
%%%%% Fix for AMSBook 971008 |
|
| 84 |
|
|
| 85 |
\@ifundefined{@chapapp}{\let\@chapapp\chaptername}{}
|
|
| 86 |
|
|
| 87 |
|
|
| 88 |
%%%%% Fix for Bjarne and appendix 980211 |
|
| 89 |
|
|
| 90 |
\newif\ifinapp |
|
| 91 |
\inappfalse |
|
| 92 |
\renewcommand\appendix{\par
|
|
| 93 |
\setcounter{chapter}{0}%
|
|
| 94 |
\setcounter{section}{0}%
|
|
| 95 |
\inapptrue% |
|
| 96 |
\renewcommand\@chapapp{\appendixname}%
|
|
| 97 |
\renewcommand\thechapter{\@Alph\c@chapter}}
|
|
| 98 |
|
|
| 99 |
%%%%% Fix for frontmatter, mainmatter, and backmatter 040920 |
|
| 100 |
|
|
| 101 |
\@ifundefined{@mainmatter}{\newif\if@mainmatter \@mainmattertrue}{}
|
|
| 102 |
|
|
| 103 |
%%%%% |
|
| 104 |
|
|
| 105 |
|
|
| 106 |
|
|
| 107 |
\newcommand{\FmN}[1]{%
|
|
| 108 |
\ifUCN |
|
| 109 |
{\MakeUppercase{#1}}\LCNfalse
|
|
| 110 |
\else |
|
| 111 |
\ifLCN |
|
| 112 |
{\MakeLowercase{#1}}\UCNfalse
|
|
| 113 |
\else #1 |
|
| 114 |
\fi |
|
| 115 |
\fi} |
|
| 116 |
|
|
| 117 |
|
|
| 118 |
%%%% DEFINITION OF Title variables |
|
| 119 |
\newcommand{\CTV}{\Huge\bfseries}
|
|
| 120 |
\newcommand{\ChTitleVar}[1]{\renewcommand{\CTV}{#1}}
|
|
| 121 |
|
|
| 122 |
%%%% DEFINITION OF the basic rule width |
|
| 123 |
\newlength{\RW}
|
|
| 124 |
\setlength{\RW}{1pt}
|
|
| 125 |
\newcommand{\ChRuleWidth}[1]{\setlength{\RW}{#1}}
|
|
| 126 |
|
|
| 127 |
\newif\ifUCT |
|
| 128 |
\UCTfalse |
|
| 129 |
\newif\ifLCT |
|
| 130 |
\LCTfalse |
|
| 131 |
\def\ChTitleLowerCase{\LCTtrue\UCTfalse}
|
|
| 132 |
\def\ChTitleUpperCase{\UCTtrue\LCTfalse}
|
|
| 133 |
\def\ChTitleAsIs{\UCTfalse\LCTfalse}
|
|
| 134 |
\newcommand{\FmTi}[1]{%
|
|
| 135 |
\ifUCT |
|
| 136 |
{\MakeUppercase{#1}}\LCTfalse
|
|
| 137 |
\else |
|
| 138 |
\ifLCT |
|
| 139 |
{\MakeLowercase{#1}}\UCTfalse
|
|
| 140 |
\else {#1}
|
|
| 141 |
\fi |
|
| 142 |
\fi} |
|
| 143 |
|
|
| 144 |
|
|
| 145 |
|
|
| 146 |
\newlength{\mylen}
|
|
| 147 |
\newlength{\myhi}
|
|
| 148 |
\newlength{\px}
|
|
| 149 |
\newlength{\py}
|
|
| 150 |
\newlength{\pyy}
|
|
| 151 |
\newlength{\pxx}
|
|
| 152 |
|
|
| 153 |
|
|
| 154 |
\def\mghrulefill#1{\leavevmode\leaders\hrule\@height #1\hfill\kern\z@}
|
|
| 155 |
|
|
| 156 |
\newcommand{\DOCH}{%
|
|
| 157 |
\CNV\FmN{\@chapapp}\space \CNoV\thechapter
|
|
| 158 |
\par\nobreak |
|
| 159 |
\vskip 20\p@ |
|
| 160 |
} |
|
| 161 |
\newcommand{\DOTI}[1]{%
|
|
| 162 |
\CTV\FmTi{#1}\par\nobreak
|
|
| 163 |
\vskip 40\p@ |
|
| 164 |
} |
|
| 165 |
\newcommand{\DOTIS}[1]{%
|
|
| 166 |
\CTV\FmTi{#1}\par\nobreak
|
|
| 167 |
\vskip 40\p@ |
|
| 168 |
} |
|
| 169 |
|
|
| 170 |
%%%%%% SONNY DEF |
|
| 171 |
|
|
| 172 |
\DeclareOption{Sonny}{%
|
|
| 173 |
\ChNameVar{\Large\sf}
|
|
| 174 |
\ChNumVar{\Huge}
|
|
| 175 |
\ChTitleVar{\Large\sf}
|
|
| 176 |
\ChRuleWidth{0.5pt}
|
|
| 177 |
\ChNameUpperCase |
|
| 178 |
\renewcommand{\DOCH}{%
|
|
| 179 |
\raggedleft |
|
| 180 |
\CNV\FmN{\@chapapp}\space \CNoV\thechapter
|
|
| 181 |
\par\nobreak |
|
| 182 |
\vskip 40\p@} |
|
| 183 |
\renewcommand{\DOTI}[1]{%
|
|
| 184 |
\CTV\raggedleft\mghrulefill{\RW}\par\nobreak
|
|
| 185 |
\vskip 5\p@ |
|
| 186 |
\CTV\FmTi{#1}\par\nobreak
|
|
| 187 |
\mghrulefill{\RW}\par\nobreak
|
|
| 188 |
\vskip 40\p@} |
|
| 189 |
\renewcommand{\DOTIS}[1]{%
|
|
| 190 |
\CTV\raggedleft\mghrulefill{\RW}\par\nobreak
|
|
| 191 |
\vskip 5\p@ |
|
| 192 |
\CTV\FmTi{#1}\par\nobreak
|
|
| 193 |
\mghrulefill{\RW}\par\nobreak
|
|
| 194 |
\vskip 40\p@} |
|
| 195 |
} |
|
| 196 |
|
|
| 197 |
%%%%%% LENNY DEF |
|
| 198 |
|
|
| 199 |
\DeclareOption{Lenny}{%
|
|
| 200 |
|
|
| 201 |
\ChNameVar{\fontsize{14}{16}\usefont{OT1}{phv}{m}{n}\selectfont}
|
|
| 202 |
\ChNumVar{\fontsize{60}{62}\usefont{OT1}{ptm}{m}{n}\selectfont}
|
|
| 203 |
\ChTitleVar{\Huge\bfseries\rm}
|
|
| 204 |
\ChRuleWidth{1pt}
|
|
| 205 |
\renewcommand{\DOCH}{%
|
|
| 206 |
\settowidth{\px}{\CNV\FmN{\@chapapp}}
|
|
| 207 |
\addtolength{\px}{2pt}
|
|
| 208 |
\settoheight{\py}{\CNV\FmN{\@chapapp}}
|
|
| 209 |
\addtolength{\py}{1pt}
|
|
| 210 |
|
|
| 211 |
\settowidth{\mylen}{\CNV\FmN{\@chapapp}\space\CNoV\thechapter}
|
|
| 212 |
\addtolength{\mylen}{1pt}
|
|
| 213 |
\settowidth{\pxx}{\CNoV\thechapter}
|
|
| 214 |
\addtolength{\pxx}{-1pt}
|
|
| 215 |
|
|
| 216 |
\settoheight{\pyy}{\CNoV\thechapter}
|
|
| 217 |
\addtolength{\pyy}{-2pt}
|
|
| 218 |
\setlength{\myhi}{\pyy}
|
|
| 219 |
\addtolength{\myhi}{-1\py}
|
|
| 220 |
\par |
|
| 221 |
\parbox[b]{\textwidth}{%
|
|
| 222 |
\rule[\py]{\RW}{\myhi}%
|
|
| 223 |
\hskip -\RW% |
|
| 224 |
\rule[\pyy]{\px}{\RW}%
|
|
| 225 |
\hskip -\px% |
|
| 226 |
\raggedright% |
|
| 227 |
\CNV\FmN{\@chapapp}\space\CNoV\thechapter%
|
|
| 228 |
\hskip1pt% |
|
| 229 |
\mghrulefill{\RW}%
|
|
| 230 |
\rule{\RW}{\pyy}\par\nobreak%
|
|
| 231 |
\vskip -\baselineskip% |
|
| 232 |
\vskip -\pyy% |
|
| 233 |
\hskip \mylen% |
|
| 234 |
\mghrulefill{\RW}\par\nobreak%
|
|
| 235 |
\vskip \pyy}% |
|
| 236 |
\vskip 20\p@} |
|
| 237 |
|
|
| 238 |
|
|
| 239 |
\renewcommand{\DOTI}[1]{%
|
|
| 240 |
\raggedright |
|
| 241 |
\CTV\FmTi{#1}\par\nobreak
|
|
| 242 |
\vskip 40\p@} |
|
| 243 |
|
|
| 244 |
\renewcommand{\DOTIS}[1]{%
|
|
| 245 |
\raggedright |
|
| 246 |
\CTV\FmTi{#1}\par\nobreak
|
|
| 247 |
\vskip 40\p@} |
|
| 248 |
} |
|
| 249 |
|
|
| 250 |
%%%%%% Peter Osbornes' version of LENNY DEF |
|
| 251 |
|
|
| 252 |
\DeclareOption{PetersLenny}{%
|
|
| 253 |
|
|
| 254 |
% five new lengths |
|
| 255 |
\newlength{\bl} % bottom left : orig \space
|
|
| 256 |
\setlength{\bl}{6pt}
|
|
| 257 |
\newcommand{\BL}[1]{\setlength{\bl}{#1}}
|
|
| 258 |
\newlength{\br} % bottom right : orig 1pt
|
|
| 259 |
\setlength{\br}{1pt}
|
|
| 260 |
\newcommand{\BR}[1]{\setlength{\br}{#1}}
|
|
| 261 |
\newlength{\tl} % top left : orig 2pt
|
|
| 262 |
\setlength{\tl}{2pt}
|
|
| 263 |
\newcommand{\TL}[1]{\setlength{\tl}{#1}}
|
|
| 264 |
\newlength{\trr} % top right :orig 1pt
|
|
| 265 |
\setlength{\trr}{1pt}
|
|
| 266 |
\newcommand{\TR}[1]{\setlength{\trr}{#1}}
|
|
| 267 |
\newlength{\blrule} % top right :orig 1pt
|
|
| 268 |
\setlength{\trr}{0pt}
|
|
| 269 |
\newcommand{\BLrule}[1]{\setlength{\blrule}{#1}}
|
|
| 270 |
|
|
| 271 |
|
|
| 272 |
\ChNameVar{\fontsize{14}{16}\usefont{OT1}{phv}{m}{n}\selectfont}
|
|
| 273 |
\ChNumVar{\fontsize{60}{62}\usefont{OT1}{ptm}{m}{n}\selectfont}
|
|
| 274 |
\ChTitleVar{\Huge\bfseries\rm}
|
|
| 275 |
\ChRuleWidth{1pt}
|
|
| 276 |
\renewcommand{\DOCH}{%
|
|
| 277 |
|
|
| 278 |
|
|
| 279 |
%%%%%%% tweaks for 1--9 and A--Z |
|
| 280 |
\ifcase\c@chapter\relax% |
|
| 281 |
\or\BL{-3pt}\TL{-4pt}\BR{0pt}\TR{-6pt}%1
|
|
| 282 |
\or\BL{0pt}\TL{-4pt}\BR{2pt}\TR{-4pt}%2
|
|
| 283 |
\or\BL{0pt}\TL{-4pt}\BR{2pt}\TR{-4pt}%3
|
|
| 284 |
\or\BL{0pt}\TL{5pt}\BR{2pt}\TR{-4pt}%4
|
|
| 285 |
\or\BL{0pt}\TL{3pt}\BR{2pt}\TR{-4pt}%5
|
|
| 286 |
\or\BL{-1pt}\TL{0pt}\BR{2pt}\TR{-2pt}%6
|
|
| 287 |
\or\BL{0pt}\TL{-3pt}\BR{2pt}\TR{-2pt}%7
|
|
| 288 |
\or\BL{0pt}\TL{-3pt}\BR{2pt}\TR{-2pt}%8
|
|
| 289 |
\or\BL{0pt}\TL{-3pt}\BR{-4pt}\TR{-2pt}%9
|
|
| 290 |
\or\BL{-3pt}\TL{-3pt}\BR{2pt}\TR{-7pt}%10
|
|
| 291 |
\or\BL{-6pt}\TL{-6pt}\BR{0pt}\TR{-9pt}%11
|
|
| 292 |
\or\BL{-6pt}\TL{-6pt}\BR{2pt}\TR{-7pt}%12
|
|
| 293 |
\or\BL{-5pt}\TL{-5pt}\BR{0pt}\TR{-9pt}%13
|
|
| 294 |
\or\BL{-6pt}\TL{-6pt}\BR{0pt}\TR{-9pt}%14
|
|
| 295 |
\or\BL{-3pt}\TL{-3pt}\BR{3pt}\TR{-6pt}%15
|
|
| 296 |
\or\BL{-3pt}\TL{-3pt}\BR{3pt}\TR{-6pt}%16
|
|
| 297 |
\or\BL{-5pt}\TL{-3pt}\BR{-8pt}\TR{-6pt}%17
|
|
| 298 |
\or\BL{-5pt}\TL{-5pt}\BR{0pt}\TR{-9pt}%18
|
|
| 299 |
\or\BL{-3pt}\TL{-3pt}\BR{-6pt}\TR{-9pt}%19
|
|
| 300 |
\or\BL{0pt}\TL{0pt}\BR{0pt}\TR{-5pt}%20
|
|
| 301 |
\fi |
|
| 302 |
|
|
| 303 |
\ifinapp\ifcase\c@chapter\relax% |
|
| 304 |
\or\BL{0pt}\TL{14pt}\BR{5pt}\TR{-19pt}%A
|
|
| 305 |
\or\BL{0pt}\TL{-5pt}\BR{-3pt}\TR{-8pt}%B
|
|
| 306 |
\or\BL{-3pt}\TL{-2pt}\BR{1pt}\TR{-6pt}\BLrule{0pt}%C
|
|
| 307 |
\or\BL{0pt}\TL{-5pt}\BR{-3pt}\TR{-8pt}\BLrule{0pt}%D
|
|
| 308 |
\or\BL{0pt}\TL{-5pt}\BR{2pt}\TR{-3pt}%E
|
|
| 309 |
\or\BL{0pt}\TL{-5pt}\BR{-10pt}\TR{-1pt}%F
|
|
| 310 |
\or\BL{-3pt}\TL{0pt}\BR{0pt}\TR{-7pt}%G
|
|
| 311 |
\or\BL{0pt}\TL{-5pt}\BR{3pt}\TR{-1pt}%H
|
|
| 312 |
\or\BL{0pt}\TL{-5pt}\BR{3pt}\TR{-1pt}%I
|
|
| 313 |
\or\BL{2pt}\TL{0pt}\BR{-3pt}\TR{1pt}%J
|
|
| 314 |
\or\BL{0pt}\TL{-5pt}\BR{3pt}\TR{-1pt}%K
|
|
| 315 |
\or\BL{0pt}\TL{-5pt}\BR{2pt}\TR{-19pt}%L
|
|
| 316 |
\or\BL{0pt}\TL{-5pt}\BR{3pt}\TR{-1pt}%M
|
|
| 317 |
\or\BL{0pt}\TL{-5pt}\BR{-2pt}\TR{-1pt}%N
|
|
| 318 |
\or\BL{-3pt}\TL{-2pt}\BR{-3pt}\TR{-11pt}%O
|
|
| 319 |
\or\BL{0pt}\TL{-5pt}\BR{-9pt}\TR{-3pt}%P
|
|
| 320 |
\or\BL{-3pt}\TL{-2pt}\BR{-3pt}\TR{-11pt}%Q
|
|
| 321 |
\or\BL{0pt}\TL{-5pt}\BR{4pt}\TR{-8pt}%R
|
|
| 322 |
\or\BL{-2pt}\TL{-2pt}\BR{-2pt}\TR{-7pt}%S
|
|
| 323 |
\or\BL{-3pt}\TL{0pt}\BR{-5pt}\TR{4pt}\BLrule{8pt}%T
|
|
| 324 |
\or\BL{-7pt}\TL{-11pt}\BR{-5pt}\TR{-7pt}\BLrule{0pt}%U
|
|
| 325 |
\or\BL{-14pt}\TL{-5pt}\BR{-14pt}\TR{-1pt}\BLrule{14pt}%V
|
|
| 326 |
\or\BL{-10pt}\TL{-9pt}\BR{-13pt}\TR{-3pt}\BLrule{7pt}%W
|
|
| 327 |
\or\BL{0pt}\TL{-5pt}\BR{3pt}\TR{-1pt}\BLrule{0pt}%X
|
|
| 328 |
\or\BL{-6pt}\TL{-4pt}\BR{-7pt}\TR{1pt}\BLrule{7pt}%Y
|
|
| 329 |
\or\BL{0pt}\TL{-5pt}\BR{3pt}\TR{-1pt}\BLrule{0pt}%Z
|
|
| 330 |
\fi\fi |
|
| 331 |
%%%%%%% |
|
| 332 |
\settowidth{\px}{\CNV\FmN{\@chapapp}}
|
|
| 333 |
\addtolength{\px}{\tl} %MOD change 2pt to \tl
|
|
| 334 |
\settoheight{\py}{\CNV\FmN{\@chapapp}}
|
|
| 335 |
\addtolength{\py}{1pt}
|
|
| 336 |
|
|
| 337 |
\settowidth{\mylen}{\CNV\FmN{\@chapapp}\space\CNoV\thechapter}
|
|
| 338 |
\addtolength{\mylen}{\trr}% MOD change 1pt to \tr
|
|
| 339 |
\settowidth{\pxx}{\CNoV\thechapter}
|
|
| 340 |
\addtolength{\pxx}{-1pt}
|
|
| 341 |
|
|
| 342 |
\settoheight{\pyy}{\CNoV\thechapter}
|
|
| 343 |
\addtolength{\pyy}{-2pt}
|
|
| 344 |
\setlength{\myhi}{\pyy}
|
|
| 345 |
\addtolength{\myhi}{-1\py}
|
|
| 346 |
\par |
|
| 347 |
\parbox[b]{\textwidth}{%
|
|
| 348 |
\rule[\py]{\RW}{\myhi}%
|
|
| 349 |
\hskip -\RW% |
|
| 350 |
\rule[\pyy]{\px}{\RW}%
|
|
| 351 |
\hskip -\px% |
|
| 352 |
\raggedright% |
|
| 353 |
\CNV\FmN{\@chapapp}\rule{\blrule}{\RW}\hskip\bl\CNoV\thechapter%MOD
|
|
| 354 |
% \CNV\FmN{\@chapapp}\space\CNoV\thechapter %ORIGINAL
|
|
| 355 |
\hskip\br% %MOD 1pt to \br |
|
| 356 |
\mghrulefill{\RW}%
|
|
| 357 |
\rule{\RW}{\pyy}\par\nobreak%
|
|
| 358 |
\vskip -\baselineskip% |
|
| 359 |
\vskip -\pyy% |
|
| 360 |
\hskip \mylen% |
|
| 361 |
\mghrulefill{\RW}\par\nobreak%
|
|
| 362 |
\vskip \pyy}% |
|
| 363 |
\vskip 20\p@} |
|
| 364 |
|
|
| 365 |
|
|
| 366 |
\renewcommand{\DOTI}[1]{%
|
|
| 367 |
\raggedright |
|
| 368 |
\CTV\FmTi{#1}\par\nobreak
|
|
| 369 |
\vskip 40\p@} |
|
| 370 |
|
|
| 371 |
\renewcommand{\DOTIS}[1]{%
|
|
| 372 |
\raggedright |
|
| 373 |
\CTV\FmTi{#1}\par\nobreak
|
|
| 374 |
\vskip 40\p@} |
|
| 375 |
} |
|
| 376 |
|
|
| 377 |
|
|
| 378 |
% |
|
| 379 |
|
|
| 380 |
|
|
| 381 |
%%%%%% BJORNSTRUP DEF |
|
| 382 |
|
|
| 383 |
\DeclareOption{Bjornstrup}{%
|
|
| 384 |
\usecolortrue |
|
| 385 |
% pzc (Zapf Chancelery) is nice. ppl (Palatino) is cool too. |
|
| 386 |
\ChNumVar{\fontsize{76}{80}\usefont{OT1}{pzc}{m}{n}\selectfont}
|
|
| 387 |
\ChTitleVar{\raggedleft\Large\sffamily\bfseries}
|
|
| 388 |
|
|
| 389 |
\setlength{\myhi}{10pt} % Space between grey box border and text
|
|
| 390 |
\setlength{\mylen}{\textwidth}
|
|
| 391 |
\addtolength{\mylen}{-2\myhi}
|
|
| 392 |
\renewcommand{\DOCH}{%
|
|
| 393 |
\settowidth{\py}{\CNoV\thechapter}
|
|
| 394 |
\addtolength{\py}{-10pt} % Amount of space by which the
|
|
| 395 |
% % number is shifted right |
|
| 396 |
\fboxsep=0pt% |
|
| 397 |
\colorbox[gray]{.85}{\rule{0pt}{40pt}\parbox[b]{\textwidth}{\hfill}}%
|
|
| 398 |
\kern-\py\raise20pt% |
|
| 399 |
\hbox{\color[gray]{.5}\CNoV\thechapter}\\%
|
|
| 400 |
} |
|
| 401 |
|
|
| 402 |
\renewcommand{\DOTI}[1]{%
|
|
| 403 |
\nointerlineskip\raggedright% |
|
| 404 |
\fboxsep=\myhi% |
|
| 405 |
\vskip-1ex% |
|
| 406 |
\colorbox[gray]{.85}{\parbox[t]{\mylen}{\CTV\FmTi{#1}}}\par\nobreak%
|
|
| 407 |
\vskip 40\p@% |
|
| 408 |
} |
|
| 409 |
|
|
| 410 |
\renewcommand{\DOTIS}[1]{%
|
|
| 411 |
\fboxsep=0pt |
|
| 412 |
\colorbox[gray]{.85}{\rule{0pt}{40pt}\parbox[b]{\textwidth}{\hfill}}\\%
|
|
| 413 |
\nointerlineskip\raggedright% |
|
| 414 |
\fboxsep=\myhi% |
|
| 415 |
\colorbox[gray]{.85}{\parbox[t]{\mylen}{\CTV\FmTi{#1}}}\par\nobreak%
|
|
| 416 |
\vskip 40\p@% |
|
| 417 |
} |
|
| 418 |
} |
|
| 419 |
|
|
| 420 |
|
|
| 421 |
%%%%%%% GLENN DEF |
|
| 422 |
|
|
| 423 |
|
|
| 424 |
\DeclareOption{Glenn}{%
|
|
| 425 |
\ChNameVar{\bfseries\Large\sf}
|
|
| 426 |
\ChNumVar{\Huge}
|
|
| 427 |
\ChTitleVar{\bfseries\Large\rm}
|
|
| 428 |
\ChRuleWidth{1pt}
|
|
| 429 |
\ChNameUpperCase |
|
| 430 |
\ChTitleUpperCase |
|
| 431 |
\renewcommand{\DOCH}{%
|
|
| 432 |
\settoheight{\myhi}{\CTV\FmTi{Test}}
|
|
| 433 |
\setlength{\py}{\baselineskip}
|
|
| 434 |
\addtolength{\py}{\RW}
|
|
| 435 |
\addtolength{\py}{\myhi}
|
|
| 436 |
\setlength{\pyy}{\py}
|
|
| 437 |
\addtolength{\pyy}{-1\RW}
|
|
| 438 |
|
|
| 439 |
\raggedright |
|
| 440 |
\CNV\FmN{\@chapapp}\space\CNoV\thechapter
|
|
| 441 |
\hskip 3pt\mghrulefill{\RW}\rule[-1\pyy]{2\RW}{\py}\par\nobreak}
|
|
| 442 |
|
|
| 443 |
\renewcommand{\DOTI}[1]{%
|
|
| 444 |
\addtolength{\pyy}{-4pt}
|
|
| 445 |
\settoheight{\myhi}{\CTV\FmTi{#1}}
|
|
| 446 |
\addtolength{\myhi}{\py}
|
|
| 447 |
\addtolength{\myhi}{-1\RW}
|
|
| 448 |
\vskip -1\pyy |
|
| 449 |
\rule{2\RW}{\myhi}\mghrulefill{\RW}\hskip 2pt
|
|
| 450 |
\raggedleft\CTV\FmTi{#1}\par\nobreak
|
|
| 451 |
\vskip 80\p@} |
|
| 452 |
|
|
| 453 |
\newlength{\backskip}
|
|
| 454 |
\renewcommand{\DOTIS}[1]{%
|
|
| 455 |
% \setlength{\py}{10pt}
|
|
| 456 |
% \setlength{\pyy}{\py}
|
|
| 457 |
% \addtolength{\pyy}{\RW}
|
|
| 458 |
% \setlength{\myhi}{\baselineskip}
|
|
| 459 |
% \addtolength{\myhi}{\pyy}
|
|
| 460 |
% \mghrulefill{\RW}\rule[-1\py]{2\RW}{\pyy}\par\nobreak
|
|
| 461 |
% \addtolength{}{}
|
|
| 462 |
%\vskip -1\baselineskip |
|
| 463 |
% \rule{2\RW}{\myhi}\mghrulefill{\RW}\hskip 2pt
|
|
| 464 |
% \raggedleft\CTV\FmTi{#1}\par\nobreak
|
|
| 465 |
% \vskip 60\p@} |
|
| 466 |
%% Fix suggested by Tomas Lundberg |
|
| 467 |
\setlength{\py}{25pt} % eller vad man vill
|
|
| 468 |
\setlength{\pyy}{\py}
|
|
| 469 |
\setlength{\backskip}{\py}
|
|
| 470 |
\addtolength{\backskip}{2pt}
|
|
| 471 |
\addtolength{\pyy}{\RW}
|
|
| 472 |
\setlength{\myhi}{\baselineskip}
|
|
| 473 |
\addtolength{\myhi}{\pyy}
|
|
| 474 |
\mghrulefill{\RW}\rule[-1\py]{2\RW}{\pyy}\par\nobreak
|
|
| 475 |
\vskip -1\backskip |
|
| 476 |
\rule{2\RW}{\myhi}\mghrulefill{\RW}\hskip 3pt %
|
|
| 477 |
\raggedleft\CTV\FmTi{#1}\par\nobreak
|
|
| 478 |
\vskip 40\p@} |
|
| 479 |
} |
|
| 480 |
|
|
| 481 |
%%%%%%% CONNY DEF |
|
| 482 |
|
|
| 483 |
\DeclareOption{Conny}{%
|
|
| 484 |
\ChNameUpperCase |
|
| 485 |
\ChTitleUpperCase |
|
| 486 |
\ChNameVar{\centering\Huge\rm\bfseries}
|
|
| 487 |
\ChNumVar{\Huge}
|
|
| 488 |
\ChTitleVar{\centering\Huge\rm}
|
|
| 489 |
\ChRuleWidth{2pt}
|
|
| 490 |
|
|
| 491 |
\renewcommand{\DOCH}{%
|
|
| 492 |
\mghrulefill{3\RW}\par\nobreak
|
|
| 493 |
\vskip -0.5\baselineskip |
|
| 494 |
\mghrulefill{\RW}\par\nobreak
|
|
| 495 |
\CNV\FmN{\@chapapp}\space \CNoV\thechapter
|
|
| 496 |
\par\nobreak |
|
| 497 |
\vskip -0.5\baselineskip |
|
| 498 |
} |
|
| 499 |
\renewcommand{\DOTI}[1]{%
|
|
| 500 |
\mghrulefill{\RW}\par\nobreak
|
|
| 501 |
\CTV\FmTi{#1}\par\nobreak
|
|
| 502 |
\vskip 60\p@ |
|
| 503 |
} |
|
| 504 |
\renewcommand{\DOTIS}[1]{%
|
|
| 505 |
\mghrulefill{\RW}\par\nobreak
|
|
| 506 |
\CTV\FmTi{#1}\par\nobreak
|
|
| 507 |
\vskip 60\p@ |
|
| 508 |
} |
|
| 509 |
} |
|
| 510 |
|
|
| 511 |
%%%%%%% REJNE DEF |
|
| 512 |
|
|
| 513 |
\DeclareOption{Rejne}{%
|
|
| 514 |
|
|
| 515 |
\ChNameUpperCase |
|
| 516 |
\ChTitleUpperCase |
|
| 517 |
\ChNameVar{\centering\Large\rm}
|
|
| 518 |
\ChNumVar{\Huge}
|
|
| 519 |
\ChTitleVar{\centering\Huge\rm}
|
|
| 520 |
\ChRuleWidth{1pt}
|
|
| 521 |
\renewcommand{\DOCH}{%
|
|
| 522 |
\settoheight{\py}{\CNoV\thechapter}
|
|
| 523 |
\parskip=0pt plus 1pt % Set parskip to default, just in case v1.31 |
|
| 524 |
\addtolength{\py}{-1pt}
|
|
| 525 |
\CNV\FmN{\@chapapp}\par\nobreak
|
|
| 526 |
\vskip 20\p@ |
|
| 527 |
\setlength{\myhi}{2\baselineskip}
|
|
| 528 |
\setlength{\px}{\myhi}
|
|
| 529 |
\addtolength{\px}{-1\RW}
|
|
| 530 |
\rule[-1\px]{\RW}{\myhi}\mghrulefill{\RW}\hskip
|
|
| 531 |
10pt\raisebox{-0.5\py}{\CNoV\thechapter}\hskip 10pt\mghrulefill{\RW}\rule[-1\px]{\RW}{\myhi}\par\nobreak
|
|
| 532 |
\vskip -3\p@% Added -2pt vskip to correct for streched text v1.31 |
|
| 533 |
} |
|
| 534 |
\renewcommand{\DOTI}[1]{%
|
|
| 535 |
\setlength{\mylen}{\textwidth}
|
|
| 536 |
\parskip=0pt plus 1pt % Set parskip to default, just in case v1.31 |
|
| 537 |
\addtolength{\mylen}{-2\RW}
|
|
| 538 |
{\vrule width\RW}\parbox{\mylen}{\CTV\FmTi{#1}}{\vrule width\RW}\par\nobreak%
|
|
| 539 |
\vskip -3pt\rule{\RW}{2\baselineskip}\mghrulefill{\RW}\rule{\RW}{2\baselineskip}%
|
|
| 540 |
\vskip 60\p@% Added -2pt in vskip to correct for streched text v1.31 |
|
| 541 |
} |
|
| 542 |
\renewcommand{\DOTIS}[1]{%
|
|
| 543 |
\setlength{\py}{\fboxrule}
|
|
| 544 |
\setlength{\fboxrule}{\RW}
|
|
| 545 |
\setlength{\mylen}{\textwidth}
|
|
| 546 |
\addtolength{\mylen}{-2\RW}
|
|
| 547 |
\fbox{\parbox{\mylen}{\vskip 2\baselineskip\CTV\FmTi{#1}\par\nobreak\vskip \baselineskip}}
|
|
| 548 |
\setlength{\fboxrule}{\py}
|
|
| 549 |
\vskip 60\p@ |
|
| 550 |
} |
|
| 551 |
} |
|
| 552 |
|
|
| 553 |
|
|
| 554 |
%%%%%%% BJARNE DEF |
|
| 555 |
|
|
| 556 |
\DeclareOption{Bjarne}{%
|
|
| 557 |
\ChNameUpperCase |
|
| 558 |
\ChTitleUpperCase |
|
| 559 |
\ChNameVar{\raggedleft\normalsize\rm}
|
|
| 560 |
\ChNumVar{\raggedleft \bfseries\Large}
|
|
| 561 |
\ChTitleVar{\raggedleft \Large\rm}
|
|
| 562 |
\ChRuleWidth{1pt}
|
|
| 563 |
|
|
| 564 |
|
|
| 565 |
%% Note thechapter -> c@chapter fix appendix bug |
|
| 566 |
%% Fixed misspelled 12 |
|
| 567 |
|
|
| 568 |
\newcounter{AlphaCnt}
|
|
| 569 |
\newcounter{AlphaDecCnt}
|
|
| 570 |
\newcommand{\AlphaNo}{%
|
|
| 571 |
\ifcase\number\theAlphaCnt |
|
| 572 |
\ifnum\c@chapter=0 |
|
| 573 |
ZERO\else{}\fi
|
|
| 574 |
\or ONE\or TWO\or THREE\or FOUR\or FIVE |
|
| 575 |
\or SIX\or SEVEN\or EIGHT\or NINE\or TEN |
|
| 576 |
\or ELEVEN\or TWELVE\or THIRTEEN\or FOURTEEN\or FIFTEEN |
|
| 577 |
\or SIXTEEN\or SEVENTEEN\or EIGHTEEN\or NINETEEN\fi |
|
| 578 |
} |
|
| 579 |
|
|
| 580 |
\newcommand{\AlphaDecNo}{%
|
|
| 581 |
\setcounter{AlphaDecCnt}{0}
|
|
| 582 |
\@whilenum\number\theAlphaCnt>0\do |
|
| 583 |
{\addtocounter{AlphaCnt}{-10}
|
|
| 584 |
\addtocounter{AlphaDecCnt}{1}}
|
|
| 585 |
\ifnum\number\theAlphaCnt=0 |
|
| 586 |
\else |
|
| 587 |
\addtocounter{AlphaDecCnt}{-1}
|
|
| 588 |
\addtocounter{AlphaCnt}{10}
|
|
| 589 |
\fi |
|
| 590 |
|
|
| 591 |
|
|
| 592 |
\ifcase\number\theAlphaDecCnt\or TEN\or TWENTY\or THIRTY\or |
|
| 593 |
FORTY\or FIFTY\or SIXTY\or SEVENTY\or EIGHTY\or NINETY\fi |
|
| 594 |
} |
|
| 595 |
\newcommand{\TheAlphaChapter}{%
|
|
| 596 |
|
|
| 597 |
\ifinapp |
|
| 598 |
\thechapter |
|
| 599 |
\else |
|
| 600 |
\setcounter{AlphaCnt}{\c@chapter}
|
|
| 601 |
\ifnum\c@chapter<20 |
|
| 602 |
\AlphaNo |
|
| 603 |
\else |
|
| 604 |
\AlphaDecNo\AlphaNo |
|
| 605 |
\fi |
|
| 606 |
\fi |
|
| 607 |
} |
|
| 608 |
\renewcommand{\DOCH}{%
|
|
| 609 |
\mghrulefill{\RW}\par\nobreak
|
|
| 610 |
\CNV\FmN{\@chapapp}\par\nobreak
|
|
| 611 |
\CNoV\TheAlphaChapter\par\nobreak |
|
| 612 |
\vskip -1\baselineskip\vskip 5pt\mghrulefill{\RW}\par\nobreak
|
|
| 613 |
\vskip 20\p@ |
|
| 614 |
} |
|
| 615 |
\renewcommand{\DOTI}[1]{%
|
|
| 616 |
\CTV\FmTi{#1}\par\nobreak
|
|
| 617 |
\vskip 40\p@ |
|
| 618 |
} |
|
| 619 |
\renewcommand{\DOTIS}[1]{%
|
|
| 620 |
\CTV\FmTi{#1}\par\nobreak
|
|
| 621 |
\vskip 40\p@ |
|
| 622 |
} |
|
| 623 |
} |
|
| 624 |
|
|
| 625 |
\DeclareOption*{%
|
|
| 626 |
\PackageWarning{fancychapter}{unknown style option}
|
|
| 627 |
} |
|
| 628 |
|
|
| 629 |
\ProcessOptions* \relax |
|
| 630 |
|
|
| 631 |
\ifusecolor |
|
| 632 |
\RequirePackage{color}
|
|
| 633 |
\fi |
|
| 634 |
\def\@makechapterhead#1{%
|
|
| 635 |
\vspace*{50\p@}%
|
|
| 636 |
{\parindent \z@ \raggedright \normalfont
|
|
| 637 |
\ifnum \c@secnumdepth >\m@ne |
|
| 638 |
\if@mainmatter%%%%% Fix for frontmatter, mainmatter, and backmatter 040920 |
|
| 639 |
\DOCH |
|
| 640 |
\fi |
|
| 641 |
\fi |
|
| 642 |
\interlinepenalty\@M |
|
| 643 |
\if@mainmatter%%%%% Fix for frontmatter, mainmatter, and backmatter 060424 |
|
| 644 |
\DOTI{#1}%
|
|
| 645 |
\else% |
|
| 646 |
\DOTIS{#1}%
|
|
| 647 |
\fi |
|
| 648 |
}} |
|
| 649 |
|
|
| 650 |
|
|
| 651 |
%%% Begin: To avoid problem with scrbook.cls (fncychap version 1.32) |
|
| 652 |
|
|
| 653 |
%%OUT: |
|
| 654 |
%\def\@schapter#1{\if@twocolumn
|
|
| 655 |
% \@topnewpage[\@makeschapterhead{#1}]%
|
|
| 656 |
% \else |
|
| 657 |
% \@makeschapterhead{#1}%
|
|
| 658 |
% \@afterheading |
|
| 659 |
% \fi} |
|
| 660 |
|
|
| 661 |
%%IN: |
|
| 662 |
\def\@schapter#1{%
|
|
| 663 |
\if@twocolumn% |
|
| 664 |
\@makeschapterhead{#1}%
|
|
| 665 |
\else% |
|
| 666 |
\@makeschapterhead{#1}%
|
|
| 667 |
\@afterheading% |
|
| 668 |
\fi} |
|
| 669 |
|
|
| 670 |
%%% End: To avoid problem with scrbook.cls (fncychap version 1.32) |
|
| 671 |
|
|
| 672 |
\def\@makeschapterhead#1{%
|
|
| 673 |
\vspace*{50\p@}%
|
|
| 674 |
{\parindent \z@ \raggedright
|
|
| 675 |
\normalfont |
|
| 676 |
\interlinepenalty\@M |
|
| 677 |
\DOTIS{#1}
|
|
| 678 |
\vskip 40\p@ |
|
| 679 |
}} |
|
| 680 |
|
|
| 681 |
\endinput |
|
| 682 |
|
|
| 683 |
|
|
| b/docs/build/latex/howto.cls | ||
|---|---|---|
| 1 |
% |
|
| 2 |
% howto.cls for Sphinx |
|
| 3 |
% |
|
| 4 |
|
|
| 5 |
\NeedsTeXFormat{LaTeX2e}[1995/12/01]
|
|
| 6 |
\ProvidesClass{howto}[2008/10/18 Document class (Sphinx HOWTO)]
|
|
| 7 |
|
|
| 8 |
% Pass all given class options to the parent class. |
|
| 9 |
\DeclareOption*{\PassOptionsToClass{\CurrentOption}{article}}
|
|
| 10 |
\ProcessOptions\relax |
|
| 11 |
\LoadClass[twoside]{article}
|
|
| 12 |
|
|
| 13 |
% Set some sane defaults for section numbering depth and TOC depth. You can |
|
| 14 |
% reset these counters in your preamble. |
|
| 15 |
% |
|
| 16 |
\setcounter{secnumdepth}{2}
|
|
| 17 |
|
|
| 18 |
% Change the title page to look a bit better, and fit in with the fncychap |
|
| 19 |
% ``Bjarne'' style a bit better. |
|
| 20 |
% |
|
| 21 |
\renewcommand{\maketitle}{
|
|
| 22 |
\rule{\textwidth}{1pt}
|
|
| 23 |
\ifsphinxpdfoutput |
|
| 24 |
\begingroup |
|
| 25 |
% This \def is required to deal with multi-line authors; it |
|
| 26 |
% changes \\ to ', ' (comma-space), making it pass muster for |
|
| 27 |
% generating document info in the PDF file. |
|
| 28 |
\def\\{, }
|
|
| 29 |
\pdfinfo{
|
|
| 30 |
/Author (\@author) |
|
| 31 |
/Title (\@title) |
|
| 32 |
} |
|
| 33 |
\endgroup |
|
| 34 |
\fi |
|
| 35 |
\begin{flushright}
|
|
| 36 |
\sphinxlogo% |
|
| 37 |
{\rm\Huge\py@HeaderFamily \@title} \par
|
|
| 38 |
{\em\large\py@HeaderFamily \py@release\releaseinfo} \par
|
|
| 39 |
\vspace{25pt}
|
|
| 40 |
{\Large\py@HeaderFamily \@author} \par
|
|
| 41 |
\vspace{25pt}
|
|
| 42 |
\@date \par |
|
| 43 |
\py@authoraddress \par |
|
| 44 |
\end{flushright}
|
|
| 45 |
\@thanks |
|
| 46 |
\setcounter{footnote}{0}
|
|
| 47 |
\let\thanks\relax\let\maketitle\relax |
|
| 48 |
%\gdef\@thanks{}\gdef\@author{}\gdef\@title{}
|
|
| 49 |
} |
|
| 50 |
|
|
| 51 |
\let\py@OldTableofcontents=\tableofcontents |
|
| 52 |
\renewcommand{\tableofcontents}{
|
|
| 53 |
\begingroup |
|
| 54 |
\parskip = 0mm |
|
| 55 |
\py@OldTableofcontents |
|
| 56 |
\endgroup |
|
| 57 |
\rule{\textwidth}{1pt}
|
|
| 58 |
\vspace{12pt}
|
|
| 59 |
} |
|
| 60 |
|
|
| 61 |
\@ifundefined{fancyhf}{
|
|
| 62 |
\pagestyle{plain}}{
|
|
| 63 |
\pagestyle{normal}} % start this way; change for
|
|
| 64 |
\pagenumbering{arabic} % ToC & chapters
|
|
| 65 |
|
|
| 66 |
\thispagestyle{empty}
|
|
| b/docs/build/latex/manual.cls | ||
|---|---|---|
| 1 |
% |
|
| 2 |
% manual.cls for Sphinx |
|
| 3 |
% |
|
| 4 |
|
|
| 5 |
\NeedsTeXFormat{LaTeX2e}[1995/12/01]
|
|
| 6 |
\ProvidesClass{manual}[2008/10/18 Document class (Sphinx manual)]
|
|
| 7 |
|
|
| 8 |
% Pass all given class options to the parent class. |
|
| 9 |
\DeclareOption*{\PassOptionsToClass{\CurrentOption}{report}}
|
|
| 10 |
\ProcessOptions\relax |
|
| 11 |
\LoadClass[twoside,openright]{report}
|
|
| 12 |
|
|
| 13 |
% Set some sane defaults for section numbering depth and TOC depth. You can |
|
| 14 |
% reset these counters in your preamble. |
|
| 15 |
% |
|
| 16 |
\setcounter{secnumdepth}{2}
|
|
| 17 |
\setcounter{tocdepth}{1}
|
|
| 18 |
|
|
| 19 |
% Change the title page to look a bit better, and fit in with the fncychap |
|
| 20 |
% ``Bjarne'' style a bit better. |
|
| 21 |
% |
|
| 22 |
\renewcommand{\maketitle}{%
|
|
| 23 |
\begin{titlepage}%
|
|
| 24 |
\let\footnotesize\small |
|
| 25 |
\let\footnoterule\relax |
|
| 26 |
\rule{\textwidth}{1pt}%
|
|
| 27 |
\ifsphinxpdfoutput |
|
| 28 |
\begingroup |
|
| 29 |
% This \def is required to deal with multi-line authors; it |
|
| 30 |
% changes \\ to ', ' (comma-space), making it pass muster for |
|
| 31 |
% generating document info in the PDF file. |
|
| 32 |
\def\\{, }
|
|
| 33 |
\pdfinfo{
|
|
| 34 |
/Author (\@author) |
|
| 35 |
/Title (\@title) |
|
| 36 |
} |
|
| 37 |
\endgroup |
|
| 38 |
\fi |
|
| 39 |
\begin{flushright}%
|
|
| 40 |
\sphinxlogo% |
|
| 41 |
{\rm\Huge\py@HeaderFamily \@title \par}%
|
|
| 42 |
{\em\LARGE\py@HeaderFamily \py@release\releaseinfo \par}
|
|
| 43 |
\vfill |
|
| 44 |
{\LARGE\py@HeaderFamily \@author \par}
|
|
| 45 |
\vfill\vfill |
|
| 46 |
{\large
|
|
| 47 |
\@date \par |
|
| 48 |
\vfill |
|
| 49 |
\py@authoraddress \par |
|
| 50 |
}% |
|
| 51 |
\end{flushright}%\par
|
|
| 52 |
\@thanks |
|
| 53 |
\end{titlepage}%
|
|
| 54 |
\cleardoublepage% |
|
| 55 |
\setcounter{footnote}{0}%
|
|
| 56 |
\let\thanks\relax\let\maketitle\relax |
|
| 57 |
%\gdef\@thanks{}\gdef\@author{}\gdef\@title{}
|
|
| 58 |
} |
|
| 59 |
|
|
| 60 |
|
|
| 61 |
% Catch the end of the {abstract} environment, but here make sure the abstract
|
|
| 62 |
% is followed by a blank page if the 'openright' option is used. |
|
| 63 |
% |
|
| 64 |
\let\py@OldEndAbstract=\endabstract |
|
| 65 |
\renewcommand{\endabstract}{
|
|
| 66 |
\if@openright |
|
| 67 |
\ifodd\value{page}
|
|
| 68 |
\typeout{Adding blank page after the abstract.}
|
|
| 69 |
\vfil\pagebreak |
|
| 70 |
\fi |
|
| 71 |
\fi |
|
| 72 |
\py@OldEndAbstract |
|
| 73 |
} |
|
| 74 |
|
|
| 75 |
% This wraps the \tableofcontents macro with all the magic to get the spacing |
|
| 76 |
% right and have the right number of pages if the 'openright' option has been |
|
| 77 |
% used. This eliminates a fair amount of crud in the individual document files. |
|
| 78 |
% |
|
| 79 |
\let\py@OldTableofcontents=\tableofcontents |
|
| 80 |
\renewcommand{\tableofcontents}{%
|
|
| 81 |
\setcounter{page}{1}%
|
|
| 82 |
\pagebreak% |
|
| 83 |
\pagestyle{plain}%
|
|
| 84 |
{%
|
|
| 85 |
\parskip = 0mm% |
|
| 86 |
\py@OldTableofcontents% |
|
| 87 |
\if@openright% |
|
| 88 |
\ifodd\value{page}%
|
|
| 89 |
\typeout{Adding blank page after the table of contents.}%
|
|
| 90 |
\pagebreak\hspace{0pt}%
|
|
| 91 |
\fi% |
|
| 92 |
\fi% |
|
| 93 |
\cleardoublepage% |
|
| 94 |
}% |
|
| 95 |
\pagenumbering{arabic}%
|
|
| 96 |
\@ifundefined{fancyhf}{}{\pagestyle{normal}}%
|
|
| 97 |
} |
|
| 98 |
|
|
| 99 |
% This is needed to get the width of the section # area wide enough in the |
|
| 100 |
% library reference. Doing it here keeps it the same for all the manuals. |
|
| 101 |
% |
|
| 102 |
\renewcommand*\l@section{\@dottedtocline{1}{1.5em}{2.6em}}
|
|
| 103 |
\renewcommand*\l@subsection{\@dottedtocline{2}{4.1em}{3.5em}}
|
|
| b/docs/build/latex/modncclient.idx | ||
|---|---|---|
| 1 |
\indexentry {ncclient.manager@{\texttt {ncclient.manager}}|hyperpage}{3}
|
|
| 2 |
\indexentry {ncclient.capabilities@{\texttt {ncclient.capabilities}}|hyperpage}{4}
|
|
| 3 |
\indexentry {ncclient.content@{\texttt {ncclient.content}}|hyperpage}{5}
|
|
| 4 |
\indexentry {ncclient.transport@{\texttt {ncclient.transport}}|hyperpage}{7}
|
|
| 5 |
\indexentry {ncclient.operations@{\texttt {ncclient.operations}}|hyperpage}{9}
|
|
| b/docs/build/latex/modncclient.ilg | ||
|---|---|---|
| 1 |
This is makeindex, version 2.15 [20-Nov-2007] (kpathsea + Thai support). |
|
| 2 |
Scanning style file ./python.ist......done (6 attributes redefined, 0 ignored). |
|
| 3 |
Scanning input file modncclient.idx....done (5 entries accepted, 0 rejected). |
|
| 4 |
Sorting entries....done (12 comparisons). |
|
| 5 |
Generating output file modncclient.ind....done (11 lines written, 0 warnings). |
|
| 6 |
Output written in modncclient.ind. |
|
| 7 |
Transcript written in modncclient.ilg. |
|
| b/docs/build/latex/modncclient.ind | ||
|---|---|---|
| 1 |
\begin{theindex}
|
|
| 2 |
\def\bigletter#1{{\Large\sffamily#1}\nopagebreak\vspace{1mm}}
|
|
| 3 |
|
|
| 4 |
\bigletter N |
|
| 5 |
\item {\texttt {ncclient.capabilities}}, \hyperpage{4}
|
|
| 6 |
\item {\texttt {ncclient.content}}, \hyperpage{5}
|
|
| 7 |
\item {\texttt {ncclient.manager}}, \hyperpage{3}
|
|
| 8 |
\item {\texttt {ncclient.operations}}, \hyperpage{9}
|
|
| 9 |
\item {\texttt {ncclient.transport}}, \hyperpage{7}
|
|
| 10 |
|
|
| 11 |
\end{theindex}
|
|
| b/docs/build/latex/ncclient.aux | ||
|---|---|---|
| 1 |
\relax |
|
| 2 |
\ifx\hyper@anchor\@undefined |
|
| 3 |
\global \let \oldcontentsline\contentsline |
|
| 4 |
\gdef \contentsline#1#2#3#4{\oldcontentsline{#1}{#2}{#3}}
|
|
| 5 |
\global \let \oldnewlabel\newlabel |
|
| 6 |
\gdef \newlabel#1#2{\newlabelxx{#1}#2}
|
|
| 7 |
\gdef \newlabelxx#1#2#3#4#5#6{\oldnewlabel{#1}{{#2}{#3}}}
|
|
| 8 |
\AtEndDocument{\let \contentsline\oldcontentsline
|
|
| 9 |
\let \newlabel\oldnewlabel} |
|
| 10 |
\else |
|
| 11 |
\global \let \hyper@last\relax |
|
| 12 |
\fi |
|
| 13 |
|
|
| 14 |
\select@language{english}
|
|
| 15 |
\@writefile{toc}{\select@language{english}}
|
|
| 16 |
\@writefile{lof}{\select@language{english}}
|
|
| 17 |
\@writefile{lot}{\select@language{english}}
|
|
| 18 |
\@writefile{toc}{\contentsline {chapter}{\numberline {1}Introduction}{1}{chapter.1}}
|
|
| 19 |
\@writefile{lof}{\addvspace {10\p@ }}
|
|
| 20 |
\@writefile{lot}{\addvspace {10\p@ }}
|
|
| 21 |
\@writefile{toc}{\contentsline {chapter}{\numberline {2}User documentation}{3}{chapter.2}}
|
|
| 22 |
\@writefile{lof}{\addvspace {10\p@ }}
|
|
| 23 |
\@writefile{lot}{\addvspace {10\p@ }}
|
|
| 24 |
\@writefile{toc}{\contentsline {section}{\numberline {2.1}\texttt {manager} module}{3}{section.2.1}}
|
|
| 25 |
\@writefile{toc}{\contentsline {subsection}{\numberline {2.1.1}Dealing with RPC errors}{3}{subsection.2.1.1}}
|
|
| 26 |
\@writefile{toc}{\contentsline {subsection}{\numberline {2.1.2}Manager instances}{3}{subsection.2.1.2}}
|
|
| 27 |
\@writefile{toc}{\contentsline {section}{\numberline {2.2}\texttt {capabilities} module}{4}{section.2.2}}
|
|
| 28 |
\@writefile{toc}{\contentsline {section}{\numberline {2.3}\texttt {content} module}{5}{section.2.3}}
|
|
| 29 |
\@writefile{toc}{\contentsline {subsection}{\numberline {2.3.1}Namespaces}{5}{subsection.2.3.1}}
|
|
| 30 |
\@writefile{toc}{\contentsline {subsection}{\numberline {2.3.2}DictTree XML representation}{5}{subsection.2.3.2}}
|
|
| 31 |
\@writefile{toc}{\contentsline {subsection}{\numberline {2.3.3}Converting between different representations}{5}{subsection.2.3.3}}
|
|
| 32 |
\@writefile{toc}{\contentsline {subsection}{\numberline {2.3.4}Other utility functions}{6}{subsection.2.3.4}}
|
|
| 33 |
\@writefile{toc}{\contentsline {subsection}{\numberline {2.3.5}Errors}{7}{subsection.2.3.5}}
|
|
| 34 |
\@writefile{toc}{\contentsline {section}{\numberline {2.4}\texttt {transport} module}{7}{section.2.4}}
|
|
| 35 |
\@writefile{toc}{\contentsline {subsection}{\numberline {2.4.1}Base types}{7}{subsection.2.4.1}}
|
|
| 36 |
\@writefile{toc}{\contentsline {subsection}{\numberline {2.4.2}SSH session implementation}{7}{subsection.2.4.2}}
|
|
| 37 |
\@writefile{toc}{\contentsline {subsection}{\numberline {2.4.3}Errors}{8}{subsection.2.4.3}}
|
|
| 38 |
\@writefile{toc}{\contentsline {section}{\numberline {2.5}\texttt {operations} module}{9}{section.2.5}}
|
|
| 39 |
\@writefile{toc}{\contentsline {subsection}{\numberline {2.5.1}Base types}{9}{subsection.2.5.1}}
|
|
| 40 |
\@writefile{toc}{\contentsline {subsection}{\numberline {2.5.2}NETCONF Operations}{10}{subsection.2.5.2}}
|
|
| 41 |
\@writefile{toc}{\contentsline {subsubsection}{Dependencies}{10}{subsubsection*.2}}
|
|
| 42 |
\@writefile{toc}{\contentsline {subsubsection}{Return type}{10}{subsubsection*.3}}
|
|
| 43 |
\@writefile{toc}{\contentsline {subsubsection}{General notes on parameters}{10}{subsubsection*.4}}
|
|
| 44 |
\@writefile{toc}{\contentsline {paragraph}{Source / target parameters}{10}{paragraph*.5}}
|
|
| 45 |
\@writefile{toc}{\contentsline {paragraph}{Filter parameters}{10}{paragraph*.6}}
|
|
| 46 |
\@writefile{toc}{\contentsline {subsubsection}{Retrieval operations}{10}{subsubsection*.7}}
|
|
| 47 |
\@writefile{toc}{\contentsline {subsubsection}{Locking operations}{11}{subsubsection*.8}}
|
|
| 48 |
\@writefile{toc}{\contentsline {subsubsection}{Configuration operations}{11}{subsubsection*.9}}
|
|
| 49 |
\@writefile{toc}{\contentsline {subsubsection}{Session management operations}{12}{subsubsection*.10}}
|
|
| 50 |
\@writefile{toc}{\contentsline {subsubsection}{Also useful}{13}{subsubsection*.11}}
|
|
| 51 |
\@writefile{toc}{\contentsline {subsection}{\numberline {2.5.3}Errors}{13}{subsection.2.5.3}}
|
|
| 52 |
\@writefile{toc}{\contentsline {chapter}{\numberline {3}Extending NCClient}{15}{chapter.3}}
|
|
| 53 |
\@writefile{lof}{\addvspace {10\p@ }}
|
|
| 54 |
\@writefile{lot}{\addvspace {10\p@ }}
|
|
| 55 |
\@writefile{toc}{\contentsline {chapter}{Module Index}{17}{section*.12}}
|
|
| 56 |
\@writefile{toc}{\contentsline {chapter}{Index}{19}{section*.13}}
|
|
| b/docs/build/latex/ncclient.idx | ||
|---|---|---|
| 1 |
\indexentry{RFC!RFC 4741|hyperpage}{1}
|
|
| 2 |
\indexentry{RFC!RFC 4741|hyperpage}{1}
|
|
| 3 |
\indexentry{ncclient.manager (module)|hyperpage}{3}
|
|
| 4 |
\indexentry{RAISE\_ALL (in module ncclient.manager)|hyperpage}{3}
|
|
| 5 |
\indexentry{RAISE\_ERR (in module ncclient.manager)|hyperpage}{3}
|
|
| 6 |
\indexentry{RAISE\_NONE (in module ncclient.manager)|hyperpage}{3}
|
|
| 7 |
\indexentry{connect() (in module ncclient.manager)|hyperpage}{3}
|
|
| 8 |
\indexentry{connect\_ssh() (in module ncclient.manager)|hyperpage}{3}
|
|
| 9 |
\indexentry{Manager (class in ncclient.manager)|hyperpage}{3}
|
|
| 10 |
\indexentry{set\_rpc\_error\_action() (ncclient.manager.Manager method)|hyperpage}{3}
|
|
| 11 |
\indexentry{get() (ncclient.manager.Manager method)|hyperpage}{3}
|
|
| 12 |
\indexentry{get\_config() (ncclient.manager.Manager method)|hyperpage}{3}
|
|
| 13 |
\indexentry{edit\_config() (ncclient.manager.Manager method)|hyperpage}{3}
|
|
| 14 |
\indexentry{copy\_config() (ncclient.manager.Manager method)|hyperpage}{3}
|
|
| 15 |
\indexentry{validate() (ncclient.manager.Manager method)|hyperpage}{3}
|
|
| 16 |
\indexentry{commit() (ncclient.manager.Manager method)|hyperpage}{4}
|
|
| 17 |
\indexentry{discard\_changes() (ncclient.manager.Manager method)|hyperpage}{4}
|
|
| 18 |
\indexentry{delete\_config() (ncclient.manager.Manager method)|hyperpage}{4}
|
|
| 19 |
\indexentry{lock() (ncclient.manager.Manager method)|hyperpage}{4}
|
|
| 20 |
\indexentry{unlock() (ncclient.manager.Manager method)|hyperpage}{4}
|
|
| 21 |
\indexentry{close\_session() (ncclient.manager.Manager method)|hyperpage}{4}
|
|
| 22 |
\indexentry{kill\_session() (ncclient.manager.Manager method)|hyperpage}{4}
|
|
| 23 |
\indexentry{locked() (ncclient.manager.Manager method)|hyperpage}{4}
|
|
| 24 |
\indexentry{close() (ncclient.manager.Manager method)|hyperpage}{4}
|
|
| 25 |
\indexentry{client\_capabilities (ncclient.manager.Manager attribute)|hyperpage}{4}
|
|
| 26 |
\indexentry{server\_capabilities (ncclient.manager.Manager attribute)|hyperpage}{4}
|
|
| 27 |
\indexentry{session\_id (ncclient.manager.Manager attribute)|hyperpage}{4}
|
|
| 28 |
\indexentry{connected (ncclient.manager.Manager attribute)|hyperpage}{4}
|
|
| 29 |
\indexentry{ncclient.capabilities (module)|hyperpage}{4}
|
|
| 30 |
\indexentry{CAPABILITIES (in module ncclient.capabilities)|hyperpage}{4}
|
|
| 31 |
\indexentry{Capabilities (class in ncclient.capabilities)|hyperpage}{4}
|
|
| 32 |
\indexentry{add() (ncclient.capabilities.Capabilities method)|hyperpage}{4}
|
|
| 33 |
\indexentry{check() (ncclient.capabilities.Capabilities method)|hyperpage}{4}
|
|
| 34 |
\indexentry{remove() (ncclient.capabilities.Capabilities method)|hyperpage}{4}
|
|
| 35 |
\indexentry{ncclient.content (module)|hyperpage}{5}
|
|
| 36 |
\indexentry{BASE\_NS (in module ncclient.content)|hyperpage}{5}
|
|
| 37 |
\indexentry{qualify() (in module ncclient.content)|hyperpage}{5}
|
|
| 38 |
\indexentry{unqualify() (in module ncclient.content)|hyperpage}{5}
|
|
| 39 |
\indexentry{dtree2ele() (in module ncclient.content)|hyperpage}{5}
|
|
| 40 |
\indexentry{dtree2xml() (in module ncclient.content)|hyperpage}{6}
|
|
| 41 |
\indexentry{ele2dtree() (in module ncclient.content)|hyperpage}{6}
|
|
| 42 |
\indexentry{ele2xml() (in module ncclient.content)|hyperpage}{6}
|
|
| 43 |
\indexentry{xml2dtree() (in module ncclient.content)|hyperpage}{6}
|
|
| 44 |
\indexentry{xml2ele() (in module ncclient.content)|hyperpage}{6}
|
|
| 45 |
\indexentry{iselement() (in module ncclient.content)|hyperpage}{6}
|
|
| 46 |
\indexentry{find() (in module ncclient.content)|hyperpage}{6}
|
|
| 47 |
\indexentry{parse\_root() (in module ncclient.content)|hyperpage}{6}
|
|
| 48 |
\indexentry{validated\_element() (in module ncclient.content)|hyperpage}{6}
|
|
| 49 |
\indexentry{ContentError|hyperpage}{7}
|
|
| 50 |
\indexentry{ncclient.transport (module)|hyperpage}{7}
|
|
| 51 |
\indexentry{Session (class in ncclient.transport)|hyperpage}{7}
|
|
| 52 |
\indexentry{add\_listener() (ncclient.transport.Session method)|hyperpage}{7}
|
|
| 53 |
\indexentry{remove\_listener() (ncclient.transport.Session method)|hyperpage}{7}
|
|
| 54 |
\indexentry{get\_listener\_instance() (ncclient.transport.Session method)|hyperpage}{7}
|
|
| 55 |
\indexentry{client\_capabilities (ncclient.transport.Session attribute)|hyperpage}{7}
|
|
| 56 |
\indexentry{server\_capabilities (ncclient.transport.Session attribute)|hyperpage}{7}
|
|
| 57 |
\indexentry{connected (ncclient.transport.Session attribute)|hyperpage}{7}
|
|
| 58 |
\indexentry{id (ncclient.transport.Session attribute)|hyperpage}{7}
|
|
| 59 |
\indexentry{can\_pipeline (ncclient.transport.Session attribute)|hyperpage}{7}
|
|
| 60 |
\indexentry{SessionListener (class in ncclient.transport)|hyperpage}{7}
|
|
| 61 |
\indexentry{callback() (ncclient.transport.SessionListener method)|hyperpage}{7}
|
|
| 62 |
\indexentry{errback() (ncclient.transport.SessionListener method)|hyperpage}{7}
|
|
| 63 |
\indexentry{default\_unknown\_host\_cb() (ncclient.transport.ssh static method)|hyperpage}{7}
|
|
| 64 |
\indexentry{SSHSession (class in ncclient.transport)|hyperpage}{8}
|
|
| 65 |
\indexentry{RFC!RFC 4742|hyperpage}{8}
|
|
| 66 |
\indexentry{connect() (ncclient.transport.SSHSession method)|hyperpage}{8}
|
|
| 67 |
\indexentry{load\_known\_hosts() (ncclient.transport.SSHSession method)|hyperpage}{8}
|
|
| 68 |
\indexentry{transport (ncclient.transport.SSHSession attribute)|hyperpage}{8}
|
|
| 69 |
\indexentry{TransportError|hyperpage}{8}
|
|
| 70 |
\indexentry{SessionCloseError|hyperpage}{8}
|
|
| 71 |
\indexentry{SSHError|hyperpage}{8}
|
|
| 72 |
\indexentry{AuthenticationError|hyperpage}{8}
|
|
| 73 |
\indexentry{SSHUnknownHostError|hyperpage}{8}
|
|
| 74 |
\indexentry{ncclient.operations (module)|hyperpage}{9}
|
|
| 75 |
\indexentry{RPC (class in ncclient.operations.rpc)|hyperpage}{9}
|
|
| 76 |
\indexentry{set\_async() (ncclient.operations.rpc.RPC method)|hyperpage}{9}
|
|
| 77 |
\indexentry{set\_timeout() (ncclient.operations.rpc.RPC method)|hyperpage}{9}
|
|
| 78 |
\indexentry{reply (ncclient.operations.rpc.RPC attribute)|hyperpage}{9}
|
|
| 79 |
\indexentry{error (ncclient.operations.rpc.RPC attribute)|hyperpage}{9}
|
|
| 80 |
\indexentry{event (ncclient.operations.rpc.RPC attribute)|hyperpage}{9}
|
|
| 81 |
\indexentry{async (ncclient.operations.rpc.RPC attribute)|hyperpage}{9}
|
|
| 82 |
\indexentry{timeout (ncclient.operations.rpc.RPC attribute)|hyperpage}{9}
|
|
| 83 |
\indexentry{id (ncclient.operations.rpc.RPC attribute)|hyperpage}{9}
|
|
| 84 |
\indexentry{session (ncclient.operations.rpc.RPC attribute)|hyperpage}{9}
|
|
| 85 |
\indexentry{RPCReply (class in ncclient.operations.rpc)|hyperpage}{9}
|
|
| 86 |
\indexentry{ok (ncclient.operations.rpc.RPCReply attribute)|hyperpage}{9}
|
|
| 87 |
\indexentry{error (ncclient.operations.rpc.RPCReply attribute)|hyperpage}{9}
|
|
| 88 |
\indexentry{errors (ncclient.operations.rpc.RPCReply attribute)|hyperpage}{9}
|
|
| 89 |
\indexentry{RPCError (class in ncclient.operations.rpc)|hyperpage}{9}
|
|
| 90 |
\indexentry{type (ncclient.operations.rpc.RPCError attribute)|hyperpage}{9}
|
|
| 91 |
\indexentry{severity (ncclient.operations.rpc.RPCError attribute)|hyperpage}{9}
|
|
| 92 |
\indexentry{tag (ncclient.operations.rpc.RPCError attribute)|hyperpage}{9}
|
|
| 93 |
\indexentry{path (ncclient.operations.rpc.RPCError attribute)|hyperpage}{9}
|
|
| 94 |
\indexentry{message (ncclient.operations.rpc.RPCError attribute)|hyperpage}{10}
|
|
| 95 |
\indexentry{info (ncclient.operations.rpc.RPCError attribute)|hyperpage}{10}
|
|
| 96 |
\indexentry{Get (class in ncclient.operations)|hyperpage}{10}
|
|
| 97 |
\indexentry{request() (ncclient.operations.Get method)|hyperpage}{10}
|
|
| 98 |
\indexentry{GetConfig (class in ncclient.operations)|hyperpage}{11}
|
|
| 99 |
\indexentry{request() (ncclient.operations.GetConfig method)|hyperpage}{11}
|
|
| 100 |
\indexentry{GetReply (class in ncclient.operations)|hyperpage}{11}
|
|
| 101 |
\indexentry{data (ncclient.operations.GetReply attribute)|hyperpage}{11}
|
|
| 102 |
\indexentry{data\_xml (ncclient.operations.GetReply attribute)|hyperpage}{11}
|
|
| 103 |
\indexentry{data\_dtree (ncclient.operations.GetReply attribute)|hyperpage}{11}
|
|
| 104 |
\indexentry{data\_ele (ncclient.operations.GetReply attribute)|hyperpage}{11}
|
|
| 105 |
\indexentry{Lock (class in ncclient.operations)|hyperpage}{11}
|
|
| 106 |
\indexentry{request() (ncclient.operations.Lock method)|hyperpage}{11}
|
|
| 107 |
\indexentry{Unlock (class in ncclient.operations)|hyperpage}{11}
|
|
| 108 |
\indexentry{request() (ncclient.operations.Unlock method)|hyperpage}{11}
|
|
| 109 |
\indexentry{EditConfig (class in ncclient.operations)|hyperpage}{11}
|
|
| 110 |
\indexentry{request() (ncclient.operations.EditConfig method)|hyperpage}{11}
|
|
| 111 |
\indexentry{CopyConfig (class in ncclient.operations)|hyperpage}{12}
|
|
| 112 |
\indexentry{request() (ncclient.operations.CopyConfig method)|hyperpage}{12}
|
|
| 113 |
\indexentry{DeleteConfig (class in ncclient.operations)|hyperpage}{12}
|
|
| 114 |
\indexentry{request() (ncclient.operations.DeleteConfig method)|hyperpage}{12}
|
|
| 115 |
\indexentry{Validate (class in ncclient.operations)|hyperpage}{12}
|
|
| 116 |
\indexentry{request() (ncclient.operations.Validate method)|hyperpage}{12}
|
|
| 117 |
\indexentry{Commit (class in ncclient.operations)|hyperpage}{12}
|
|
| 118 |
\indexentry{request() (ncclient.operations.Commit method)|hyperpage}{12}
|
|
| 119 |
\indexentry{DiscardChanges (class in ncclient.operations)|hyperpage}{12}
|
|
| 120 |
\indexentry{request() (ncclient.operations.DiscardChanges method)|hyperpage}{12}
|
|
| 121 |
\indexentry{CloseSession (class in ncclient.operations)|hyperpage}{12}
|
|
| 122 |
\indexentry{KillSession (class in ncclient.operations)|hyperpage}{12}
|
|
| 123 |
\indexentry{LockContext (class in ncclient.operations)|hyperpage}{13}
|
|
| 124 |
\indexentry{OperationError|hyperpage}{13}
|
|
| 125 |
\indexentry{TimeoutExpiredError|hyperpage}{13}
|
|
| 126 |
\indexentry{MissingCapabilityError|hyperpage}{13}
|
|
| b/docs/build/latex/ncclient.ilg | ||
|---|---|---|
| 1 |
This is makeindex, version 2.15 [20-Nov-2007] (kpathsea + Thai support). |
|
| 2 |
Scanning style file ./python.ist......done (6 attributes redefined, 0 ignored). |
|
| 3 |
Scanning input file ncclient.idx....done (126 entries accepted, 0 rejected). |
|
| 4 |
Sorting entries....done (923 comparisons). |
|
| 5 |
Generating output file ncclient.ind....done (192 lines written, 0 warnings). |
|
| 6 |
Output written in ncclient.ind. |
|
| 7 |
Transcript written in ncclient.ilg. |
|
| b/docs/build/latex/ncclient.ind | ||
|---|---|---|
| 1 |
\begin{theindex}
|
|
| 2 |
\def\bigletter#1{{\Large\sffamily#1}\nopagebreak\vspace{1mm}}
|
|
| 3 |
|
|
| 4 |
\bigletter A |
|
| 5 |
\item add() (ncclient.capabilities.Capabilities method), \hyperpage{4}
|
|
| 6 |
\item add\_listener() (ncclient.transport.Session method), \hyperpage{7}
|
|
| 7 |
\item async (ncclient.operations.rpc.RPC attribute), \hyperpage{9}
|
|
| 8 |
\item AuthenticationError, \hyperpage{8}
|
|
| 9 |
|
|
| 10 |
\indexspace |
|
| 11 |
\bigletter B |
|
| 12 |
\item BASE\_NS (in module ncclient.content), \hyperpage{5}
|
|
| 13 |
|
|
| 14 |
\indexspace |
|
| 15 |
\bigletter C |
|
| 16 |
\item callback() (ncclient.transport.SessionListener method), \hyperpage{7}
|
|
| 17 |
\item can\_pipeline (ncclient.transport.Session attribute), \hyperpage{7}
|
|
| 18 |
\item Capabilities (class in ncclient.capabilities), \hyperpage{4}
|
|
| 19 |
\item CAPABILITIES (in module ncclient.capabilities), \hyperpage{4}
|
|
| 20 |
\item check() (ncclient.capabilities.Capabilities method), \hyperpage{4}
|
|
| 21 |
\item client\_capabilities (ncclient.manager.Manager attribute), \hyperpage{4}
|
|
| 22 |
\item client\_capabilities (ncclient.transport.Session attribute), \hyperpage{7}
|
|
| 23 |
\item close() (ncclient.manager.Manager method), \hyperpage{4}
|
|
| 24 |
\item close\_session() (ncclient.manager.Manager method), \hyperpage{4}
|
|
| 25 |
\item CloseSession (class in ncclient.operations), \hyperpage{12}
|
|
| 26 |
\item Commit (class in ncclient.operations), \hyperpage{12}
|
|
| 27 |
\item commit() (ncclient.manager.Manager method), \hyperpage{4}
|
|
| 28 |
\item connect() (in module ncclient.manager), \hyperpage{3}
|
|
| 29 |
\item connect() (ncclient.transport.SSHSession method), \hyperpage{8}
|
|
| 30 |
\item connect\_ssh() (in module ncclient.manager), \hyperpage{3}
|
|
| 31 |
\item connected (ncclient.manager.Manager attribute), \hyperpage{4}
|
|
| 32 |
\item connected (ncclient.transport.Session attribute), \hyperpage{7}
|
|
| 33 |
\item ContentError, \hyperpage{7}
|
|
| 34 |
\item copy\_config() (ncclient.manager.Manager method), \hyperpage{3}
|
|
| 35 |
\item CopyConfig (class in ncclient.operations), \hyperpage{12}
|
|
| 36 |
|
|
| 37 |
\indexspace |
|
| 38 |
\bigletter D |
|
| 39 |
\item data (ncclient.operations.GetReply attribute), \hyperpage{11}
|
|
| 40 |
\item data\_dtree (ncclient.operations.GetReply attribute), \hyperpage{11}
|
|
| 41 |
\item data\_ele (ncclient.operations.GetReply attribute), \hyperpage{11}
|
|
| 42 |
\item data\_xml (ncclient.operations.GetReply attribute), \hyperpage{11}
|
|
| 43 |
\item default\_unknown\_host\_cb() (ncclient.transport.ssh static method), \hyperpage{7}
|
|
| 44 |
\item delete\_config() (ncclient.manager.Manager method), \hyperpage{4}
|
|
| 45 |
\item DeleteConfig (class in ncclient.operations), \hyperpage{12}
|
|
| 46 |
\item discard\_changes() (ncclient.manager.Manager method), \hyperpage{4}
|
|
| 47 |
\item DiscardChanges (class in ncclient.operations), \hyperpage{12}
|
|
| 48 |
\item dtree2ele() (in module ncclient.content), \hyperpage{5}
|
|
| 49 |
\item dtree2xml() (in module ncclient.content), \hyperpage{6}
|
|
| 50 |
|
|
| 51 |
\indexspace |
|
| 52 |
\bigletter E |
|
| 53 |
\item edit\_config() (ncclient.manager.Manager method), \hyperpage{3}
|
|
| 54 |
\item EditConfig (class in ncclient.operations), \hyperpage{11}
|
|
| 55 |
\item ele2dtree() (in module ncclient.content), \hyperpage{6}
|
|
| 56 |
\item ele2xml() (in module ncclient.content), \hyperpage{6}
|
|
| 57 |
\item errback() (ncclient.transport.SessionListener method), \hyperpage{7}
|
|
| 58 |
\item error (ncclient.operations.rpc.RPC attribute), \hyperpage{9}
|
|
| 59 |
\item error (ncclient.operations.rpc.RPCReply attribute), \hyperpage{9}
|
|
| 60 |
\item errors (ncclient.operations.rpc.RPCReply attribute), \hyperpage{9}
|
|
| 61 |
\item event (ncclient.operations.rpc.RPC attribute), \hyperpage{9}
|
|
| 62 |
|
|
| 63 |
\indexspace |
|
| 64 |
\bigletter F |
|
| 65 |
\item find() (in module ncclient.content), \hyperpage{6}
|
|
| 66 |
|
|
| 67 |
\indexspace |
|
| 68 |
\bigletter G |
|
| 69 |
\item Get (class in ncclient.operations), \hyperpage{10}
|
|
| 70 |
\item get() (ncclient.manager.Manager method), \hyperpage{3}
|
|
| 71 |
\item get\_config() (ncclient.manager.Manager method), \hyperpage{3}
|
|
| 72 |
\item get\_listener\_instance() (ncclient.transport.Session method), \hyperpage{7}
|
|
| 73 |
\item GetConfig (class in ncclient.operations), \hyperpage{11}
|
|
| 74 |
\item GetReply (class in ncclient.operations), \hyperpage{11}
|
|
| 75 |
|
|
| 76 |
\indexspace |
|
| 77 |
\bigletter I |
|
| 78 |
\item id (ncclient.operations.rpc.RPC attribute), \hyperpage{9}
|
|
| 79 |
\item id (ncclient.transport.Session attribute), \hyperpage{7}
|
|
| 80 |
\item info (ncclient.operations.rpc.RPCError attribute), \hyperpage{10}
|
|
| 81 |
\item iselement() (in module ncclient.content), \hyperpage{6}
|
|
| 82 |
|
|
| 83 |
\indexspace |
|
| 84 |
\bigletter K |
|
| 85 |
\item kill\_session() (ncclient.manager.Manager method), \hyperpage{4}
|
|
| 86 |
\item KillSession (class in ncclient.operations), \hyperpage{12}
|
|
| 87 |
|
|
| 88 |
\indexspace |
|
| 89 |
\bigletter L |
|
| 90 |
\item load\_known\_hosts() (ncclient.transport.SSHSession method), \hyperpage{8}
|
|
| 91 |
\item Lock (class in ncclient.operations), \hyperpage{11}
|
|
Also available in: Unified diff