Skip to content

RIT-Launch-Initiative/report-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Spaceport America Cup Document Template

This repository provides a class file and templates for Project Technical Reports and Extended Abstracts to the Spaceport America Cup. The document class is subclassed into report and eabstract to match the slighly different formatting required for each.

Directory structure

The class file, report, and extended abstract are in the repository root.

lib is short for "libraries" and contains supplemental classes or source files, such as the bibliography style, bibliography, and tech report section descriptions.

ref is short for "references" and contains several rules documents and a presentation given at the 2022 SAC by Mike Bertin on best practices for writing technical reports to the SAC.

fig is short for "figures" and may be used to hold the report's graphics. The name and use of this directory is purely up to the user, but the examples (if not modified) will not compile if this directory and its files are not present.

Technical Report Template

The tech report uses \documentclass[report]{sac}. The major sections and parts of required appendicies are present. The report's compilation is controlled by three options passed to \documentclass[report, ...]{sac}: wip, nofig, and nodwg.

wip compiles all of the "work-in-progress" markers: the section descriptions taken from the (at time of writing, 2023) Rules and Requirements, italicized and in small font, formatting examples (throughout the text and in the first appendix), a header to make it clear this is WIP mode, and a DRAFT watermark.

nofig compiles the report without figures and tables. This is intended to be used briefly to check that the report body satisfies the text-only page limit.

nodwg compiles the report without drawings. This is intended to be used for most fo the report's life to save compilation time drastically. If used in conjunction with \putdrawings{<path>}, the flag will add the specified PDF, preserving page sizes, unless the nodwg option is present.

Extended Abstract Template

Barebones template for Extended Abstracts.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages