deepcrayon
/
ai-doc
1
0
Fork 0
Code

Template to AI Documentation

main
root 2023-07-18 12:32:02 -06:00
parent 70d6ed67d9
commit 4d9a62128d
26 changed files with 64 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.gitignore vendored
View File

@ -1,6 +1,6 @@
Cover.pdf
LaTeXBookTemplate.pdf
LaTeXBookTemplate-web.pdf
AIDoc.pdf
AIDoc-web.pdf
tmp/
*~
.~lock.*.ods#

18
BUILD.md
View File

@ -1,8 +1,8 @@
# LaTeX Book Template Build
# AI Documentation Build
This `BUILD.md` document is about how to build the documentation,
not about how to build a ground station.
The *LaTeX Book Template* is written in LaTeX
The *AI Documentation* is written in LaTeX
which generates a final PDF for viewing or printing.
@ -29,8 +29,8 @@ sudo apt install texlive-latex-recommended texlive-xetex \
Get source code:
```
git clone https://spacecruft.org/spacecruft/LaTeXBookTemplate
cd LaTeXBookTemplate/
git clone https://spacecruft.org/spacecruft/AIDoc
cd AIDoc/
```
@ -58,7 +58,7 @@ make clean
Use a PDF viewer to read the document, such as:
```
evince LaTeXBookTemplate.pdf
evince AIDoc.pdf
```
@ -146,11 +146,11 @@ Use `jabref`.
# Setup for New Book
```
sed -i -e 's/LaTeX Book Template/Muh New Book/g' BUILD.md Makefile README.md src/*.tex src/*.gst src/Makefile
sed -i -e 's/AI Documentation/Muh New Book/g' BUILD.md Makefile README.md src/*.tex src/*.gst src/Makefile
sed -i -e 's/LaTeXBookTemplate/MuhNewBook/g' .gitignore BUILD.md Makefile README.md src/*.tex src/*.gst src/Makefile
sed -i -e 's/AIDoc/MuhNewBook/g' .gitignore BUILD.md Makefile README.md src/*.tex src/*.gst src/Makefile
for i in src/*LaTeXBookTemplate* ; do mv $i `echo $i | sed -e 's/LaTeXBookTemplate/MuhNewBook/g'` ; done
for i in src/*AIDoc* ; do mv $i `echo $i | sed -e 's/AIDoc/MuhNewBook/g'` ; done
```
@ -160,7 +160,7 @@ HOWTO: set up and print with Lulu.
# License
LaTeX Book Template
AI Documentation
by Jeff Moe

2
Makefile
View File

@ -5,7 +5,7 @@ all:
$(MAKE) -C src
mv src/*.pdf .
# ps2pdf breaks ToC and other internal links
# ps2pdf LaTeXBookTemplate.pdf LaTeXBookTemplate-web.pdf
# ps2pdf AIDoc.pdf AIDoc-web.pdf
cover:
$(MAKE) -C src cover

6
README.md
View File

@ -1,7 +1,7 @@
# LaTeX Book Template
# AI Documentation
A template for making a book in LaTeX.
* https://spacecruft.org/spacecruft/LaTeXBookTemplate/
* https://spacecruft.org/spacecruft/AIDoc/
# Build from Source
@ -10,7 +10,7 @@ see the `BUILD.md` document.
# License
LaTeX Book Template
AI Documentation
by Jeff Moe

6
src/LaTeXBookTemplate-thumbnail.tex → src/AIDoc-thumbnail.tex
View File

@ -1,8 +1,8 @@
%
% LaTeXBookTemplate-thumbnail.tex
% AIDoc-thumbnail.tex
% Create thumbnail images of PDF pages
%
% LaTeX Book Template
% AI Documentation
%
% Copyright (C) 2022, Jeff Moe
%
@ -16,6 +16,6 @@
\usepackage{pdflscape}
\usepackage{thumbpdf}
\begin{document}
\includepdf[nup=2x4,pages={{},-},landscape]{LaTeXBookTemplate.pdf}
\includepdf[nup=2x4,pages={{},-},landscape]{AIDoc.pdf}
\end{document}

0
src/LaTeXBookTemplate.bib → src/AIDoc.bib
View File

4
src/LaTeXBookTemplate.gst → src/AIDoc.gst
View File

@ -1,8 +1,8 @@
%
% LaTeXBookTemplate.gst
% AIDoc.gst
% makindex glossary style file
%
% LaTeX Book Template
% AI Documentation
%
% Copyright (C) 2022, Jeff Moe
%

20
src/LaTeXBookTemplate.tex → src/AIDoc.tex
View File

@ -1,8 +1,8 @@
%
% LaTeXBookTemplate.tex
% Main LaTeX document for formatting LaTeXBookTemplate
% AIDoc.tex
% Main LaTeX document for formatting AIDoc
%
% LaTeX Book Template
% AI Documentation
%
% Copyright (C) 2022, Jeff Moe
%
@ -124,16 +124,16 @@ leftmargin=1cm,rightmargin=1cm
%%% Barcode
\usepackage{pst-barcode}
%%% LaTeXBookTemplate PAGE STYLE %%%
%%% AIDoc PAGE STYLE %%%
\makepagestyle{jebbastyle}
\pagestyle{jebbastyle}
\makeevenhead{jebbastyle}{}{\hspace{2em}\itshape\small\leftmark}{}
\makeoddhead{jebbastyle}{}{\scshape\small\rightmark}{}
\makeevenfoot{jebbastyle}{}{\hspace{2em}\thepage}{}
\makeoddfoot{jebbastyle}{}{\thepage}{}
%%% END LaTeXBookTemplate PAGE STYLE %%%
%%% END AIDoc PAGE STYLE %%%
%%% LaTeXBookTemplateSKI CHAPTER STYLE %%%
%%% AIDocSKI CHAPTER STYLE %%%
\makechapterstyle{jebbaski}{%
\renewcommand*{\printchaptername}{} % Clear out the chapter name (e.g. capítulo)
\renewcommand*{\printchapternum}{} % Clear out the chapter number
@ -145,7 +145,7 @@ leftmargin=1cm,rightmargin=1cm
\renewcommand*{\afterchaptertitle}{\vskip\onelineskip \hrule\vskip
\afterchapskip}
}
%%% END LaTeXBookTemplateSKI CHAPTER STYLE %%%
%%% END AIDocSKI CHAPTER STYLE %%%
%%% FORMATTING... %%%
\midsloppy
@ -169,7 +169,7 @@ leftmargin=1cm,rightmargin=1cm
%%% BIBLIOGRAPHY %%%
\usepackage[style=verbose]{biblatex}
\addbibresource{LaTeXBookTemplate.bib}
\addbibresource{AIDoc.bib}
%%% END BIBLIOGRAPHY %%%
%%% COLORS %%%
@ -206,7 +206,7 @@ leftmargin=1cm,rightmargin=1cm
% http://www.tug.org/applications/hyperref/manual.html
% /usr/share/doc/texlive-doc/latex/hyperref/hyperref.pdf
\usepackage[bookmarksdepth=3, unicode, breaklinks=True, xetex, final=True, hyperfootnotes=True, hyperfigures=True, hyperindex=False, linktoc=all, colorlinks=true, anchorcolor=jebba-darker-blue, citecolor=jebba-darker-blue, linkcolor=jebba-darker-blue, urlcolor=jebba-darker-blue, bookmarks=True, bookmarksopen=True]{hyperref}
\hypersetup{plainpages=False, backref=True, pagebackref=True, pdftitle={LaTeX Book Template}, pdfauthor={Jeff Moe}, pdfdisplaydoctitle=True}
\hypersetup{plainpages=False, backref=True, pagebackref=True, pdftitle={AI Documentation}, pdfauthor={Jeff Moe}, pdfdisplaydoctitle=True}
%%% END HYPERREF %%%
%%% INDEX %%%
@ -414,7 +414,7 @@ leftmargin=1cm,rightmargin=1cm
%%% END CHAPTER STYLE %%%
%%% CHAPTER CONFIG %%%
\newcommand{\chapterheader}{LaTeX Book Template}
\newcommand{\chapterheader}{AI Documentation}
% See \chapterconf below for examples of how this is used.
% value 1 is file to include
% value 2 is title of chapter

2
src/Acknowledgements.tex
View File

@ -1,7 +1,7 @@
%
% Acknowledgements.tex
%
% LaTeX Book Template
% AI Documentation
%
% Copyright (C) 2022, Jeff Moe
%

2
src/Appendix.tex
View File

@ -1,7 +1,7 @@
%
% Appendix.tex
%
% LaTeX Book Template
% AI Documentation
%
% Copyright (C) 2022, Jeff Moe
%

2
src/Colophon.tex
View File

@ -1,7 +1,7 @@
%
% Colophon.tex
%
% LaTeX Book Template
% AI Documentation
%
% Copyright (C) 2022, Jeff Moe
%

2
src/Contact.tex
View File

@ -1,7 +1,7 @@
%
% Contact.tex
%
% LaTeX Book Template
% AI Documentation
%
% Copyright (C) 2022, Jeff Moe
%

4
src/Copyright.tex
View File

@ -2,7 +2,7 @@
% Copyright.tex
% Copyleft
%
% LaTeX Book Template
% AI Documentation
%
% Copyright (C) 2022, Jeff Moe
%
@ -16,7 +16,7 @@
\footnotesize\raggedright
\setlength{\parskip}{0.5\baselineskip}
\textbf{LaTeX Book Template}
\textbf{AI Documentation}
by Jeff Moe

2
src/Cover.tex
View File

@ -60,7 +60,7 @@
\hspace*{20pt}
\large\itshape\textcolor{black}{}
\fontspec{GemunuLibre-ExtraBold.otf}\fontsize{14pt}{1em}\selectfont
LaTeX Book Template
AI Documentation
\hspace*{20pt}
\includegraphics[keepaspectratio=true,angle=0,height=0.02\textheight,width=0.02\textwidth]{spacecruft.png}
\large\itshape\textcolor{black}{}

2
src/Dedication.tex
View File

@ -1,7 +1,7 @@
%
% Dedication.tex
%
% LaTeX Book Template
% AI Documentation
%
% Copyright (C) 2022, Jeff Moe
%

2
src/Epigraph.tex
View File

@ -1,7 +1,7 @@
%
% Epigraph.tex
%
% LaTeX Book Template
% AI Documentation
%
% Copyright (C) 2022, Jeff Moe
%

2
src/Foreward.tex
View File

@ -1,7 +1,7 @@
%
% Foreward.tex
%
% LaTeX Book Template
% AI Documentation
%
% Copyright (C) 2022, Jeff Moe
%

2
src/Frontispiece.tex
View File

@ -1,7 +1,7 @@
%
% Frontispiece.tex
%
% LaTeX Book Template
% AI Documentation
%
% Copyright (C) 2022, Jeff Moe
%

4
src/Half_Title.tex
View File

@ -1,7 +1,7 @@
%
% Half_Title.tex
%
% LaTeX Book Template
% AI Documentation
%
% Copyright (C) 2022, Jeff Moe
%
@ -13,7 +13,7 @@
\thispagestyle{empty}
\begin{vplace}
\centering
\fontspec{lmmonocaps10-regular.otf}\fontsize{20pt}{1em}\selectfont{LaTeX Book Template}
\fontspec{lmmonocaps10-regular.otf}\fontsize{20pt}{1em}\selectfont{AI Documentation}
\\
\fontspec{lmmonocaps10-regular.otf}\fontsize{14pt}{1em}\selectfont{\textcolor{red}{DRAFT}}
\end{vplace}

2
src/Introduction.tex
View File

@ -1,7 +1,7 @@
%
% Introduction.tex
%
% LaTeX Book Template
% AI Documentation
%
% Copyright (C) 2022, Jeff Moe
%

30
src/Makefile
View File

@ -6,55 +6,55 @@ all:
-shell-escape \
-interaction=nonstopmode \
-no-pdf \
LaTeXBookTemplate.tex
biber LaTeXBookTemplate
#makeglossaries LaTeXBookTemplate
bib2gls LaTeXBookTemplate
AIDoc.tex
biber AIDoc
#makeglossaries AIDoc
bib2gls AIDoc
xelatex \
-halt-on-error \
-shell-escape \
-interaction=nonstopmode \
-no-pdf \
LaTeXBookTemplate.tex
bib2gls LaTeXBookTemplate
AIDoc.tex
bib2gls AIDoc
xelatex \
-halt-on-error \
-shell-escape \
-interaction=nonstopmode \
-no-pdf \
LaTeXBookTemplate.tex
bib2gls LaTeXBookTemplate
AIDoc.tex
bib2gls AIDoc
xelatex \
-halt-on-error \
-shell-escape \
-interaction=nonstopmode \
-no-pdf \
LaTeXBookTemplate.tex
AIDoc.tex
xelatex \
-halt-on-error \
-shell-escape \
-interaction=nonstopmode \
-no-pdf \
LaTeXBookTemplate.tex
biber LaTeXBookTemplate
AIDoc.tex
biber AIDoc
xelatex \
-halt-on-error \
-shell-escape \
-interaction=nonstopmode \
-no-pdf \
LaTeXBookTemplate.tex
makeindex LaTeXBookTemplate
AIDoc.tex
makeindex AIDoc
xelatex \
-halt-on-error \
-shell-escape \
-interaction=nonstopmode \
-no-pdf \
LaTeXBookTemplate.tex
AIDoc.tex
xelatex \
-halt-on-error \
-shell-escape \
-interaction=nonstopmode \
LaTeXBookTemplate.tex
AIDoc.tex
cover:
xelatex \

2
src/MuhFirstChapter.tex
View File

@ -1,7 +1,7 @@
%
% MuhFirstChapter.tex
%
% LaTeX Book Template
% AI Documentation
%
% Copyright (C) 2022, Jeff Moe
%

2
src/Preface.tex
View File

@ -1,7 +1,7 @@
%
% Preface.tex
%
% LaTeX Book Template
% AI Documentation
%
% Copyright (C) 2022, Jeff Moe
%

2
src/Prologue.tex
View File

@ -1,7 +1,7 @@
%
% Prologue.tex
%
% LaTeX Book Template
% AI Documentation
%
% Copyright (C) 2022, Jeff Moe
%

2
src/Support.tex
View File

@ -1,7 +1,7 @@
%
% Support.tex
%
% LaTeX Book Template
% AI Documentation
%
% Copyright (C) 2022, Jeff Moe
%

2
src/Title.tex
View File

@ -1,7 +1,7 @@
%
% Title.tex
%
% LaTeX Book Template
% AI Documentation
%
% Copyright (C) 2022, Jeff Moe
%