Created user manual with all main sections

1 files changed, 134 insertions, 0 deletions

diff --git a/docs/manual.tex b/docs/manual.tex
new file mode 100644
index 0000000..f0a349c
--- /dev/null
+++ b/docs/manual.tex
@@ -0,0 +1,134 @@
+% Created 2021-07-02 Fri 10:32
+% Intended LaTeX compiler: pdflatex
+\documentclass[11pt]{article}
+\usepackage[utf8]{inputenc}
+\usepackage[T1]{fontenc}
+\usepackage{graphicx}
+\usepackage{grffile}
+\usepackage{longtable}
+\usepackage{wrapfig}
+\usepackage{rotating}
+\usepackage[normalem]{ulem}
+\usepackage{amsmath}
+\usepackage{textcomp}
+\usepackage{amssymb}
+\usepackage{capt-of}
+\usepackage{hyperref}
+\usepackage[a4paper, lmargin=25mm, rmargin=25mm, tmargin=25mm, bmargin=25mm]{geometry}
+\date{2021 July 2}
+\title{7Units User Manual\\\medskip
+\large For Version 0.3.1}
+\hypersetup{
+ pdfauthor={},
+ pdftitle={7Units User Manual},
+ pdfkeywords={},
+ pdfsubject={},
+ pdfcreator={Emacs 27.1 (Org mode 9.4.6)}, 
+ pdflang={English}}
+\begin{document}
+
+\maketitle
+\tableofcontents
+
+\newpage
+\section{Introduction and Purpose}
+\label{sec:org4dc61e1}
+7Units is a program that can be used to convert units.  This document outlines how to use the program.
+\section{System Requirements}
+\label{sec:org7875883}
+\begin{itemize}
+\item Works on all major operating systems \\
+\textbf{NOTE:} All screenshots in this document were taken on Windows 10.  If you use a different operating system, the program will probably look different than what is shown.
+\item Java version 11-15 required
+\end{itemize}
+
+\newpage
+\section{How to Use 7Units}
+\label{sec:org8e09476}
+\subsection{Simple Unit Conversion}
+\label{sec:orgb782fd7}
+\begin{enumerate}
+\item Select the "Convert Units" tab if it is not already selected.  You should see a screen like in figure \ref{main-interface-dimension}:
+\begin{figure}[htbp]
+\centering
+\includegraphics[height=250px]{../screenshots/main-interface-dimension-converter.png}
+\caption{\label{main-interface-dimension}Taken in version 0.3.0}
+\end{figure}
+\item Use the dropdown box at the top to select what kind of unit to convert (length, mass, speed, etc.)
+\item Select the unit to convert \emph{from} on the left.
+\item Select the unit to convert \emph{to} on the right.
+\item Enter the value to convert in the box above the convert button.  The program should look something like in figure \ref{sample-conversion-dimension}:
+\begin{figure}[htbp]
+\centering
+\includegraphics[height=250px]{../screenshots/sample-conversion-dimension-converter.png}
+\caption{\label{sample-conversion-dimension}This image, taken in version 0.3.0, shows the user about to convert 35 miles to kilometres.}
+\end{figure}
+\item Press the "Convert" button.  The result will be shown below the "Convert" button.  This is shown in figure \ref{sample-results-dimension}
+\begin{figure}[htbp]
+\centering
+\includegraphics[height=250px]{../screenshots/sample-conversion-results-dimension-converter.png}
+\caption{\label{sample-results-dimension}The result of the above conversion}
+\end{figure}
+\end{enumerate}
+\subsection{Complex Unit Conversion}
+\label{sec:org27fd9f1}
+\begin{enumerate}
+\item Select the "Convert Unit Expressions" if it is not already selected.  You should see a screen like in figure \ref{main-interface-expression}:
+\begin{figure}[htbp]
+\centering
+\includegraphics[height=250px]{../screenshots/main-interface-expression-converter.png}
+\caption{\label{main-interface-expression}Taken in version 0.3.0}
+\end{figure}
+\item Enter a \hyperref[sec:org16b29bb]{unit expression} in the From box.  This can be something like "\texttt{7 km}" or "\texttt{6 ft - 2 in}" or "\texttt{3 kg m + 9 lb ft + (35 mm)\textasciicircum{}2 * (85 oz) / (20 in)}".
+\item Enter a unit name (or another unit expression) in the To box.
+\item Press the Convert button.  This will calculate the value of the first expression, and convert it to a multiple of the second unit (or expression).
+\begin{figure}[htbp]
+\centering
+\includegraphics[height=250px]{../screenshots/sample-conversion-results-expression-converter.png}
+\caption{\label{sample-results-expression}A sample calculation.  Divides \texttt{100 km} by \texttt{35 km/h} and converts the result to minutes.  This could be used to calculate how long (in minutes) it takes to go 100 kilometres at a speed of 35 km/h.}
+\end{figure}
+\end{enumerate}
+\section{7Units Settings}
+\label{sec:org7f8e329}
+All settings can be accessed in the tab with the gear icon.
+\begin{figure}[htbp]
+\centering
+\includegraphics[height=250px]{../screenshots/main-interface-settings.png}
+\caption{The settings menu, as of version 0.3.0}
+\end{figure}
+\subsection{Rounding Settings}
+\label{sec:org93e4373}
+These settings control how the output of a unit conversion is rounded.
+\begin{description}
+\item[{Fixed Precision}] Round to a fixed number of \href{https://en.wikipedia.org/wiki/Significant\_figures}{significant digits}.  The number of significant digits is controlled by the precision slider below.
+\item[{Fixed Decimal Places}] Round to a fixed number of digits after the decimal point.  The number of decimal places is also controlled by the precision slider below.
+\item[{Scientific Precision}] Intelligent rounding which uses the precision of the input value(s) to determine the output precision.  Not affected by the precision slider.
+\end{description}
+\subsection{Prefix Repetition Settings}
+\label{sec:org9f17e6e}
+These settings control when you are allowed to repeat unit prefixes (e.g. kilokilometre)
+\begin{description}
+\item[{No Repetition}] Units may only have one prefix.
+\item[{No Restriction}] Units may have any number of prefixes.
+\item[{Complex Repetition}] A complex rule which makes it so that each power of 10 has one and only one prefix combination.  Units may have the following prefixes:
+\begin{itemize}
+\item one of: centi, deci, deca, hecto
+\item one of: zepto, atto, femto, pico, nano, micro, milli, kilo, mega, giga, tera, peta, exa, zetta
+\item any number of yocto or yotta
+\item they must be in this order
+\item all prefixes must be of the same sign (either all magnifying or all reducing)
+\end{itemize}
+\end{description}
+\subsection{Miscellaneous Settings}
+\label{sec:org590a171}
+\begin{description}
+\item[{Convert One Way Only}] In the simple conversion tab, only imperial/customary units will be shown on the left, and only metric units\footnote{7Units's definition of "metric" is stricter than the SI, but all of the common units that are commonly considered metric but not included in 7Units's definition are included in the exceptions file.} will be shown on the right.  Units listed in the exceptions file (\texttt{src/main/resources/metric\_exceptions.txt}) will be shown on both sides.  This is a way to reduce the number of options you must search through if you only convert one way.  The expressions tab is unaffected.
+\item[{Show Duplicates in "Convert Units"}] If unchecked, any unit that has multiple names will only have one included in the Convert Units lists.  The selected name will be the longest; if there are multiple longest names one is selected arbitrarily.  You will still be able to use these alternate names in the expressions tab.
+\end{description}
+\section{Customizing 7Units}
+\label{sec:orgff37715}
+\section{Appendices}
+\label{sec:org9281d29}
+\subsection{Unit Expressions}
+\label{sec:org16b29bb}
+\end{document}