RTOS/seL4
1
0
Fork 0
forked from Imagelibrary/seL4
Code Pull Requests Activity

manual: apply foundation branding

Browse Source 
Signed-off-by: Gerwin Klein <gerwin.klein@proofcraft.systems>
This commit is contained in:
Gerwin Klein
2021-06-17 14:37:42 +10:00
committed by Gerwin Klein
parent 32728ecd1f
commit 34f0666806
8 changed files with 2354 additions and 179 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
LICENSES/LicenseRef-Trademark.txt Normal file
View File

@@ -0,0 +1,8 @@
The files in directory `manual/logos/` are trademarks of their
respective owners.
For license and usage guidelines on the seL4 trademark and logo,
including the seL4 Foundation logo, see
https://sel4.systems/Foundation/Trademark/
No further license is granted from use in this repository.

118
manual/disy.sty
View File

@@ -1,118 +0,0 @@
%
% Copyright 2020, Data61, CSIRO (ABN 41 687 119 230)
%
% SPDX-License-Identifier: BSD-2-Clause
%
% disy.sty
%
% Document style for reports by the UNSW Distributed Systems and
% Operating Systems (DiSy) group.
%
% Uses Andrew O'Brien's fancy title page...
%
% Written 2000-08-12 by Gernot Heiser <gernot@unsw.edu.au>
%
% $Id: disy.sty,v 1.2 2009-02-04 03:13:15 ikuz Exp $
% OPTIONS:
% color: use colour logos
% cmyk: will generate cmyk colours rather than rgb colours
% this may prove more reliable on some printers
% but is inclined to look odd on monitors
%
% COMMANDS:
% \AuthorEmail Author's email address (default: disy@cse)
\ProvidesPackage{disy}
\RequirePackage{graphicx}
\RequirePackage{url}
\RequirePackage{color}
\DeclareOption{color}{\Colortrue}
\DeclareOption{colour}{\Colortrue}
\DeclareOption{cmyk}{\CMYKtrue}
\newif\ifColor \Colorfalse
\ProcessOptions
\ifColor
\ifCMYK
%\definecolor{special_green}{cmyk}{1.0,0.0,0.69,0.43}
\else
%\definecolor{special_green}{rgb}{.020,.426,.328}
\fi
\else
%\definecolor{special_green}{cmyk}{0,0,0,1} % black
\fi
\newif\ifHave@HyperRef\Have@HyperReffalse
\AtBeginDocument{\@ifpackageloaded{hyperref}{\Have@HyperReftrue}{}}
\newcommand{\AuthorEmail}[1]{\def\AuthorEmailString{#1}}
\newcommand{\CrestFileName}{\ifColor unicrest-colour\else unicrest-screen\fi}
\AuthorEmail{disy@cse.unsw.edu.au}
\newlength{\centeroffset}
\setlength{\centeroffset}{-0.5\oddsidemargin}
\addtolength{\centeroffset}{0.5\evensidemargin}
\def\maketitle{
% to suppress overfull bars in ``draft'' mode:
\newlength{\saveOverfullRule}
\setlength{\saveOverfullRule}{\overfullrule}
\setlength\overfullrule{0pt}
\thispagestyle{empty}
\vspace*{\stretch{1}}
\noindent\hspace*{\centeroffset}
\begin{minipage}{\textwidth}\flushright%
\urlstyle{sf}%
\raisebox{34mm}[0pt][0pt]{%
\newcommand{\LogoW}{21mm}%
\newlength{\ERTOSw}%
\settowidth{\ERTOSw}{{\sf\large https://sel4.systems}}%
\noindent\sf%
\begin{minipage}[b]{\textwidth}\sf\large%
\hspace*{-10mm}%
\end{minipage}%
\hspace*{-4mm}%
}%
%
\flushright
{\Huge\bfseries
\@title\\}
\vspace*{\stretch{2}}
\noindent\rule[-1ex]{\textwidth}{5pt}\\[2.5ex]
{\Large \bfseries \@author}\\
\urlstyle{sf}
\ifHave@HyperRef
\url{\AuthorEmailString}\\[2ex]
\else
\AuthorEmailString\\[2ex]
\fi
{\sf \hfill{\Large \@date}}\\[2ex]
\end{minipage}
\vspace{\stretch{1}}
\noindent\hspace*{\centeroffset}\begin{minipage}{\textwidth}
\flushright
\end{minipage}
\vspace{\stretch{2}}
\vfill
\begin{minipage}{\textwidth}
\flushright
{\noindent\sf%
}
\end{minipage}
\clearpage
% reset overfull rule
\setlength{\overfullrule}{\saveOverfullRule}
}%\maketitle

BIN
manual/logos/blacktriangle.pdf Normal file
View File

Binary file not shown.

2
manual/logos/blacktriangle.pdf.license Normal file
View File

@@ -0,0 +1,2 @@
Copyright 2020, Data61, CSIRO (ABN 41 687 119 230)
SPDX-License-Identifier: CC-BY-SA-4.0

1974
manual/logos/seL4-Foundation-logo.pdf Normal file
View File

File diff suppressed because one or more lines are too long

2
manual/logos/seL4-Foundation-logo.pdf.license Normal file
View File

@@ -0,0 +1,2 @@
Copyright seL4 Project a Series of LF Projects, LLC
SPDX-License-Identifier: LicenseRef-Trademark

116
manual/manual.tex
View File

@@ -4,18 +4,18 @@
% SPDX-License-Identifier: GPL-2.0-only
%
\documentclass[a4paper,11pt,twoside]{report}
\usepackage[colour,nictaonly]{disy}
% Setting this to true turns on the `draft' watermark
\newif \ifDraft \Draftfalse
%\Drafttrue
\documentclass[english,a4paper,11pt,twoside\ifDraft,draft\fi]{report}
\usepackage{sel4}
\usepackage[authoryear]{natbib}
\def\cite{\citep}
\newif \ifxeightsix \xeightsixtrue
\usepackage[margin=33mm]{geometry}
\usepackage{graphicx}
\usepackage{cite,url,fancyhdr}
\usepackage{url}
% Draft support
\ifDraft
@@ -29,16 +29,14 @@
\date{}
\fi
\pagestyle{fancyplain}
\lhead[\fancyplain{}{\sl\thepage}]{\fancyplain{}{\sl\rightmark}}
\chead{}
\rhead[\fancyplain{}{\sl\leftmark}]{\fancyplain{}{\sl\thepage}}
\lfoot[\fancyplain{\sl\thepage}{}]{}
\cfoot{}
\rfoot[]{\fancyplain{\sl\thepage}{}}
\pagestyle{fancyplain}
\lhead[\fancyplain{}{\thepage}]{\fancyplain{}{\rightmark}}
\chead{}
\rhead[\fancyplain{}{\leftmark}]{\fancyplain{}{\thepage}}
\lfoot[\fancyplain{\thepage}{}]{}
\cfoot{}
\rfoot[]{\fancyplain{\thepage}{}}
\usepackage[T1]{fontenc}
\usepackage{lmodern}
\usepackage{listings}
\usepackage{multirow}
\usepackage{setspace}
@@ -49,12 +47,6 @@
\usepackage[htt]{hyphenat}
\renewcommand{\captionfont}{\small}
% Hyperlinks and Colors
\usepackage{color}
%\definecolor{linkcolor}{rgb}{.000,.348,.508}
\definecolor{linkcolor}{rgb}{0, 0, 0}
\usepackage[colorlinks=true,linkcolor=linkcolor,citecolor=linkcolor,
filecolor=linkcolor,pagecolor=linkcolor,urlcolor=linkcolor]{hyperref}
\renewcommand{\chapterautorefname}{Chapter}
\renewcommand{\sectionautorefname}{Section}
\renewcommand{\subsectionautorefname}{Section}
@@ -82,18 +74,18 @@
\newcommand{\version}{\input{VERSION}}
\newcommand{\rtm}{\textsuperscript{\textregistered}}
% Read information about the repository.
\input{env}
% Don't indent paragraphs; instead, just leave some vertical space.
\parindent 0pt\parskip 6pt
\begin{document}
\title{seL4 Reference Manual\\Version \version}
\title{seL4\\ Reference Manual}
\subtitle{Version \version}
\author{seL4 Foundation}
\AuthorEmail{https://sel4.systems}
\email{https://sel4.systems}
\date{\commitdate}
\maketitle
@@ -103,20 +95,23 @@
\vfill
% Don't indent paragraphs; instead, just leave some vertical space.
\parindent 0pt\parskip 6pt
\copyright\ the seL4 authors and contributors.\\
\textsc{All rights reserved}.
\textsc{All rights reserved}.\\
\\
\vspace{2ex}
% SPDX statement on its own line silences license checker warnings
\texttt{
SPDX-License-Identifier: GPL-2.0-only
\texttt{%
SPDX-License-Identifier: GPL-2.0-only
}\\
You may use this manual and its sources under the terms of the GPL license,
version 2.\\
You may use this manual and its sources under the terms of the GPL license, version 2.
seL4\textregistered\ is a trademark of LF Projects, LLC.\\
Arm\textregistered\ is a registered trademark of Arm Limited.\\
RISC-V\textregistered\ is a registered trademark of RISC-V International.\\
\vspace{2ex}
seL4\rtm\ is a trademark of LF Projects, LLC.\\
Arm\rtm\ is a registered trademark of Arm Limited.\\
RISC-V\rtm\ is a registered trademark of RISC-V International.
% Acknowledgements
\thispagestyle{empty}
@@ -125,32 +120,31 @@
\begin{abstract}
% This list of contributors is based on the hg log. If you make commits please
% add your name in alphabetical order.
The primary authors of this document are Matthew~Grosvenor and Adam~Walker,
The primary authors of this document are Matthew Grosvenor and Adam Walker,
with contributions from
Adrian~Danis,
Andrew~Boyton,
Anna~Lyons,
Axel~Heider,
Branden~Robinson,
David~Greenaway,
Etienne~Le~Sueur,
Gernot~Heiser,
Gerwin~Klein,
Godfrey~van~der~Linden,
Jimmy~Brush,
Kevin~Elphinstone,
Matthew~Fernandez,
Matthias~Daum,
Michael~von~Tessin,
Nick~Spinale,
Peter~Chubb,
Simon~Winwood,
Thomas~Sewell,
Timothy~Bourke and
Toby~Murray.
\\
\\
All authors and contributors can be contacted via the seL4 Developer Mailing
Adrian Danis,
Andrew Boyton,
Anna Lyons,
Axel Heider,
Branden Robinson,
David Greenaway,
Etienne Le~Sueur,
Gernot Heiser,
Gerwin Klein,
Godfrey van der Linden,
Jimmy Brush,
Kevin Elphinstone,
Matthew Fernandez,
Matthias Daum,
Michael von Tessin,
Nick Spinale,
Peter Chubb,
Simon Winwood,
Thomas Sewell,
Timothy Bourke, and
Toby Murray.
The authors and contributors can be contacted via the seL4 Developer Mailing
List or the seL4 Discourse Forums. See \url{https://sel4.systems/contact.html}
for details.
\end{abstract}
@@ -186,7 +180,7 @@ for details.
% Bibliography
\cleardoublepage
\bibliographystyle{alpha}
\bibliographystyle{plainnat}
\bibliography{references}
\end{document}

313
manual/sel4.sty Normal file
View File

@@ -0,0 +1,313 @@
% Copyright seL4 Project a Series of LF Projects, LLC
% SPDX-License-Identifier: CC-BY-SA-4.0
\NeedsTeXFormat{LaTeX2e}
\ProvidesPackage{sel4}[2020/09/24 v1.0 seL4 Foundation letterhead and title page]
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Letterhead and title page for the seL4 Foundation
%
% Written 2020-03-23 by Gernot Heiser <gernot@sel4.systems>
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% OPTIONS:
% noBanner: no black banner underneath the logo
% makeTitle: generate the title header even if there is no \maketitle command
% copyright: generate the copyright footer with the present year
%
%
% COMMANDS:
% - INPUTS:
% \title Document title in header, default: none
% \subtitle Document subtitle title in header, ignored if title is empty
% \author Document author, ignored if title is empty
% \authortitle Title of author, ignored if author is empty
% \email Contact email, ignored if author is empty
% \docversion Document version
% \date Date of document, default \today, ignored if title is empty
% \header Organisation/originator to go in TRHS of header, multiple lines
% default: "The seL4 Foundation"
% \theurl Org URL, default: seL4 Foundation URL
% \copyYear Year of copyright (default: this year)
% - OUTPUTS:
% \doCopyright Produces the copyright notice, must be placed
% right after \maketitle
% The `copyright' option is equivalent to \doCopyright immediately after \maketitle
% \thedocversion Document version string
% \thedate Date string
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\newif\ifb@nner\b@nnertrue
\newif\ifm@aketitle\m@aketitlefalse
\newif\ifc@pyright\c@pyrightfalse
%% options section
\DeclareOption{noBanner}{\b@nnerfalse}
\DeclareOption{makeTitle}{\m@aketitletrue}
\DeclareOption{copyright}{\c@pyrighttrue}
\ProcessOptions\relax
%% package section
\RequirePackage[margin=25mm]{geometry}
\RequirePackage{fancyhdr}
\RequirePackage{enumitem}
\RequirePackage{parskip}
\RequirePackage{sfmath}
\RequirePackage{graphicx}
\usepackage[T1]{fontenc}
\usepackage[sfdefault]{roboto}
\RequirePackage{xcolor}
\RequirePackage[iso]{isodate}
\RequirePackage{hyperref}
% Coloured quoted text:
% \RequirePackage[breakable]{tcolorbox}
\usepackage[breakable]{tcolorbox}
\if@titlepage
\typeout{sel4 style with titlepage}
\else
\typeout{sel4 style without titlepage}
\fi
%% Foundation colour scheme:
\definecolor{greenLight}{HTML}{C0DF9A}
\definecolor{greenLogo}{HTML}{96CA50}
\definecolor{greenDark}{HTML}{668B37}
\definecolor{accentLight}{HTML}{D5AEAA}
\definecolor{accent}{HTML}{AC5D55}
\definecolor{accentDark}{HTML}{820C00}
\definecolor{emphasisLight}{HTML}{FFE0A2}
\definecolor{emphasis}{HTML}{FFCA5F}
\definecolor{emphasisDark}{HTML}{B78B41}
% white (already defined)
\definecolor{neutralLighter}{HTML}{D6DBE4}
\definecolor{neutralLight}{HTML}{8897AE}
\definecolor{neutral}{HTML}{385378}
\definecolor{neutralDark}{HTML}{263852}
% black (already defined)
\colorlet{logoGreen}{greenLogo}
\colorlet{seL4Green}{greenLogo}
% hyperref
\hypersetup{colorlinks, allcolors=neutral, anchorcolor=black,
citecolor=greenDark, linkcolor=greenDark}
% tcolorbox
\newtcolorbox{cquote}{colback=neutralLighter,boxrule=0pt,boxsep=0pt,breakable}
\renewenvironment{quote}
{\list{}{\rightmargin=2ex \leftmargin=4ex}%
\item\relax\cquote}
{\endcquote\endlist}
%% definitions
\renewcommand{\familydefault}{\sfdefault}
\def\h@eader{The seL4\textsuperscript\textregistered\ Foundation\\\\}
\def\u@rl{https://sel4.systems/Foundation}
\def\@title{}
\def\@subtitle{}
\def\@author{}
\def\@authortitle{}
\def\@email{}
\def\@docversion{}
\def\@date{\today}
\def\header#1{\def\h@eader{#1}}
\def\theurl#1{\def\u@rl{#1}}
\def\title#1{\def\@title{#1}}
\def\subtitle#1{\def\@subtitle{#1}}
\def\author#1{\def\@author{#1}}
\def\authortitle#1{\def\@authortitle{#1}}
\def\email#1{\def\@email{#1}}
\def\docversion#1{\def\@docversion{#1}}
\def\thedocversion{\@docversion}
\def\date#1{\def\@date{#1}}
\def\thedate{\value\@date}
\def\thanks{\undefined}
\newcommand{\Logo@FileName}{logos/seL4-Foundation-logo.pdf}
\newcommand{\Triang@FileName}{logos/blacktriangle.pdf}
\newcommand{\L@ogo}{\includegraphics[keepaspectratio=true,height=23mm]{\Logo@FileName}}
%%% Produces copyright notice as a pseudo footnote without a footnote mark
% Use it right at the top, or just after \maketitle. The optional argument is the year of the
% copyright, it defaults to the current year.
\newif\ifc@pyrightdone\c@pyrightdonefalse
\newcommand{\doCopyright}[1][\the\year]{%
\ifc@pyrightdone\else%
\let\s@makefnmark=\@makefnmark%
\let\@makefnmark\relax%
\footnote{%
\hspace*{-1.8em}% Magic number from article.cls/report.cls
Copyright \copyright~#1 seL4 Project a Series of LF Projects, LLC.\\
Distributed under the
\href{https://creativecommons.org/licenses/by-sa/4.0/legalcode}{Creative
Commons Attribution-ShareAlike 4.0 International (CC~BY-SA~4.0) License.}\\
seL4 is a trademark of LF Projects, LLC.
}
\let\@makefnmark=\s@makefnmark%
\c@pyrightdonetrue%
}
%% the part of the headers that's common with or without titlepage
\def\m@akeheader{%
\begin{minipage}[b]{\paperwidth}%
\hspace*{16mm}%
\raisebox{2.5mm}[38mm][0mm]{\L@ogo}%
\hfill
\raisebox{4mm}{%
\footnotesize%
\textcolor{greenLogo}{
\begin{tabular}[b]{r}\bf
\raisebox{0pt}[0pt][10mm]{\rule{0pt}{8mm}}%
\begin{tabular}[t]{r@{}}
\h@eader
\end{tabular}\\
% force URL colour to be green or black, irrespective of hyperref setup
\bf\href{\u@rl}{\textcolor{greenLogo}\u@rl}
\end{tabular}
}%
}\hspace*{5mm}
\end{minipage}%
}%
%% the main thing: \maketitle produces the letterhead
\if@titlepage
\renewcommand\maketitle{%
\noindent%
\begin{titlepage}%
\urlstyle{sf}
% to suppress Overfull \hbox warnings
\newlength{\saveHfuzz}
\setlength{\saveHfuzz}{\hfuzz}
\setlength{\hfuzz}{\paperwidth}
%
\let\footnotesize\small
\let\footnoterule\relax
\let \footnote \thanks
% laying out the background
\newlength{\img@raise}%
\newlength{\img@shift}%
% the black triangle
\setlength{\img@raise}{-\paperheight}%
\addtolength{\img@raise}{\Gm@tmargin}%
\addtolength{\img@raise}{4.2mm}% don't ask me why!
\setlength{\img@shift}{-\Gm@lmargin}%
% make black triangle extend 0.1mm beyond margins to prevent a white line
\newlength{\img@width}\setlength{\img@width}{1.001\paperwidth}%
\newlength{\img@height}\setlength{\img@height}{1.001\paperheight}%
\addtolength{\img@shift}{-0.0005\paperwidth}\addtolength{\img@raise}{-0.0005\paperheight}%
% \typeout{paperheight=\the\paperheight,
% paperwidth=\the\paperwidth,
% Gm@lmargin=\Gm@lmargin,
% Gm@tmargin=\Gm@tmargin,
% img@raise=\the\img@raise,
% hfuzz=\the\hfuzz}
\raisebox{\img@raise}[0pt][0pt]{\hspace*{\img@shift}%
\makebox[0pt][l]{%
\includegraphics[keepaspectratio=false,width=\img@width,height=\img@height]{\Triang@FileName}%
}%
}
% header
\raisebox{4mm}[0pt][0pt]{\hspace*{-\Gm@tmargin}%
\m@akeheader
}%
%
\null%\vfil
\raggedright% to prevent stuff shifting
\vskip 50mm%
~\hfill%
\makebox[0pt][r]{
\raisebox{0pt}[0pt][0pt]{
\begin{minipage}{150mm}
\raggedleft
\fontsize{36}{42}\selectfont \textcolor{greenLogo}{\@title}\\%
\if\@subtitle\empty
~
\else
\fontsize{36}{42}\selectfont \textcolor{emphasis}{\@subtitle}
\fi%
\end{minipage}
\hspace*{-10mm}
}
}
\vskip 70mm
\makebox[0pt][l]{
\hspace*{-13mm}
\raisebox{0pt}[0pt][0pt]{
\begin{minipage}{70mm}%
\raggedright%
\color{neutral}
\fontsize{20}{26}\selectfont%
\@author\par
\fontsize{14}{22}\selectfont%
\ifx\@authortitle\empty\else\@authortitle\par\fi
\ifx\@email\empty\else\@email\par\fi
\ifx\@docversion\empty\else\@docversion\par\fi
\ifx\@date\empty\else\@date\par\fi
\end{minipage}
}
}
\setcounter{page}{0}
\end{titlepage}%
\thispagestyle{fancyplain}
\setlength{\hfuzz}{\saveHfuzz}%
\setcounter{footnote}{0}%
\global\let\thanks\relax
\global\let\maketitle\relax
\global\let\@thanks\@empty
\global\let\@author\@empty
\global\let\@date\@empty
\global\let\@title\@empty
\global\let\title\relax
\global\let\author\relax
\global\let\date\relax
\global\let\and\relax
\setcounter{page}{0}
\m@aketitlefalse
}
\else% no titlepage
\def\maketitle{\urlstyle{sf}
% to suppress overfull bars in ``draft'' mode:
\newlength{\saveOverfullRule}
\setlength{\saveOverfullRule}{\overfullrule}
\setlength\overfullrule{0pt}
%
\noindent%
\raisebox{0mm}[0pt][0pt]{\hspace*{-25mm}%
\ifb@nner\makebox[0pt][l]{\rule{\paperwidth}{40mm}}\fi% black banner
\m@akeheader
}%
% reset overfull rule
\setlength{\overfullrule}{\saveOverfullRule}%
\vspace*{12mm}%
\ifx\@title\empty \else%
\begin{center}
{\LARGE\bf\@title\\[1ex]}
\ifx\@subtitle\empty \else{\Large\@subtitle} \\[1ex]\fi%
\ifx\@author\empty \else
{\Large\@author
\ifx\@authortitle\empty\else{\large\\\@authortitle}\fi
\ifx\@email\empty\else{\normalsize\\\@email}\fi
\\[1ex]}%
\fi%
\ifx\@docversion\empty\else\@docversion\\\fi
\ifx\@date\empty \else\@date \\\fi%
\vspace{5ex}%
\end{center}%
\fi%
\m@aketitlefalse
}%\maketitle
\fi% no titlepage
\AtBeginDocument{%
\ifm@aketitle%
\maketitle%
\let\maketitle\relax%
\m@aketitlefalse%
\fi%
\ifc@pyright%
\doCopyright%
\fi%
}