2011-03-19 03:18:08 +03:00
|
|
|
% Documentation core for ToAruOS
|
|
|
|
% Copyright 2011 Kevin Lange
|
|
|
|
|
2011-03-19 05:56:07 +03:00
|
|
|
% Standard article with (centered) title page
|
|
|
|
\documentclass[titlepage]{article}
|
2011-03-19 03:18:08 +03:00
|
|
|
% Switch to a nice sans-serif font.
|
|
|
|
\renewcommand*\familydefault{\sfdefault}
|
2011-03-19 05:56:07 +03:00
|
|
|
\usepackage[margin=1in]{geometry} % Margins
|
|
|
|
\usepackage{fancyhdr} % Fancy page header
|
|
|
|
\usepackage{amsmath} % Extra mathemtics stuff
|
|
|
|
\usepackage{listings} % Source code styling
|
|
|
|
\usepackage{graphicx} % Graphics support
|
|
|
|
\usepackage[overlap, CJK]{ruby} % For Japanese
|
|
|
|
\usepackage{makeidx} % Indexing
|
|
|
|
\usepackage[bookmarks]{hyperref} % PDF hyperlink index
|
|
|
|
|
|
|
|
% Some useful macros for the documentation
|
|
|
|
\newcommand{\toarutitle}{ToAruOS Kernel Documentation}
|
|
|
|
\newcommand{\toaruversi}{v 0.0.1}
|
|
|
|
\newcommand{\toaruautho}{Kevin Lange}
|
|
|
|
|
|
|
|
% Title / Author
|
|
|
|
\title{\toarutitle}
|
|
|
|
\author{\toaruautho}
|
|
|
|
|
2011-03-19 06:37:41 +03:00
|
|
|
% PDF Data
|
|
|
|
\hypersetup{
|
|
|
|
pdftitle={\toarutitle},
|
|
|
|
pdfauthor={\toaruautho},
|
|
|
|
pdfkeywords={toaruos, kernel, development, documentation},
|
2011-03-19 06:48:24 +03:00
|
|
|
linkbordercolor=1 1 1,
|
2011-03-19 06:37:41 +03:00
|
|
|
}
|
|
|
|
|
2011-03-19 05:56:07 +03:00
|
|
|
% Enable indexing
|
2011-03-19 03:18:08 +03:00
|
|
|
\makeindex
|
|
|
|
|
|
|
|
% Some nice headers for the core contents.
|
|
|
|
\pagestyle{fancy}
|
2011-03-19 05:56:07 +03:00
|
|
|
\lhead{\toarutitle}
|
|
|
|
\rhead{\toaruversi}
|
2011-03-19 03:18:08 +03:00
|
|
|
|
2011-03-19 05:56:07 +03:00
|
|
|
% Begin document contents
|
2011-03-19 03:18:08 +03:00
|
|
|
\begin{document}
|
|
|
|
\begin{CJK}{UTF8}{goth}
|
|
|
|
|
|
|
|
% Title page for documentation
|
|
|
|
\begin{titlepage}
|
|
|
|
\maketitle
|
|
|
|
% Make sure we don't have a number here...
|
|
|
|
\thispagestyle{empty}
|
|
|
|
\end{titlepage}
|
|
|
|
|
2011-03-20 01:01:56 +03:00
|
|
|
% We're now on page 1.
|
|
|
|
\setcounter{page}{1}
|
|
|
|
\thispagestyle{fancy}
|
2011-03-19 03:18:08 +03:00
|
|
|
|
|
|
|
% Table of Contents
|
2011-03-19 03:31:13 +03:00
|
|
|
\cleardoublepage
|
2011-03-19 03:18:08 +03:00
|
|
|
\tableofcontents
|
|
|
|
|
|
|
|
%% BEGIN DOCUMENT CONTENTS %%
|
|
|
|
|
2011-03-20 01:01:56 +03:00
|
|
|
% History
|
|
|
|
\clearpage
|
|
|
|
\input{history.tex}
|
|
|
|
|
2011-03-19 03:31:13 +03:00
|
|
|
% Introduction
|
|
|
|
\clearpage
|
|
|
|
\input{intro.tex}
|
|
|
|
|
2011-03-19 03:57:10 +03:00
|
|
|
% Bootloader
|
|
|
|
\clearpage
|
|
|
|
\input{bootloader.tex}
|
|
|
|
|
2011-03-19 03:18:08 +03:00
|
|
|
% Dynamic Linker / Loader documentation
|
|
|
|
\clearpage
|
2011-03-19 03:31:13 +03:00
|
|
|
\input{loader.tex}
|
2011-03-19 03:18:08 +03:00
|
|
|
|
|
|
|
%% Index %%
|
2011-03-19 03:57:10 +03:00
|
|
|
\cleardoublepage
|
2011-03-19 03:31:13 +03:00
|
|
|
\addcontentsline{toc}{section}{Index}
|
2011-03-19 03:18:08 +03:00
|
|
|
\printindex
|
|
|
|
|
2011-03-19 05:56:07 +03:00
|
|
|
% License information
|
2011-03-19 03:57:10 +03:00
|
|
|
\clearpage
|
|
|
|
\input{license.tex}
|
|
|
|
|
2011-03-19 05:56:07 +03:00
|
|
|
% Fin
|
2011-03-19 03:18:08 +03:00
|
|
|
\end{CJK}
|
|
|
|
\end{document}
|