Skip to content

Latest commit

 

History

History
462 lines (359 loc) · 17.7 KB

CHANGELOG.md

File metadata and controls

462 lines (359 loc) · 17.7 KB

F-14 CHEATSHEET

CHANGELOG

Changelog - 2023.01.14 v1.3.0

  • Updates imported from [REDACTED]-CheatSheet

  • Complete Rewrite OF TechCheck Class Architecture: many commands/environments were moved into two new .sty files (packages)

    • NEW techhatchtabs.sty

      • Hatching command \hatch along with the internal \single command
      • Thumbtab related commands \thumbtab, \thumbback, \thumbwide, \thumbnar
      • Titlepage tab related commands \thumbfront, NEW \fronttitleprep
      • Thumbtab related tikz commponents were moved into package internal commands for easier customization
      • NEW Many boolean options available to customize rounding, indentation, thumbtabs etc.
    • NEW technumitem.sty

      • tablenumitem environments
      • checklistenumitem environments
      • NEW tcolorenumitem environments
    • Updated content to better follow TeX class/package writing best practices, i.e using @ symbol and capitalization for class / package internal commands and variables

  • TechCheck.cls

    • Updated to use new packages
    • Updated to better follow class best practices
  • TITLEPAGE

    • Changed to use new package commands

Changelog - 2022.07.09 v1.2.3

  • TechCheck.cls

    • Changed base class from report to book
      • This gives access to \frontmatter, \mainmatter, \backmatter which change chapter numbering styles and pagenumbering styles
      • \backmatter does not play nice with chappg package, currently don't recommend using
      • Should make \cleardoublepage unnecessary on chapter end, chapters automatically begin on odd pages and fill until that point.
    • Reworked header and footer
      • Header now contains chapter name on the left, section name on the right
      • Footer now contains pagenumber on the outside, \aircraftshort in the center, and versionnumber on the inside
  • APPENDIX

    • Changed to begin with \appendix to actually be styled as appendix
      • Should split into various chapters to make use of appendix formatting/features

Changelog - 2022.07.08 v1.2.2

  • Externalized each of the chapters/sections into own ./sections/F14_nameofchapter.tex

    • Reduces file length, yields easier oversight
    • Allows selective compilation of only certain files via \includeonly{...} command
    • This can greatly accelerate compile times when iterating
  • Updated .gitignore to include *.synctex(busy)

  • TechCheck.cls

    • Change date format from YYYYMMDD to YYMMDD
    • Fixed indentation inconsistencies
    • Fixed font bugs

Changelog - 2022.06.24 v1.2.1

  • TechCheck.cls
    • Moved fonts into the repository
      • Added README for fonts including license
    • Adapted font loading to load from within the repository
    • Replace Spartan with SpartanMB (the former is no longer available)
    • Removed true Helvetica option (not open source)

Changelog - 2022.06.21

  • TechCheck.cls
    • Added xkeyvals package
      • Allows use of keys in custom package options / commands / environments
    • Added keys to tablenumerate
      • start=num - sets starting number for teblenumerate
      • resume - Doesn't reset counter
      • Additional counter added to prevent midrule doubling

Changelog - 2022.06.17 v1.2.0

  • TechCheck.cls

    • Added subcaption package which allows creation of subfigures
  • F14_Cheatsheet.tex

    • Changed standalone diagrams to be of type figure, this is more in line with standard LaTeX best-practices
    • Large SYSTEMS overhaul
      • Major COMMUNICATIONS rework
        • UHF 1, V/UHF 2, LINK 4 DATALINK subsections were updated to follow a more useful desired effect - necessary action formula
      • Major DEFENSIVE SYSTEMS rework
        • RWR was updated similarly to the communication subsections
      • NAVIGATION was almost completely overhauled
        • Reworked similarly to comms, defensive systems
        • Also removed many redundant subsections and notes, condensed material into a more essential package
        • Removed DISPLAYS subsection
        • Added NAVIGATION FIX subsection
        • Fleshed out WAYPOINT NAVIGATION
        • Moved and renamed VOR subsection to COMMUNICATIONS as ARA-50 ADF subsection
      • DEFENSIVE SYSTEMS has also been overhauled
      • ACLS subsection has been added
    • Added APPENDIX Chapter
      • Moved TID SYMBOLOGY and RWR THREAT SYMBOLOGY to the appendix
      • Added THREAT ADVISORY, INS STATUS, and VDI CAUTION indicator subsections
    • PROCEDURES
      • Added ICLS / ACLS CASE III procedures
    • Compact-ified IFF section
    • Other minor tweaks

Changelog - 2022.06.11

  • TechCheck.cls
    • Fixed bug with automatic thumbnar that prevented revision number on odd pages

Changelog - 2022.06.09

  • F14_Cheatsheet.tex
    • Added APX-76 IFF subsection
    • Minor tweaks to nav section

Changelog - 2022.06.08

  • TechCheck.cls

    • Added automatic \thumbnar to header on odd pages
      • Also added option manthumbnar to disable automatic thumbnar-ing
      • Necessitated creating new superempty pagestyle for titlepage (else would be thumbnar'd as it is an odd page)
    • Moved \hatch definition to below header/footer (with rest of tikz)
      • Class files do not seem to care if command is used before defined
  • F14_Cheatsheet.tex

    • Various minor formatting tweaks
    • AWG-9 RADAR Chapter
      • Moved STT Acquisition into own subsections
      • Added numerous note/warningboxes regarding weapon employment in various modes
    • A/A WEAPONS Chapter
      • Added numerous note/warningboxes regarding weapon employment in various modes

Changelog - 2022.06.06

  • TechCheck.cls

    • Renamed tablenumitem to shortablenumitem
    • Renamed longtablenumitem to tablenumitem
    • Added cleveref package
  • F14_Cheatsheet.tex

    • Adapted to new tablenumitem names
    • Various formatting fine tuning

Changelog - 2022.06.05

  • TechCheck.cls

    • Added subenumerate & subitemize environments to listlongtable, listtable environments
      • encapsulates both tableminipage and enumerate (or itemize)
      • Enables further OOP: if decide not to use tables could redefine subenumerate, subitemize in new fashion
    • Added checklistenumerate, checklistitemize (and long- versions)
      • Function as drag-and-drop replacement for tablenumitem environments
      • Changes outermost environment from tabular to enumitem (when compared with tablenumitem)
      • Built off of custom low-level enumitem environments: innerchecklistenumitem and outerchecklistenumitem
  • F14_Cheatsheet.tex

    • Implemented subenumerate, subitemize

Changelog - 2022.06.03

  • TechCheck.cls

    • Renamed listtabular to listtable
    • Added new environments:
      • tableminipage - encapsulates \minipage[]{} and \vspace{-7pt} to prevent repetition
      • longtablenumerate - uses listlongtable and adds enumerate like behavior, includes \blueitem and \dblueitem which take 2 arguments for middle and right column (left most column is the counter)
      • longtableitemize - identical to longtablenumerate but implements itemize instead
      • tablenumerate,tableitemize - same as long version but with using listtable instead
  • F14_Cheatsheet.tex

    • Implemented longtablenumerate, longtableitemize

Changelog - 2022.05.29

  • TechCheck.cls

    • Changed geometry to be loaded as a class per default, with the actual settings loaded via the \geometry{} command.
    • Removed unnecessary math packages
    • Removed widesubsec option -> now the default
    • Reorganized and Recommented code to make more legible
    • Added custom environments
      • listtabular encapsulates a center environment and a tabular environement with a default column spacing of l p{3cm} | p{8cm}
      • listlongtable encapsulates a center environment and a longtable environement with a default column spacing of l p{3cm} | p{8cm}
    • Switched from cm to mm (mostly)
  • F14_Cheatsheet.tex

    • Updated to use new environments
    • Changed font to Inter (open source)
  • README.md

    • Split CHANGLOG into own file

Changelog - 2022.03.15

  • Experimented with changing enumitem parameters
    • leftmargin=1.5em would reduce horizontal indent of enumerate and itemize
  • \vspace{-7pt} only seems to be required for enumerate? otherwise it seems to just work within minipage without spacing issues?
  • Look into listliketab package

Changelog - 2022.03.04 v1.1.0

  • TechCheck.cls

    • Fonts
      • Removed fontMontserrat
      • Choosing a font now forces all other fonts to be toggled false to prevent defining fonts twice
  • F14_Cheatsheet.tex

    • Continued work on NAVIGATION section
      • Finished DISPLAYS
      • Wrote VOR/ADF
    • Added initial Aerial refueling subsection
    • Added DECM subsection
    • Added AIM-54 -- ACM Section

Changelog - 2022.02.28

  • TechCheck.cls

    • Added fontInter option which uses a open-source alternative to Helvetica
  • F14_Cheatsheet.tex

    • Continued work on NAVIGATION section
    • Added initial Aerial refueling subsection
    • Added DECM subsection

Changelog - 2022.02.26 v1.0.7

  • TechCheck.cls

    • Added alternative color1 as HTML {222222}
  • F14_Cheatsheet.tex

    • Continued work on NAVIGATION section

Changelog - 2022.02.25 v1.0.6

  • TechCheck.cls

    • minitoc formatting changed
      • fixed interaction which caused only page numbers of sections to become bold in minitocs
      • removed lines
  • F14_Cheatsheet.tex

    • Began reworked NAVIGATION section
      • Completely rewrote INS alignment subsections

Changelog - 2022.02.24 v1.0.5

  • TechCheck.cls
    • Temporary, hacky fix to hatching bug
      • Bug Description:
        • When a minitoc extends too far beyond the chapter page it causes the hatching not to appear at the top of the page
        • An initial attempt to fix this involved moving the \Hatch command into the header code (as this is obviously executed)
        • For some unknown reason this does not fix the problem. The header text appears, but the hatching is not generated on the chapter page
        • In both cases the hatching is generated correctly on all other pages
        • Original creator of minitoc package is deceased and can therefore not be contacted
      • Fix:
        • changed default pagestyle to body and moved all formatting from the previous default plain to body
        • created new plain pagestyle which omits header text
        • Added \Hatch command to before-code of chapter title to brute force creation of hatching on Chapter pages
      • Flaws:
        • Still does not work if minitoc extends over an additional page
    • Added titlesec formatting section for chapter
      • used titlefont for chapters as well, otherwise defaults

Changelog - 2022.02.22 - 2 v1.0.4

  • TechCheck.cls

    • Fixed bug with hatching not applying to all pages when minitoc overflowed to next page
      • \Hatch is now called inside of header formatting
      • position of \Hatch command is critical to prevent hatching from covering other header elements
      • Could potentially move \thumbnar commands into header in the future
      • [EDIT] nvm the bug is still there
    • Changed fontHelvetica to now use Spartan
    • Added titlefont to remaining font options
  • F14_Cheatsheet

    • Added titlefont to titlepage title elements

Changelog - 2022.02.22 v1.0.3

  • TechCheck.cls
    • New Variables
      • nwround, neround, seround, swround sets rounding diameter for relevant corners, default length is 1cm
    • New Command
      • notebox like warningbox, for writing out notes... in a box
    • New option
      • fontHelvetica uses Helvetica Neue font with Metropolis (Futura) Titles

Changelog - 2022.02.14 v1.0.2

  • TechCheck.cls

    • New commands:
      • \setaircraftlong sets long label used on the title page
      • \setaircraftshort sets short label used in the center of header
  • F14_Cheatsheet.tex

    • Updated to use new commands
  • F14_00_titlepage.tex

  • Updated to use new commands


Changelog - 2022.02.12 v1.0.1

  • TechCheck.cls

    • Added additional options
      • nohatch disables hatching to potentially speed up compilation time during development
      • showframe, passes the showframe option to geometry package to show text area and margins
      • widesubsec lets the white-on-black subsection titles to cover the entire text width. This will probably become the default in the future.
    • Adjusted font options
      • \titlefont with letterspace=4.0 for all caps text
    • New commands:
      • \settabnumber sets number of thumbtabs / their width within the document rather than in the class
  • F14_Cheatsheet.tex

    • \cbstart was causing indentations, fixed by moving away from line starts

Changelog - 2022.02.11 - v1.0.0 "class is out"

  • MOVED ALL FORMATTING TO CLASS FILE
    • There now exist options to quickly (and hopefully robustly) change formatting. Including:
      • Paper geometry via (mutually exclusive) options
        • a5print [default]
        • a5
        • a4print
        • a4
        • 4x3print
      • Font options, for all fonts besides Helvet these also load the fontspec package
        • fontHelvet
        • fontJost
        • fontSpartan [default]
        • fontMontserrat
        • fontMetropolis
      • Color options
        • colorful [default], uses Processblue and NavyBlue for highlights
        • b/w, replaces highlight colors with black for cheaper printing
    • Notes on Option implementation
      • Options which modify packages are implemented via toggle from the etoolbox package. This is necessary because packages cannot be loaded in the option section of a class.
    • Additional options/enduser commands planned:
      • changebars on/off
      • number of thumbtabs
      • more robust font choices (separate letterspacing for heading text)
      • Hatching on/off for faster compilation
  • Currently the old format file is still in git, this will be archived in future updates
  • Added Disclaimer to back of titlepage that this document is not for training purposes
  • Added MIT OPEN LICENSE to all code

Changelog - 2022.02.08

  • Further experimentation with tcolorbox
    • Added warningbox which produces WARNING in box with drop shadow
  • Implemented changebar package to indicate mandatory steps from procedures with changebars in margin
  • created Xperimental.tex to try out new code with shorter run time
    • not included in git

Changelog - 2022.02.07

  • Began experimenting with tcolorbox to draw boxes around subsections
    • Requires redefining subsection definitions to reduce spacing, remove black box, and make subsection label white with titlesec tools
  • Began reading into moving hatching into header/footer formatting
    • fancyhdr manual has section on thumb index!
    • Indicates that you can have images integrated into header/footer w/o tikz

Changelog - 2022.02.06

  • Changed back to font Spartan
    • Also tried Metropolis and Montserrat (don't require rescaling), but both caused weird bug with minitoc where hatching didn't render on chapter 2 heading page because minitoc rolled over to next page...
  • Reworked hyperref links and targets for thumbtabs
    • Changed ref name from sec:i to thumbtabtab:i to reflect change in level
    • replaced \hypertarget{tab:i}{} with \label{tab:i} for each target
    • This allows links from titlepage to be to underlying object (the chapter) rather than the node itself.
    • Commented out code for hyperlink node tikz style from format file
    • Commented out code to make hypertarget for thumbtabs

Changelog - 2022.02.05

  • Changed to \chapter organization
    • Changed base class from article to report
    • Renamed many sections and subsections
  • Added minitoc package
    • Allows TOC for chapter
    • Each chapter begins with minitoc, cleardoublepage
  • Changed to Montserrat font
    • No longer requires scaling
    • Does not require tocloft to fix TOC spacing
    • Changed to LetterSpace=3.0 from 2.5
  • Maybe change header \leftmark formatting to use chapter and section information?
  • Maybe add seperate font families for the allcaps titles and normal bold (i.e for \blue)
    • use command \MakeUppercase{} to force uppercase

Changelog - 2022.01.25

  • Renamed format file to checklistformat_f14
  • Moved tabwidth and tabdepth to top of format
  • Removed outdated troubleshooting reference
  • Global definitions with enumitem
    • Defined label=(\alph*) for enumerate
    • Defined label=\textbf{\textbullet} for itemize
  • Updated 4x3print option to increase tabdepth to 9.5mm
    • As well as increasing outermar by 1.5mm
    • Need to figure out what all is necessary here to keep same page area as a5
  • Added formatting for using Spartan font (closer to Futura-DemiBold)
    • Spartan slightly taller -> Requires Scale=0.85 to keep sizing
    • Requires tocloft package to fix table of contents spacing
      • Increased sftsubsecnumwidth from 1.55em to 3.10em
  • Consolidated black color variable into color1
    • still needs control of titlepage tikz
    • Need variable for textcolor?
    • Move Color variables to top of formating?
  • Considering moving to having \chapter in place of \section
    • Maybe have first page of chapter be blank
    • Maybe individual table of content for chapter
    • Would require moving from article to report or book

Changelog - 2022.01.16

  • Previous Changes
    • Jost SemiBold -> Bold
    • Added LetterSpacing 2.5
  • Added option for 4x3 sizing
    • A5 paper is 210x148
    • I added 210x(148+8) for tabs
    • 4x3 would be 210x157.5 so I added 1.5 to Width
    • Inmar was inceased from 16 to 17.5

Changelog - 2021.12.12

  • Changed font
    • gill sans -> Jost
    • bold -> SemiBold