path: root/Master/texmf-dist/doc/latex/ycbook/ycbook-doc.tex

% ======================================================================
% ycbook-doc.tex
% Copyright (c) Youssef Cherem <ycherem(at)gmail.com>, 2016
%
% This file is part of the ycbook LaTeX2e class.

% This work may be distributed and/or modified under the conditions of
% the LaTeX Project Public License, version 1.3c of the license.
% The latest version of this license is in
%   http://www.latex-project.org/lppl.txt
% and version 1.3c or later is part of all distributions of LaTeX
% version 2005/12/01 and of this work.
%
% This work has the LPPL maintenance status "author-maintained".
% ======================================================================

\documentclass[withmarginpar,titleauthor,11pt]{mwart}
%\renewcommand{\sectsettings}{\sffamily\bfseries}
\usepackage[english]{babel}
\usepackage[dvipsnames,svgnames]{xcolor}
\usepackage{fontspec}
\setmainfont{Minion Pro}[Numbers=OldStyle]
\setmonofont{Fira Mono}[Scale=MatchLowercase]
\setsansfont{Myriad Pro Light}
%\setsansfont{Fira Sans Book}[BoldFont={FiraSans-Bold},BoldItalicFont={FiraSans-BoldItalic},Scale=.9] 
%\setmonofont[Scale=0.8,Color=Teal]{Fira Mono}
\usepackage{tikz}
\usetikzlibrary{shapes,snakes,shadings,shadows,shapes.geometric,decorations,positioning,arrows,decorations.pathmorphing}
\usepackage[framemethod=tikz]{mdframed}
\surroundwithmdframed[linecolor=MediumPurple,skipabove=10pt,skipbelow=6pt, backgroundcolor=Thistle!50,roundcorner=6pt
]{verbatim}%roundcorner=10pt,
%MediumSeaGreen
%OrangeRed
\usepackage{hyperref}
\usepackage{fancyvrb}
\usepackage{multicol}
\frenchspacing 

\hyphenation{Bring-hurst}

\newcommand{\flor}{\fontspec{Minion Pro}}
\newcommand{\folhadireita}{\fontspec{Minion Pro}}
\newcommand{\duasondas}{\fontspec{Minion Pro}   }


\SetSectionFormatting{section}
{24pt plus5pt minus2pt} %space before
{\normalfont\centering\scshape\large\ifHeadingNumbered
		\HeadingNumber.\enspace\fi
		\HeadingText}
{10pt plus3pt}%space after

\SetSectionFormatting{subsection}
{16pt plus4pt minus2pt}
{\FormatHangHeading{\normalfont\itshape}}
{6pt plus2pt}


\usepackage[style=authoryear-icomp]{biblatex}
\addbibresource{ycbook-bibliografia.bib}
\DeclareFieldFormat{url}{\url{#1}}

%\usepackage[justification=raggedright,font={sf},labelfont=bf]{caption}
%\usepackage{picinpar}

\setlength{\marginparwidth}{1.3in}


\newcommand{\option}[1]{\marginpar{\footnotesize \textit{#1}}}
\newcommand{\opt}[1]{<<\textit{#1}>>}
%\newcommand{\opt}[1]{\texttt{#1}}


\title{\estrela{\textit{ycbook}}\\
		\tikz \node[left color=PineGreen,rectangle,remember picture, overlay,rounded corners=3pt] at (0,0) {A versatile and simple book class};\\
		\tikz \draw[teal,remember picture, overlay,thick] (-4.2,0.2) -- (4,0.2);%
%\tikz \node[remember picture,overlay] at (7,5) {\florgrande};% 
%
}
\author{\addfontfeatures{Style=Swash}\textit{Youssef Cherem}\\ \href{mailto:ycherem@gmail.com}{ycherem@gmail.com}}
\date{MMXVI\\ \folhadireita% %
}


\usepackage%[headsepline]
{scrlayer-scrpage}
%\addtokomafont{headsepline}{\color{JungleGreen}} %yes, works on other classes as well
\pagestyle{scrheadings}
\clearscrheadfoot
%\chead{}
%\cehead{}
\newcommand{\bola}{\tikz \node [top color=SpringGreen, shading angle=45,circle,drop shadow] at (0,0) {\thepage};}
\cfoot*{\upshape\bfseries\large\addfontfeatures{Numbers=Lining}\bola}

\newcommand{\estrela}[1]{\tikz \node [top color=SpringGreen,star,star points=7] at (0,0) {#1};}%,star point ratio=0.8 % shading angle=45,

\newcommand\fadingtext[3][]{%
	\begin{tikzfadingfrompicture}[name=fading letter]
		\node[text=transparent!0,inner xsep=0pt,outer xsep=0pt,#1] {#3};
	\end{tikzfadingfrompicture}%
	\begin{tikzpicture}[baseline=(textnode.base)]
	\node[inner sep=0pt,outer sep=0pt,#1](textnode){\phantom{#3}}; 
	\shade[path fading=fading letter,#2,fit fading=false]
	(textnode.south west) rectangle (textnode.north east);% 
	\end{tikzpicture}% 
}

\newcommand{\florgrande}{%
	\fadingtext[scale=6]{top color=Dandelion,bottom color=PineGreen,shading angle=45}{\flor}
	}


\begin{document}
	
	\maketitle
\thispagestyle{scrheadings}


\begin{abstract}
This class is intended to be an interpretation of the \textit{mwbk} class from Mar\-cin Wo\-li\'{n}s\-ki's \textit{mwcls} classes. The \textit{mwcls} classes are simple, yet powerful and customizable classes that allow the end-user to customize the layout of headers, headings etc. They also have the benefit of being more economic in space than the most common \LaTeX\ classes, while keeping a clear appearance and a smooth flow. 
\end{abstract}

\section*{The reasons for this class}
Although many usual \LaTeX\ packages offer a wide array of solutions for text block and margin specifications, and although some of them, notably Koma-Script \parencite{koma-script} allow and facilitate the application of ``classical" canons of page construction \parencite{tschichold_form_1991,bringhurst_elements_2013}, one may have several reasons to avoid this aesthetic solution. One reason is that these page construction methods were intended, obviously, for handwritten or printed material. Even assuming the material is to be printed, one reason to find an alternative is economic and environmental: the more paper you print, the more it will cost---both in terms of money and environmental impact. But the user also wishes to avoid a sloppy solution, squeezing as much content as possible onto the page just to save space. The compromise solution would be somewhat closer to what most commercial books look like---without jeopardizing legibility. In fact, it is rare to find a book that looks like it has been laid out according to the ``canons". That is one motive why I find the \textit{mwcls} classes \parencite{mwcls} useful. Besides,  \textit{mwcls} alternatives for basic classes (\textit{mwart} for articles,  \textit{mwrep} for reports and \textit{mwbk} for books) allow the user to easily modify headings, being somewhat more flexible and providing a simpler interface than some alternative classes. All I did was to provide a more user-friendly syntax for some common tweaks and more alternatives to some rather unusual page (numbering) styles available by default in \textit{mwbk} and \textit{mwrep}. As for the \textit{mwart} class, I did not find anything to be changed---although the user might adapt some of the options presented in the \textit{ycbook} class.



\section{Options for chapter and section}
To add a rule below chapter and section titles, use \opt{chapterrule} and
\opt{sectionrule}. Other sectional headings may be changed likewise:

\option{chapterrule}
\option{sectionrule}


\begin{verbatim}
	\SetSectionFormatting{section}
	{24pt plus5pt minus2pt} %space before
	{\large\textbf{\ifHeadingNumbered
	\HeadingNumber.\enspace\fi
	\HeadingText}\\\rule[10pt]{\hsize}{0.4pt}}
	{10pt plus3pt}%space after
\end{verbatim}

\option{chaptercentered}
\option{chapterleft}
\option{chapterright}

Options \opt{chaptercentered}, \opt{chapterleft}, and \opt{chapterright} control chapter alignment.  

Options \opt{nochaptercentered}, \opt{nochapterleft}, and \opt{nochapterright} control chapter alignment and exclude the name “Chapter” from the entry. The default, as in the \textit{mwcls} classes, is \opt{chapterleft}. \option{nochaptercentered}
\option{nochapterleft}
\option{nochapterright}


\section{Options for headings}
\option{headings}
\option{headings=beforeplain}
\option{myheadings}
\option{myheadings=beforeplain}

\textit{mwbk} has empty pagestyles for chapters, and for the last page in every chapter, and also the usual blank (empty) page so that a chapter always starts with an odd (\textit{recto}) page. Page numbering with headers has been added the last page of every chapter; chapter opening pages have been changed to the \textit{plain} style, and the options to the left have been added for ease of use. Options \opt{headings=beforeplain} and \opt{myheadings=beforeplain} have been added, in which an even page finishing a chapter takes the \opt{plain} style. The default option is \opt{headings}.


\verb|\pagestyle{uheadings}| and \verb|\pagestyle{myuheadings}| may be used instead, defaulting to more usual parameters, and in which the header is separated by a thin line.

This class is compatible with the \verb|scrlayer-scrpage| (formerly \verb|scrpage2|) for headers and footers, so you can do fun things like this to color your header line:


\begin{verbatim}
\usepackage[headsepline]{scrlayer-scrpage}
\addtokomafont{headsepline}{\color{JungleGreen}}
\usepackage[dvipsnames,svgnames,x11names]{xcolor}
\pagestyle{scrheadings}
\end{verbatim}

And of course simpler things such as:

\begin{verbatim}
\usepackage{scrlayer-scrpage}
\clearpairofpagestyles
\pagestyle{scrheadings}
\ofoot{\pagemark}
\chead{A centered heading}
\end{verbatim}

For additional information, see chapters 5 and 18 of the Koma-Script manual.

\section{Table of contents styles}
\option{toc} The \opt{toc} option uses the Ko\-ma-\-Script-bundle for table of contents styles, so you can, for example, define 
\verb|\usetocstyle{nopagecolumn}|
for another style.

%\section{Captions}
%Captions have been redefined with the \verb|caption| package with the following parameters: \verb|justification=raggedright,font={sf},labelfont=bf|.
%
%\marginpar{\includegraphics[width=\marginparwidth]{apparition-fogg}
%	\captionof{figure}{\textit{L'apparition}, by Gustave Moreau, 1876--1877. Fogg Art Museum.}
%	}



\section{Margin paragraphs and footnotes}
\option{sansserifnotes} The option \opt{sansserifnotes} changes all footnotes to sans serif. 

Marginpars were redefined, so that they only appear on the right side of the page, either on an odd or an even page. You can choose to turn all footnotes into margin notes with the \textit{footmisc} package:

\begin{verbatim}
\usepackage[side,ragged,flushmargin]{footmisc}
\end{verbatim}

\section{Other options}
All other options from the \textit{mwcls} classes are available, e.g.:

\begin{multicols}{2}

\begin{itemize}
\item \texttt{floatssmall}; 
\item \texttt{floatsnormalsize}; 
\item \texttt{sfheadings};
\item \texttt{authortitle} (default); 
\item \texttt{titleauthor}; 
\item \verb|\renewcommand{\sectsettings}{}|; 
\item \verb|\SetTOCIndents|, 
\item \verb|indentfirst| and \verb|noindentfirst|, 
\item \verb|wide|, for shorter margins, and
\item font size and paper specifications (\texttt{12pt}, \texttt{a5paper}, etc.). 
\end{itemize}
\end{multicols}

\section{Figures spreading over two pages}

Thanks to Martin Scharrer,\footnote{\url{http://tex.stackexchange.com/a/23865/9424}} 
 we also have \verb|\twopagepicture| (for numbered pictures) and \verb|\twopagepicturen| (for unnumbered pictures) to automatically split a picture on a spread (left and right pages). 

It works thus: \verb|\twopagepicture{image place regarding the caption}|\\ \verb|{text width or page width}{image}{caption}|:

\begin{itemize}
	\item \verb|\twopagepicture{b}{l}{image}{Test}|: image below caption (“b”), same width as text (“l”);
	\item \verb|\twopagepicture{t}{l}{image}{Test}|: image above caption (“t”), same width as text (“l”);
	\item \verb|\twopagepicture{b}{p}{image}{Test}|: image below caption (“b”), same width as page (“p”), and 
	\item \verb|\twopagepicture{t}{p}{image}{Test}|: image above caption (“t”), same width as page (“p”),
\end{itemize}

%\section{Implementation}
%
%
%\lstinputlisting{ycbook.cls}

%\marginpar{\textit{\small This document was typeset with XXX}}

\printbibliography

\end{document}