summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/ftc-notebook/ftc-notebook.tex
blob: 1ba0118682c4513d3c4893e6e9d0507508be929e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
%% change version number & date here, in README.md, and in ftc-notebook.sty
\documentclass{ltxdoc}
\usepackage[T1]{fontenc}
\usepackage{lmodern}
\usepackage[numbered]{hypdoc}
\usepackage{listings}
\usepackage{float}
\usepackage{array}
\usepackage{multirow}
\usepackage{tabu}
\usepackage{tocloft}
\renewcommand\cftloftitlefont{\Large}
\renewcommand\cftlottitlefont{\Large}
\lstnewenvironment{dtxverblisting}{%
  \lstset{
    gobble=2,
    basicstyle=\ttfamily,
    columns=fullflexible,
    keepspaces=true,
  }%
}{}
\addtolength\textwidth{15pt}
%\addtolength\oddsidemargin{-10pt}
%\addtolength\evensidemargin{-10pt}
\EnableCrossrefs
\CodelineIndex
\RecordChanges
\begin{document}

%% update version, dates in 2 places
\title{\textsf{ftc-notebook} --- Formating for FIRST Tech Challenge (FTC) Notebooks\thanks{%
    This file describes version 1.1, last revised on 2019/02/16.%
  }%
}
\author{FTC 9773, Robocracy\thanks{E-mail: ftcrobocracy@gmail.com}}
\date{Released Feb 16th, 2019}

\maketitle

\begin{abstract}

The \texttt{ftc-notebook} package will greatly simplify filling entries
for your FTC engineering or outreach notebook. We build on top of
LaTeX, a robust system that can easily accommodates 100+ pages of
documents, figures, and tables while providing support for 
cross-references.  We developed this package to support most
frequently used constructs encountered in an FTC notebook: meetings,
tasks, decisions with pros and cons, tables, figures with
explanations, team stories and bios, and more. We developed this
package during the 2018-2019 season and are using it for our
engineering notebook. Team Robocracy is sharing this style in the
spirit of coopertition.

\end{abstract}
\sloppy
%% update: add new change
\changes{v1.0}{2019/02/06}{First public release.}
\changes{v1.1}{2019/02/16}{Added hyperlinks, signees for meeting.}
\tableofcontents
\newpage
\listoffigures
\listoftables
\newpage

\section{Overview}

The LaTeX package \texttt{ftc-notebook} provides help to format a
FIRST Tech Challenge (FTC) engineering or outreach notebook. Using
this style, you will be able to seamlessly produce a high quality
notebook. Its main features are as follows.

\begin{itemize}
  \item Esthetically pleasing cover pages for the notebook and monthly updates.
  \item Easy to use format to enter a team story and a bio for
    each of the team members.
  \item Quick references using list of tasks, figures, and tables.
  \item Meeting entries separated into lists of tasks.
  \item Each task is visually labeled as one of several kind of activities,
    such as Strategy, Design, Build, Software,... Activity kind can be
    customized to reflect a team's particular focus.
  \item Support for supporting your decisions in clear tables that
    list the pros and cons of each of your decisions.
  \item Support for illustrating your robot using pictures with
    callouts. A callout is text in a box with an arrow pointing
    toward an interesting feature on your picture.
  \item Support for pictures with textual explanation, and groups of
    picture within a single figure.
\end{itemize}


We developed this style during the 2018-2019 FTC season and we used
it successfully during our competitive season. Compared to other
online documents, it is much more robust for large documents. By
designing a common style for all frequent patterns, the document also
has a much cleaner look.  LaTeX is also outstanding at supporting
references. Try combining it with an online service like Overleaf,
and your team will be generating quality notebooks in no time by
actively collaborating online.

We developed this package to require little knowledge of LaTeX. We
have tried to hide of the implementation details as much as
possible. We explain LaTeX concepts as we encountered them in the
document, so we recommend that LaTeX novices read the document once
from front to back. Experienced users may jump directly to figures and
sections explaining specific environment and commands.

The overall structure of an FTC notebook should be as shown in
Figure~\ref{fig:template} below.

\begin{figure}[H]
  \begin{dtxverblisting}
    \documentclass[11pt]{article}
    \usepackage[Num=FTC~9773, Name=Robocracy]{ftc-notebook}
    \begin{document}
      % 1: cover page and lists
      \CoverPage{2018-19}{robocracy18.jpg}    
      \ListOfTasks
      \ListOfFigures
      \ListOfTables

      % 2: start of the actual notebook with optional team story and bios
      \StartNotebook
      \input{src/story.tex}
      \input{src/bio.tex}

      % 3: meeting entries with optional month delimiters
      \Month{August}{aug18.jpg}
      \input{src/aug19.tex}
      \input{src/aug21.tex}    
      % repeat for successive months until the end of your successful season
    \end{document}
  \end{dtxverblisting}
  \caption{Template for notebook.}
  \label{fig:template}
\end{figure}

A document consists of three distinct parts. First, we generate a
cover page, followed by lists of tasks, figures, and tables. Pages
use alphabetical numbering, as customary for initial front matter. As
shown in Figure~\ref{fig:template}, a Latex document starts with a
\cs{documentclass} command, followed by a list of packages used, and
then a \cs{begin\{document\}} command. In LaTeX, comments use "\%."

Second, we indicate the beginning of the actual notebook using the
\cs{StartNotebook} command.  Pages are then numbered with numerical
page numbers starting at 1. A team story and team bio can be entered
here, and have specific LaTeX commands detailed in
Sections~\ref{sec:story} and~\ref{sec:bio}. For users unfamiliar with
LaTeX, \cs{input} commands are used to include separate files whose
file names are passed as arguments. The included files are processed
as if they were directly listed in the original file. We will use this
feature extensively to manage large documents such as an engineering
notebook.

Third, we have the actual content of the notebook. We structure
entries by meeting and suggest that each meeting uses a distinct input
file for its text and a corresponding subdirectory for its
supporting material, such as pictures. A meeting entry typically
consists of a list of tasks. Optionally, a new month can be started
with a cover page that includes a picture that highlights the
accomplishment of the team for that month.

We strongly recommend that you use the following file structure
for your notebook.

\begin{figure}[H]
  \begin{dtxverblisting}
    Directory structure:
      notebook.tex:     Your main latex file.
      ftc-notebook.sty: This package files, unless the package was 
                        installed in your LaTeX install directory.
      newmeeting.sh:    A bash script that allows you to create a new
                        meeting file that is pre-filled. The script can 
                        be customized for your team.
      src:              A directory where all the meeting info will go.
      |
      --> image:        A subdirectory where all the global pictures will 
      |                 go. We recommend to place there the team logo, 
      |                 team picture, and monthly pictures.
      |                 Pictures are searched there by default.
      --> aug19.tex     A file that includes all the text for your
      |                 (hypothetical) August 19th meeting.
      --> aug19:        A subdirectory where with all the images
                        needed for your aug19.tex LaTeX file.
  \end{dtxverblisting}
  \caption{Directory structure.}
\end{figure}

We recommend to use a pair of "date.tex" LaTeX file and "date"
subdirectory for each meeting.  This structure minimizes the risk of
name conflicts for pictures and other attachments during the FTC
season. Generally, directories logically organized by dates also
facilitate searching for specific information.

\section{Package Description and Customization\label{sec:package}}

The package parameters are used to customize the notebook with the
team name, team number, and the filename for a jpeg logo file. These
are required parameters, as this style will not work without them. In
particular, the logo file is expected to be either in the root
directory or in the src/image subdirectory. The second line of
Figure~\ref{fig:template} illustrates the mandatory parameters that
we used for our team. Use a "\textasciitilde" character instead of a
space when defining your parameters.

In addition, each task in an FTC season is categorized by 6 distinct
activity kinds. The default activity kinds are "Strategy," "Design,"
"Build," "Physics and Math," "Software," and "Team". The default
values can be changed easily using the Kind parameters
listed in Table~\ref{tab:arguments}.

\begin{table}[H]
  \begin{center}
  \begin{tabular}{|p{2cm}|p{5cm}|p{5cm}|}
    \hline
    \textbf{option name} & \textbf{description} & \textbf{default} \\ \hline 
    \texttt{Num} & team number & FTC\textasciitilde 000 \\ 
    \texttt{Name} & team name & Outstanding\textasciitilde Team \\ 
    \texttt{Notebook} & notebook type & Engineering\textasciitilde Notebook \\ \hline
    \texttt{Green} & green color scheme & (default) \\ 
    \texttt{Orange} & orange color scheme & \\ 
    \texttt{Blue} & blue color scheme & \\ \hline
    \texttt{Grid} & enables grid overlay over pictures & \\ \hline
    \texttt{KindOne} & first task kind & Strategy \\ 
    \texttt{KindTwo} & second task kind & Design  \\ 
    \texttt{KindThree} & third task kind & Build \\ 
    \texttt{KindFour} & fourth task kind & Physics and Math \\ 
    \texttt{KindFive} & fifth task kind & Software \\ 
    \texttt{KindSix} & sixth task kind & Team \\\hline
  \end{tabular}
  \end{center}
  \caption{Parameters for package, using "\textasciitilde" wherever a space is needed.}
  \label{tab:arguments}
\end{table}

Additionally, default colors can be changed using one of the
Green, Orange, or Blue parameters.  If more custom colors are desired, the
\cs{definecolor} commands as shown below can be used to provide a
specific RGB triplet of values for each of the five colors used by the
package.

\begin{figure}[H]
  \begin{dtxverblisting}
    \definecolor{TitleColor}{rgb}{0.65, 0.73, 0.29}
    \definecolor{MainTableHeaderColor}{rgb}{0.84, 0.96, 0.29}
    \definecolor{MainTableCellColor}{rgb}{0.70, 0.82, 0.32}
    \definecolor{NormalTableHeaderColor}{rgb}{0.84, 0.96, 0.29}
    \definecolor{NormalTableCellColor}{rgb}{0.94, 0.99, 0.78}
    \definecolor{NormalTableCellWhite}{rgb}{1.0, 1.0, 1.0}
  \end{dtxverblisting}
  \caption{Example of how to change the default colors of the titles.}
\end{figure}

These commands must be placed after the \cs{usepackage} command and
before the \cs{begin\{document\}} command.

\section{Entering Text for a Meeting\label{sec:meeting}}

In this section, we describe the environments and commands
used to generate a report summarizing the activities of a
meeting. A meeting can report a day's worth of work, or a weekend, or
even a week. Our preference is to use one meeting report per weekend.

The structure of a meeting is as follows. It starts with a high level
description of the meeting, including date, title, and a list of
members that participated to the meeting.  The high level description
also includes a list of task accomplished. The goal of this high
level description is to allow a team to quickly locate prior tasks
that were accomplished in a meeting. No-one will have to read the
whole file to determine if a new drivetrain was attempted on that
weekend, or not. It should be right at the beginning of the meeting
file.

After the high level info, we will have the text, figures, and
tables associated with each of the tasks.

\subsection{Meeting Description}

\begin{macro}{Meeting}

Let us now look at the format of a meeting entry, for example for an
hypothetical August~19 meeting written in a "src/aug18.tex" LaTeX
file.

\begin{figure}[H]
  \begin{dtxverblisting}
    \begin{Meeting}[<kind>]%
      {<title>} {<date>} {<duration>} {<members>}% 
      {% list of tasks
        \TaskInfo{<task title>}{<task label>}{<task reflection>}%
      }
      % meeting info
    \end{meeting}
  \end{dtxverblisting}
  \caption{Meeting entry (first and last command in a given meeting file).}
  \label{fig:meeting}
\end{figure}

The overall structure is a \texttt{Meeting} environment. In LaTeX,
environments are delineated with a \cs{begin\{env\}} command and a
matching \cs{end\{env\}} command at the end of the environment.  The
\cs{begin\{Meeting\}} command initialize the \texttt{Meeting}
environment with one optional argument and five mandatory arguments.
This command should be the first LaTeX command in the "src/aug18.tex"
file.

In LaTeX, mandatory arguments are given in curly braces, and optional
arguments are passed in square brackets. For commands with long
parameters, it is tempting to separate the arguments in many
lines. When doing so, especially with optional arguments, we
recommend to start a comment at the end of each of the parameter lines
(i.e. add a "\%" character). This will let LaTeX know that the next lines 
may contain an additional argument.

The first argument \oarg{kind} is optional and describes the meeting
kind. A typical meeting kind may be "Meeting," "Preseason,"
"Competition," "Outreach," or something of this sort. "Meeting" is
used by default if the optional argument is omitted. The second
argument \marg{title} is mandatory and indicates the meeting's
title. The third argument \marg{date} is mandatory and provides the
meeting's date or date range.  The fourth argument \marg{duration} is
mandatory and describes the duration of the meeting. The fifth
argument \marg{members} is mandatory and lists the name of the team
members present at the meeting. The sixth and last argument is
mandatory and provides a list of tasks performed at the meeting. This
list provides one \cs{TaskInfo} command per task. This command is
detailed in Section~\ref{sec:taskinfo}.

After the \cs{begin\{Meeting\}} command, we have the actual
content of the meeting. We provide many commands to properly format
most typical entries, such as sections, subsections, figures,
tables, list of decisions... These commands will be detailed in
subsequent sections.

The file is terminated by the \cs{end\{Meeting\}} command to
indicate that all of the info about this meeting has be given. It
will print a box where team members can sign the entry as requested
by FTC best practices.

\end{macro}

\begin{macro}{\Signee}

When giving the team member names in the mandatory \marg{members}
argument for the \texttt{Meeting} environment, you can indicate the
members that should sign the entry using the \cs{Signee} command with
the \marg{name} argument. For example, if Ann, Ben, and Carol attended
the meeting and you would like Ben and Carol to sign the entry, the
\marg{members} should be given as follows: ``Ann, \cs{Signee}\{Ben\},
\cs{Signee}\{Carol\}''.
  
\end{macro}


\subsection{Task Description\label{sec:taskinfo}}

\begin{macro}{\TaskInfo}

A meeting is structured in several tasks. Each task is first
described within the \cs{begin\{Meeting\}} command's sixth argument
using the \cs{TaskInfo} command. This command has three mandatory
arguments, as shown in Figure~\ref{fig:meeting}.

The first argument \marg{task title} indicates the title of the
task. The second argument \marg{task label} provides a unique label
for this task.  The third argument \marg{task reflection} is used to
provide a short reflection on the status of this task. This can
typically be something like "we discovered new problems," "we
realized that this approach works much better than previous
solutions," or any other high-level observation that you want
to share with the readers.

If you accomplished three tasks during a given meeting, then three
\cs{TaskInfo} entries must be provided within the list of tasks.

\end{macro}

Now is a good time to mention how labels and references are used in
LaTeX. Wherever a reference is needed, we must give a unique string
that will describe the location in the document associated with the
label, typically a page, task, figure, or table number. We recommend
to structure the label with the kind (\texttt{task}, \texttt{fig},
\texttt{tab}), followed by the file name, followed by a string that
make sense to the particular label. Later in the text, you can
explicitly reference the given label, for example with
"Task\textasciitilde \cs{ref\{task:aug19:challenge\}},"
"Figure\textasciitilde \cs{ref\{fig:aug19:lift\}}," or
"Table\textasciitilde \cs{ref\{tab:aug19:decision\}}." For users not
familiar with LaTeX, a "\textasciitilde" character is used to
represent a space where the text before and after the tilde cannot be
separated by an end-of-line.

\begin{macro}{\TaskRef}
\begin{macro}{\TableRef}
\begin{macro}{\FigureRef}

We also provide custom commands to generate the task/table/figure
number as well as the page number of where to find the
task/table/figure: \cs{TaskRef\{<label>\}}, \cs{TableRef\{<label>\}},
or \cs{FigureRef\{<label>\}}. These commands are convenient to refer
to task/table/figures far in the past.

\end{macro}
\end{macro}
\end{macro}

\begin{macro}{\Task}

Between the \cs{begin\{Meeting\}} and \cs{end\{Meeting\}} constructs,
we must provide detailed info for each task. Below is the command
used to do to start the actual description of a given task.

\begin{figure}[H]
  \begin{dtxverblisting}
    \Task [<prior task>] {<first kind>} [<second kind>]
  \end{dtxverblisting}
  \caption{Start of a task description.}
  \label{fig:task}
\end{figure}

This command will start a new task section. One such command is
needed for each of the \cs{TaskInfo} listed in the
\cs{begin\{Meeting\}} command. This command will reuse the title
listed by the \cs{TaskInfo} command in the same order. We decided on
this structure so that if a team member were to change the title of
the task in the \cs{TaskInfo} arguments, this change would
automatically be reflected at the start of the task's description
here.

The first optional argument \oarg{prior task} let us indicates if
this task is a continuation of one or more prior tasks. We strongly
recommend to fill in this argument when appropriate. For example, if
a given task is the continuation of a task with label
\texttt{task:aug06:challenge}, the argument should be set to
\cs{TaskRef\{task:aug06:challenge\}}.

The second mandatory argument \marg{first kind} indicates which kind
of tasks this is. Recall that we are able to change the default kinds
in Section~\ref{sec:package} in Table~\ref{tab:arguments}.  If the
type corresponds to the first kind (e.g. "Strategy" by default), then
we expect the number "1" here. Acceptable values are numbers between
1 and 6, inclusively. Sometimes, it may be hard to classify a task
with only one type: the optional third argument \oarg{second kind}
let us input a second kind. The order between the first and second
numbers is not important.

\end{macro}

\subsection{Sections and Lists}

\begin{macro}{\Section}
\begin{macro}{\Section*}
\begin{macro}{\Subsection}
\begin{macro}{\Subsection*}

Now that we have a task section, we can can start filling the
description for that task. Most likely, we will want to have sections
and subsections to group related material
together. \cs{Section\{<title>\}} and \cs{Subsection\{<title>\}}
respectively starts a numbered section and subsection with the given
title.  The starred versions are variants that omit the section
numbering.

\end{macro}
\end{macro}
\end{macro}
\end{macro}

\begin{macro}{\MeetingSummary}

The \cs{MeetingSummary} simply emits a unnumbered section title with a
"Meeting Summary" title.

\end{macro}

\begin{macro}{EnumerateWithTitle}
\begin{macro}{ItermizeWithTitle}

A frequent pattern is to have a section title followed by a list of
items. In LaTeX, numbered lists are referred as \texttt{enumerate}
environment and unnumbered or bulleted lists are referred as
\texttt{itemize} environment. Regardless of the type of list,
elements of the list always start with an \cs{item} command.

While traditional LaTeX list environments can be used, we define here
two custom list environments that provide for an unnumbered section
title followed by a list of numbered or unnumbered list element. The
figure below illustrates a possible use of such constructs.

\begin{figure}[H]
  \begin{dtxverblisting}
    \begin{EnumerateWithTitle}{A numbered list title} 
      \item one enumeration
      \item another enumeration, add more as needed
    \end{EnumerateWithTitle}
    
    \begin{ItemizeWithTitle}{A bulleted list title} 
      \item one bullet, add more as needed
    \end{ItemizeWithTitle}
  \end{dtxverblisting}
  \caption{Titled sections with numbered and unnumbered lists.}
\end{figure}

In general, you can always use the LaTeX default list environments
(to be used with \cs{begin\{<environment>\}} and
\cs{end\{<environment>\}}, namely \texttt{enumerate},
\texttt{itemize}, or \texttt{compactitem} for, respectively, a number
list of items, a list of bulleted items, or a compact list of
bulleted items.

\end{macro}
\end{macro}

\subsection{Tables}

When entering data for a task, one pattern that we often use is a
table of pros and cons arguments. We need a table
with three columns: one describing the option considered, a second
column describing the pros of this option, and a third column
describing the drawbacks of this option. Below is an example of such
a decision tables.

\begin{figure}[H]
  \begin{dtxverblisting}
    \begin{DecisionTable}
      {Decisions about lift}
      {tab:aug06:lift:decision}
       %
        \TableEntryTextItemItem{
          drawer slides
        } {% pros items
          \item works well
        } {% minus item
          \item heavy
        }
        \\ \hline
       %
        \TableEntryTextItemItem{
          rev slides
        } {% pros items
          \item light
        } {% minus item
          \item difficult under heavily load
        }
        % omit "\\ \hline" for last row
    \end{DecisionTable}
  \end{dtxverblisting}
  \caption{Example of decision table with pros and cons.}
  \label{fig:decision example}
\end{figure}

Before going in the details of the environments and commands,
Figure~\ref{fig:decision example} illustrates a comparison for a
lift, comparing drawer slides to REV slides. Each row is given by a
\cs{TableEntry} type of commands, two in this case, separated by
\cs{\textbackslash~\textbackslash hline} commands. This
first type of commands provides the data for a given row, and that
latter type of commands forces LaTeX to create a new line and
separate the entries by a horizontal line inside of the table.

\begin{macro}{DecisionTable}

A decision tables always consists of a table environment with three
columns. Its arguments are as follows.

\begin{figure}[H]
  \begin{dtxverblisting}
    \begin{DecisionTable} [<first col name>]%
      [<second col name>] [<third col name>]%
      {<caption>} {<label>}
  
    \end{DecisionTable}
  \end{dtxverblisting}
  \caption{Decision table.}
  \label{fig:decision}
\end{figure}

The first three optional arguments, \oarg{first col name},
\oarg{second col name}, and \oarg{third col name}, are used to change
the default column names, respectively "Option," "Pro," and "Cons."
The fourth mandatory argument \marg{caption} is the title of the
table. This caption will also be listed in the list of tables
generated by the \cs{ListOfTables} command. The fifth mandatory
argument \marg{label} is a label to be used when referencing the
table.  We strongly encourage each table to be referenced at least
once in the text.

\end{macro}

\begin{macro}{DescriptionTable}
\begin{macro}{DescriptionTable*}

We often need tables with two columns. For this purpose, we
propose the following \texttt{DescriptionTable} environments.

\begin{figure}[H]
  \begin{dtxverblisting}
    \begin{DescriptionTable} {<first col name>}%
      {<second col name>} {<caption>} {<label>}
  
    \end{DescriptionTable}
  \end{dtxverblisting}
  \caption{Decision table.}
  \label{fig:description}
\end{figure}

The first two mandatory arguments \marg{first col name} and
\marg{second col name} indicate the titles of each column. The
next tow mandatory arguments \marg{caption} and \marg{label}
provides, respectively, the caption and a label to refer to the
table.

The two environments are very similar. The non-starred environment
has a narrow column followed by a wider column, ideal for title
followed by a longer text in the second column. The starred
environment has two columns of equal sizes.

\end{macro}
\end{macro}

\begin{macro}{\TableEntryTextTextText}
\begin{macro}{\TableEntryTextItemItem}

The rows of tables with three columns are entered by the
\cs{TableEntryTextTextText} and \cs{TableEntryTextItemItem}
commands. Each take three mandatory arguments to input the data for each
of the three columns in a given row. The first command takes three text
entries, and the second command takes one text entry followed by two
bulleted lists. As shown in Figure~\ref{fig:decision example}, the
bulleted lists are entered as lines each starting by the \cs{item}
command. In tables, LaTeX does not like empty lines. So do not
include empty lines, and if you need a line break, you can always
enter the \cs{\textbackslash} new line command explicitly.

\end{macro}
\end{macro}

\begin{macro}{\TableEntryTextText}
\begin{macro}{\TableEntryTextItem}
\begin{macro}{\TableEntryItemItem}

The rows of tables with two columns are similarly entered with the
\cs{TableEntryTextText}, \cs{TableEntryTextItem}, and
\cs{TableEntryItemItem} commands. Each takes two mandatory arguments,
one for each column. Text or items are expected in the arguments
depending on the name of the command used.

\end{macro}
\end{macro}
\end{macro}


\begin{macro}{RawDecisionTable}
\begin{macro}{RawDescriptionTable}

Sometimes, you may need to get a decision or description table with an
arbitrary number of columns of varying different sizes. The
\texttt{RawDecisionTable} and \texttt{RawDescriptionTable}
environments allow you to create such tables. They take four mandatory
arguments: a column format given by \marg{format}, an ``\&'' separated
list of column titles given by \marg{titles}, a caption text given by
\marg{caption}, and a table label given by \marg{label}. Please refer
to the LaTeX \texttt{tabluar} environment for hints on how to express
table column format.
  
\end{macro}
\end{macro}

\subsection{Figures}

Figures are important in notebooks, and the package
proposes several commands to help us with them. First, you need to
know that LaTeX primarily likes JPEG format, so pictures will 
need to be converted to JPEGs.  By convention, the pictures are
expected in the "src/aug19" subdirectory when processing the
"src/aug19.tex" meeting entry. It's a convention, not mandatory, but
useful to follow as long term there are lots of pictures, so grouping
them by meeting is convenient.

\begin{macro}{\PictFigure}[H]

The first, simplest command will generate a figure with a caption for
a single JPEG file. It expects the following arguments.

\begin{figure}
  \begin{dtxverblisting}
    \PictFigure [<location>] {<jpeg file>} [<horizontal fraction>]%
      {<caption>} {<label>} [<callout>]
  \end{dtxverblisting}
  \caption{Figure with one picture.}
\end{figure}

The second mandatory argument \marg{jpeg file} provides the path to
the JPEG file as well as the file name, including the ".jpg"
extension. It is best to use the full path from the root directory,
for example "src/aug19/game.jpg". The third optional argument \oarg{horizontal
fraction} provides an optional fraction (between 0 and 1) that
indicates the fraction of the horizontal page that should be utilized
for the picture. Default is 0.9 or 90\% of the horizontal space. The
fourth argument \marg{caption} is the caption text, and the fifth
argument \marg{label} is a label string used to create a unique
reference to this figure. The caption of each figure will also be
listed in the list of figures generated by the \cs{ListOfFigure}
command.

Figures are floating object, they move where LaTeX estimate they fit
best. You can have some influence over the placement of the figures
using the first optional argument \oarg{location}. Possible values
are combinations of the entries shown in the table below. 

\begin{table}[H]
  \begin{center}
  \begin{tabular}{|p{2cm}|p{9cm}|}
    \hline
    \textbf{Key} & \textbf{Description}
    \\ \hline
    h for here & try to put the figure close to where it is in the text \\
    t for top & try to put it at the top of a page\\
    b for bottom &  try to put the figure at the bottom of a page \\
    p for page & try to put it on a separate page (not with other text) \\
    H for HERE & try harder to put it here \\
    ! & try to force your choice. \\
    htb  & You can put several choices at once, e.g. a frequent one is [htb] %
           for here, or top, or bottom. \\
    \hline
  \end{tabular}
  \end{center}
  \caption{Values for floating object location in LaTex.}
  \label{tab:location}
\end{table}

The last optional argument \oarg{callout} is used to add one or more
callouts. Callouts are used to overlay a text box on a figure, along
with an arrow pointing to the location of the interesting feature
is. So for example, the \cs{Callout\{-6,5\}\{Look Here\}\{-1,1\}}
command place a text box with text "Look Here" at the coordinate (X,
Y) = (-6, 5) with an arrow starting at the box and pointing to the
coordinate (X, Y) = (-1, 1). You may have arbitrary many callouts
inside the \oarg{callout} optional argument. Recall that if you write
the callout argument on a new line, we recommend to start a comment
at the end of the prior argument lines (i.e. add a "\%"
character). This will let LaTeX know that the next line contains
the optional argument.

Because callouts require us to know the precise coordinates at which
to locate the text box and the arrow, we have added a parameter to
the \texttt{ftc-notebook} package, namely \texttt{grid}, as defined in
Table~\ref{tab:arguments}. When setting this package parameter, every
figure will include a grid that will help us determine the proper
coordinates for the callouts. Simply remove the parameter when done.

\end{macro}

\begin{macro}{\ExplainedPictFigure}

Another frequent pattern is to have a picture one side of the page,
with a textual explanation next to it. For this pattern, we introduce the
\cs{ExplainedPictFigure} command which add one parameter to the
previous \cs{PictFigure} command to provide for a textual explanation.

\begin{figure}[H]
  \begin{dtxverblisting}
    \ExplainedPictFigure [<location>] {<jpeg files>}%
      [<horizontal fraction>] {<caption>} {<label>}
      {<explanation>} [<callout>]
  \end{dtxverblisting}
  \caption{An explained picture.}
  \label{fig:explained picture}
\end{figure}

Because the picture and the textual explanation share the width of
the page, we suggest to use a smaller fraction of the horizontal
space for the picture.  In Figure~\ref{fig:explained picture} we may
use a \marg{horizontal value} of 0.5 for 50\% of the space for the
picture, thus leaving the remaining 50\% for the text. In the
mandatory argument \marg{explanation} we can enter a text such as the
one below.

\begin{figure}[H]
  \begin{dtxverblisting}
    {% explanation (no empty line allowed); 
      Interesting features:
      \begin{compactitem}
        \item compact 
      \end{compactitem} 
    }
  \end{dtxverblisting}
  \caption{Example of an explanation text.}
  \label{fig:explanation text}
\end{figure}

In this example, we have a phrase followed by a compact list of bullets.

\end{macro}

\begin{macro}{GroupedFigures}
\begin{macro}{PictSubfigure}
\begin{macro}{ExplainedPictSubfigure}

Another frequent pattern is to add a group of pictures. To handle this
case, we introduce here a \texttt{GroupedFigures} environment
to encapsulate several subfigures. The commands are as below.

\begin{figure}[H]
  \begin{dtxverblisting}
    \begin{GroupedFigures} [<locations>] {<caption>} {<label>}

      \PictSubfigure {<jpeg file>} [<horizontal fraction>]%
        {<caption>} {<label>} [<callout>]

      \ExplainedPictFigure {<jpeg files>}%
        [<horizontal fraction>] {<caption>} {<label>}
        {<explanation>} [<callout>]

    \end{GroupedFigures}
  \end{dtxverblisting}
  \caption{Example of grouped figures.}
  \label{fig:groups fig}
\end{figure}

The \cs{begin\{GroupedFigures\}} has the usual optional argument
\oarg{location} and mandatory arguments \marg{caption} and
\marg{label}.

In turn, all of the subfigures have arguments similar to the figures
command previously seen, expect that they omit the optional location
argument as they are already grouped in a single floating figure.

\end{macro}
\end{macro}
\end{macro}

\begin{macro}{RawPict}

There is one additional command that is convenient for pictures.

\begin{figure}[H]
  \begin{dtxverblisting}
    \RawPict {<jpeg file>} {<horizontal fraction>} {<callout>}
  \end{dtxverblisting}
  \caption{Raw picture.}
  \label{fig:raw picture}
\end{figure}

This \cs{RawPict} command is used to insert a figure directly in a
table without labels, captions, and other arguments. It just take the
JPEG file name, its horizontal size, and callout which can be left
empty by using "\texttt{\{\}"}.

\end{macro}

This give you the essentials of the \texttt{ftc-notebook} package, many
more basic LaTeX command are useful, here is a list:
\texttt{enumerate}, \texttt{itemize}, \texttt{textbf}, handling
native \texttt{tabular} (tables in LaTeX) or \texttt{longtable}
(tables that can be split among consecutive pages).

\section{Team Story\label{sec:story}}

\begin{macro}{TeamStory}
We can add a "Team Story" page by using the following environment.

\begin{figure}[H]
  \begin{dtxverblisting}
    \begin{TeamStory}{<moto>}

      % team story

    \end{TeamStory}
  \end{dtxverblisting}
  \caption{Team story.}
  \label{fig:story}
\end{figure}

This environment let us enter a team story page with a mandatory
\marg{moto} argument, for example the team goal of the team for the
season.

\end{macro}

\section{Team Biography\label{sec:bio}}

\begin{macro}{Bio}
\begin{macro}{BioEntry}

We can also add a list of biographies for each team member as follows.

\begin{figure}[H]
  \begin{dtxverblisting}
    \begin{Bio}

      \BioEntry {<name>} {<title>}%
        [<role title>] {<role description>}%
        [<outreach role title>] {<outreach role description>}%
        {<jpeg file>} [<horizontal fraction>]%
        {<full bio>}

    \end{Bio}
  \end{dtxverblisting}
  \caption{Team biography table.}
  \label{fig:bio}
\end{figure}

The \texttt{Bio} environment creates a table in which the bio of each
team member can be given. The format for each team member comprises
of a picture given by the \marg{jpeg file} argument with the team
member's name from the \marg{name} argument and title from the
\marg{title} argument.


Below the picture, we will also generate two role entries, each with
an optional role title and a mandatory role description. This is can
be used to highlight the team role and outreach role of each team
member. The full bio given by \marg{full bio} is listed in a second
column, next to the picture.


\end{macro}
\end{macro}

\section{Miscellaneous Commands}

\begin{macro}{\CoverPage}

The \cs{CoverPage} command is used to generate a cover page for your
notebook. It takes two mandatory arguments: \marg{date} and
\marg{jpeg file}. The date is used to describe the season,
e.g. "2018-2019". The second argument gives the picture to be
used on the cover page. By default, the picture is expected in the
"src/image" directory, but you can provide a different file path to
the file, e.g. "src/story/teampict.jpg".

\end{macro}

\begin{macro}{\ListOfTasks}
\begin{macro}{\ListOfFigures}
\begin{macro}{\ListOfTables}

These commands create the corresponding list of tasks, figures, and
tables. We recommend that they are used before the \cs{StartNotebook}
command as the page numbering prior to the start command uses
alphabetical page numbering. This will allow the notebook to grow,
with the corresponding lists of tasks, figures, and tables to also
grow without changing the page numbering of your older notebook entry
pages.

\end{macro}
\end{macro}
\end{macro}

\begin{macro}{\StartNotebook}

Use this command to separate the front matter (cover pages and list
of content) from your actual notebook entry.

\end{macro}

\begin{macro}{\Month}

The \cs{month} command is used to create a cover page for a new
month. It takes two mandatory arguments: \marg{month} and \marg{jpeg
file}. The first argument indicates the month, and the second
arguments gives a path to the picture you want to use for the month
cover page. 

\end{macro}

\StopEventually{%
  \PrintChanges
  \PrintIndex
}

\end{document}