Generic markdown

Portable_PDD/Compile.bat → Markdown_to_TeX/Compile.bat

@@ -1,12 +1,17 @@
 @echo OFF
+
+REM This is a .bat file that can be used to compile a markdown file using a latex template file.
+REM The latex template file has variables/sections that are populated from the markdown file.
+REM This is a Windows file and there should be a corresponding linux/macos compile script.
+
 REM This is where you specify the path of your document.
-set DOCUMENT_PATH="markdown_template.md"
+set DOCUMENT_PATH="Templates\\markdown_template.md"
 
 REM This is where you specify the final name of your document.  Spaces will be replaced with underscores.
 set FINAL_DOC_NAME="50_SAT"
 
 REM This is the where you specify the template of the .tex file.
-set PDD_TEMPLATE="spex_template.tex"
+set PDD_TEMPLATE="Templates\\PDD_Template.tex"
 
 REM You can specify the type of compiler script.  It expects an input of the path of the .tex document.
 set COMPILE_SCRIPT="..\\Compile_Scripts\\MikTexCompiler.bat"

Portable_PDD/spex_template.tex → Markdown_to_TeX/Templates/PDD_Template.tex

@@ -43,7 +43,7 @@
 \makenomenclature{}
 
 % set title. choose something as descriptive and precise as possible. Descriptive > sounding cool. remember this!
-\title{TITLETAG}
+\title{TITLE_TAG}
 
 
 \author{
@@ -56,13 +56,13 @@
   % Read here for a more advanced options to modifying footnotes in the author block:  \url{http://tex.stackexchange.com/questions/826/symbols-instead-of-numbers-as-footnote-markers}
   %   Here, we use the IEEE long-form author block.
   \IEEEauthorblockN{% This block is for author Names.
-   STUDENTTAG%\IEEEauthorrefmark{1},
+   AUTHORS_TAG%\IEEEauthorrefmark{1},
   }
   \IEEEauthorblockA{% This block is for the author Afficliations, aka department and university
     RIT Space Exploration, Rochester Institute of Technology \\ %\\ starts a new line
     Rochester, N.Y. \\
     Email:
-    EMAILTAG%\IEEEauthorrefmark{1}[email protected],
+    EMAIL_TAG%\IEEEauthorrefmark{1}[email protected],
   }
   %%   Below, we use the short-form author block and basically hack it to suit our needs.
   % Philip~Linden$^{*\dagger}$%
@@ -86,17 +86,17 @@
   %%   There are ways to make LaTeX do this for you, but it is more advanced and not entirely necessary, especially for short author lists. Not worth the hassle, in my opinion.
 }
 % page header for pages other than cover page
-\markboth{TITLETAG}%
+\markboth{TITLE_TAG}%
 {Tarazevits \MakeLowercase{\textit{et al.}}: RIT Space Exploration}
 
 % Initial setup is over, start building the document itself
 \begin{document}
-\maketitle%
+\maketitle
 % correct bad hyphenation here, separated by spaces
 \hyphenation{explor-ation}
 
 \begin{abstract}
-ABSTRACTTAG
+ABSTRACT_TAG
 
       % The abstract is a brief summary of the design document. Typically it includes the purpose of the design document, key goals or objectives, and justifications.
       % Be sure not to confuse the abstract with the introduction.
@@ -128,7 +128,7 @@
 \nomenclature{CSLI}{CubeSat Launch Initiative}
 \nomenclature{AMSAT}{Amateur Radio in Space}
 
-SECTIONTAG
+SECTION_TAG
 
 \bibliography{SPEX50SAT}
 \onecolumn

Markdown_to_TeX/Templates/markdown_template.md

@@ -0,0 +1,127 @@
+---
+TITLE_TAG: 50\$ Satellite PDD AUTHORS_TAG: Evan Putnam, Another Student
+EMAIL_TAG: [email protected], [email protected] TEMP_TAG: Hello World
+---
+<!--- 
+  This is a template you can use for markdown with the SPEX PDD LaTeX documents.
+  Specify a title, authors, and emails.
+
+  Current Features:
+      Sections
+      Subsections
+      Text and newlines.
+      Basic LaTeX syntax (as long as no LaTeX or regular comments are inside a statement).
+
+  Commenting:
+      Multiline comments are only supported if you have a single start and 
+      end on a separate line.  For example you can not start a new comment on
+      the same line as an ending tag for a multiline comment.  
+
+      There can only be one single line comment per line.
+      Nested comments are not supported.
+
+  Important notes and potential gotchas:
+      Comments.
+      New lines.
+ --->
+
+<!--- 
+This is a special section that SHOULD exist.  
+This is text for your abstract and should appear before other sections. This
+CAN NOT have sub-sections and MUST have the # ABSTRACT syntax.
+ --->
+# ABSTRACT
+HERE BE A BIG HONKING ABSTRACT!
+
+# Section 1
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
+incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis
+nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
+Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu
+fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in
+culpa qui officia deserunt mollit anim id est laborum.
+
+## Subsection 1.1
+Hey how is it going?<!--- This is a single line comment which can be put
+anywhere!  Only one per line. --->
+
+<!--- Completely blank lines are treated as a line break.--->
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
+incididunt ut labore et dolore magna aliqua.
+<!--- Comment lines are not.---> 
+Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut
+aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in
+voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint
+occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim
+id est laborum.
+
+## Subsection 1.2
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
+incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis
+nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
+Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu
+fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in
+culpa qui officia deserunt mollit anim id est laborum.
+
+
+# Section 2
+Here is another section!
+
+## Subsection 2.1
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
+incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis
+nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
+Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu
+fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in
+culpa qui officia deserunt mollit anim id est laborum.
+
+# Section 3
+## Subsection 3.1
+You can also include subsections where the section does not include text.
+
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
+incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis
+nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
+Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu
+fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in
+culpa qui officia deserunt mollit anim id est laborum.
+
+# Section 4
+## LaTeX Tables
+
+<!--- You can use standard LaTeX syntax if it can be put on a single line. --->
+This is a table \autoref{table:somechart}
+
+<!--- 
+This command counts as being on a single line.
+Here is LaTeX code to create a table.
+ --->
+\begin{table}
+  \centering
+  \caption{Estimated Timeline}
+  \begin{tabularx}{\columnwidth}{@{}cXl@{}} \toprule
+    Phase & Task & Duration \\ \midrule
+    1 & Review existing \$50SAT designs and materials & 2 weeks or less \\
+    2 & Subsystem development & 6 weeks \\
+      & Order PCB design and/or assembly & 6 weeks \\
+      & Review changes to mechanical strucuture and order materials & 2 weeks or less \\
+      & Testing of individual subsystems & 2 weeks \\
+    3 & System Assembly & 1 week  \\
+    4 & System testing & 2 weeks  \\
+    5 & Generate documentation and delivery to SPEX & 1 week  \\
+    \bottomrule
+  \end{tabularx}
+\label{table:somechart}
+\end{table} \\
+
+<!--- 
+This command counts as being on a single line.
+Here is an example of inserting an image in your document.
+Image is one directory up of final folder so uses ../ formatting.
+ --->
+\begin{figure}[h]
+ \centering
+ \includegraphics[width=12cm, height=9cm]{../spex.png}
+ \caption{Here is the SPEX Logo.}
+\end{figure}