% This file is part of the
% The Online BRT Planning Guide
%
% DO NOT EDIT THIS FILE MANUALLY!
%
% This file has been automatically generated from its sources
% using the OBRT tool:
%  tool version: 364c3e5
%  haxe version: 3.4.0
%  runtime: JS
%  platform: Linux

\chapter{34}{Manual to collaboration}
\label{volume:meta:chapter:manual-to-collaboration}
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 1-120: code points 1-8

Newcomers to git\par
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 3-3: code points 1-16

Git is a computer program [ideally] to be installed on a contributor’s computer, where it shall manage a copy (clone) of the required content to produce the BRT Planning Guide (this repository) and submit proposals for changes. Git is originally a command line tool, but there are several graphic tools. It may require a two hour effort to install it and learn the basics of using it without assistance and 20 minutes with assistance. More about git in the Pro Git book (https:\slash{}\slash{}git-scm.com\slash{}book\slash{}en\slash{}v2).\par
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 5-9: code points 1-68

Github is a website that hosts repositories like this one, where contribution from several people can be centralized, its use is free for open-source projects. Contributors to the BRT Planning Guide are required to have a github account, with that only it is possible to submit changes proposals to the guide, although it is not practical for large ones.\par
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 11-13: code points 1-116

To simply navigate through folders and files make sure you click on the file name (in light blue on the left side) and NOT in the gray message in the middle of the same container (that will lead you to the last changes on the file)\par
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 15-16: code points 1-116

Files structure\par
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 18-18: code points 1-15

Generator directory holds code files that will process the content in the Guide directory, which contains the source (text files and assets as images referenced in the text files) for the BRT Planning Guide, the dot files have configuration information (describing where and how processing the repository must take place and about git itself).\par
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 20-23: code points 1-90

The content in the guide\par
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 25-25: code points 1-24

At the moment, the entry point of processing is in the file guide\slash{}the-guide.src, where other files are pointed with the \code{\textbackslash{}include\{point\slash{}to\slash{}other\slash{}file.src\}} command. A user manual on how to contribute and of the supported syntax is being developed in the chapter called Manual for Collaboration.\par
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 27-30: code points 1-32

\section{1}{Getting started}
\label{volume:meta:chapter:manual-to-collaboration:section:getting-started}
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 34-36: code points 1-8

To do...\par
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 36-36: code points 1-8

\section{2}{Basic text}
\label{volume:meta:chapter:manual-to-collaboration:section:basic-text}
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 40-88: code points 1-17

Simple, continuous text is the most basic and essential element, and can \emphasis{usually} be simply typed in the source files.\par
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 42-42: code points 1-119

Paragraphs can be split into several lines for improved readibility. Instead, paragraphs end at blank lines, or more specificaly, visibly empty lines.\par
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 44-45: code points 1-81

\begincode
This is the first paragraph.
This previous line break didn't end this paragraph.

Now *this* is a new paragraph, because of the
previous empty line.
\endcode
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 47-53: code points 1-4

\subsection{1}{Reserved characters and escaping}
\label{volume:meta:chapter:manual-to-collaboration:section:basic-text:subSection:reserved-characters-and-escaping}
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 55-61: code points 1-197

The most important character with special meaning is the backslash (\code{\textbackslash{}}). It’s used to indicate with instructions are special commands (like the \code{\textbackslash{}item} command), and to use special characters like normal characters.\par
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 57-58: code points 1-147

The backslash itself can be typed as regular text, as in “a \textbackslash{} backslash”, by typing \code{a \textbackslash{}\textbackslash{} backslash}. By preceding any special character, such as the backslash itself, with another backslash, we indicate that we want that otherwise special character to appear in the output; this is called escaping.\par
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 60-61: code points 1-197

\subsection{2}{Commands}
\label{volume:meta:chapter:manual-to-collaboration:section:basic-text:subSection:commands}
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 63-67: code points 1-214

In other to provide more than simple text, but at the same time keep the input readable in simple text editors and compatible with version control systems like git, the backslash (\code{\textbackslash{}}) can be used to denote calls to some available commands. These range from text annotation commands (like \code{\textbackslash{}code} or \code{\textbackslash{}emph}) to more complex elements (like \code{\textbackslash{}figure} or \code{\textbackslash{}begintable}).\par
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 65-65: code points 1-394

Commands can take (and usually require) arguments, and those can be typed wraped in braces (\code{\textbackslash{}emph\{some important text\}}), when they are mandatory, or in brackets (\code{\textbackslash{}figure[small]}), if they are optional.\par
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 67-67: code points 1-214

\subsection{3}{Subscripts and superscripts}
\label{volume:meta:chapter:manual-to-collaboration:section:basic-text:subSection:subscripts-and-superscripts}
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 69-80: code points 1-9

Subscripts and superscripts, such as in 1\textsuperscript{fst} or n\textsubscript{th}, can be added to text by using, respectively, the \code{\textbackslash{}sup} and \code{\textbackslash{}sub} commands. Some examples are show in table X.\par
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 71-72: code points 1-35

\tabletitle{1}{Example subscript and superscripts}
\label{chapter:manual-to-collaboration:table:example-subscript-and-superscripts}
\halign {%
	{\sffamily\footnotesize\noindent#}\hbox to 0.5\tablemodule{}&
	\hbox to 0.5\tablemodule{}{\sffamily\footnotesize\noindent#}\cr
	\color{gray75}\bfseries Result& \color{gray75}\bfseries Source \cr
	\noalign{\vskip 1mm} \hline \noalign{\vskip 2mm} 
	\color{gray50}1\textsuperscript{fst}&
	\color{gray50}\code{1\textbackslash{}sup\{fst\}}\cr
	\noalign{\vskip 2mm 
}	\color{gray50}n\textsubscript{th}&
	\color{gray50}\code{n\textbackslash{}sub\{th\}}\cr
	\noalign{\vskip 2mm 
}	\color{gray50}brown\textsuperscript{tm}&
	\color{gray50}\code{brown\textbackslash{}sup\{tm\}}\cr
	\noalign{\vskip 2mm 
}	\color{gray50}lazy\textsubscript{ish}&
	\color{gray50}\code{lazy\textbackslash{}sub\{ish\}}\cr
	\noalign{\vskip 2mm 
}}
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 74-80: code points 1-9

\subsection{4}{Emphasis and highlight}
\label{volume:meta:chapter:manual-to-collaboration:section:basic-text:subSection:emphasis-and-highlight}
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 82-82: code points 1-35

\subsection{5}{Math and equations}
\label{volume:meta:chapter:manual-to-collaboration:section:basic-text:subSection:math-and-equations}
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 84-84: code points 1-31

\subsection{6}{Comments and annotations}
\label{volume:meta:chapter:manual-to-collaboration:section:basic-text:subSection:comments-and-annotations}
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 86-86: code points 1-37

\subsection{7}{Code}
\label{volume:meta:chapter:manual-to-collaboration:section:basic-text:subSection:code}
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 88-88: code points 1-17

\section{3}{Content hierarchy}
\label{volume:meta:chapter:manual-to-collaboration:section:content-hierarchy}
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 93-97: code points 1-35

To do...\par
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 95-95: code points 1-8

\subsection{1}{Organizing the sources}
\label{volume:meta:chapter:manual-to-collaboration:section:content-hierarchy:subSection:organizing-the-sources}
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 97-97: code points 1-35

\section{4}{Other visual elements}
\label{volume:meta:chapter:manual-to-collaboration:section:other-visual-elements}
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 101-113: code points 1-24

To do...\par
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 103-103: code points 1-8

\subsection{1}{Boxes}
\label{volume:meta:chapter:manual-to-collaboration:section:other-visual-elements:subSection:boxes}
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 105-105: code points 1-18

\subsection{2}{Figures}
\label{volume:meta:chapter:manual-to-collaboration:section:other-visual-elements:subSection:figures}
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 107-107: code points 1-20

\subsection{3}{Tables}
\label{volume:meta:chapter:manual-to-collaboration:section:other-visual-elements:subSection:tables}
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 109-109: code points 1-19

\subsection{4}{Equation blocks}
\label{volume:meta:chapter:manual-to-collaboration:section:other-visual-elements:subSection:equation-blocks}
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 111-111: code points 1-28

\subsection{5}{Code blocks}
\label{volume:meta:chapter:manual-to-collaboration:section:other-visual-elements:subSection:code-blocks}
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 113-113: code points 1-24

\section{5}{Formal specification}
\label{volume:meta:chapter:manual-to-collaboration:section:formal-specification}
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 118-120: code points 1-8

To do...\par
% @ guide/34-manual-for-collaboration/00-manual-for-collaboration.src: lines 120-120: code points 1-8

