From f214f5623afeaa9e4dafbcc70698284b2a33e695 Mon Sep 17 00:00:00 2001
From: Adrien Hopkins <ahopk127@my.yorku.ca>
Date: Tue, 6 Jul 2021 15:28:54 -0500
Subject: Wrote user manual appendices, rewrote README to reflect user manual

---
 docs/manual.tex | 41 +++++++++++++++++++++++++----------------
 1 file changed, 25 insertions(+), 16 deletions(-)

(limited to 'docs/manual.tex')

diff --git a/docs/manual.tex b/docs/manual.tex
index f0a349c..25a5cf7 100644
--- a/docs/manual.tex
+++ b/docs/manual.tex
@@ -1,4 +1,4 @@
-% Created 2021-07-02 Fri 10:32
+% Created 2021-07-06 Tue 15:22
 % Intended LaTeX compiler: pdflatex
 \documentclass[11pt]{article}
 \usepackage[utf8]{inputenc}
@@ -15,7 +15,7 @@
 \usepackage{capt-of}
 \usepackage{hyperref}
 \usepackage[a4paper, lmargin=25mm, rmargin=25mm, tmargin=25mm, bmargin=25mm]{geometry}
-\date{2021 July 2}
+\date{2021 July 6}
 \title{7Units User Manual\\\medskip
 \large For Version 0.3.1}
 \hypersetup{
@@ -32,10 +32,10 @@
 
 \newpage
 \section{Introduction and Purpose}
-\label{sec:org4dc61e1}
+\label{sec:org9bdf09d}
 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}
+\label{sec:org6fc29c1}
 \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.
@@ -44,9 +44,9 @@
 
 \newpage
 \section{How to Use 7Units}
-\label{sec:org8e09476}
+\label{sec:org12dfe6f}
 \subsection{Simple Unit Conversion}
-\label{sec:orgb782fd7}
+\label{sec:org49a020a}
 \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]
@@ -71,7 +71,7 @@
 \end{figure}
 \end{enumerate}
 \subsection{Complex Unit Conversion}
-\label{sec:org27fd9f1}
+\label{sec:org5433cd5}
 \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]
@@ -79,7 +79,7 @@
 \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 \hyperref[sec:org05dd82b]{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]
@@ -89,7 +89,7 @@
 \end{figure}
 \end{enumerate}
 \section{7Units Settings}
-\label{sec:org7f8e329}
+\label{sec:org59fb50d}
 All settings can be accessed in the tab with the gear icon.
 \begin{figure}[htbp]
 \centering
@@ -97,7 +97,7 @@ All settings can be accessed in the tab with the gear icon.
 \caption{The settings menu, as of version 0.3.0}
 \end{figure}
 \subsection{Rounding Settings}
-\label{sec:org93e4373}
+\label{sec:org328f0e1}
 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.
@@ -105,7 +105,7 @@ These settings control how the output of a unit conversion is rounded.
 \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}
+\label{sec:org859bd80}
 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.
@@ -120,15 +120,24 @@ These settings control when you are allowed to repeat unit prefixes (e.g. kiloki
 \end{itemize}
 \end{description}
 \subsection{Miscellaneous Settings}
-\label{sec:org590a171}
+\label{sec:org7345e44}
 \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}
+\label{sec:orgee83bb3}
 \subsection{Unit Expressions}
-\label{sec:org16b29bb}
+\label{sec:org05dd82b}
+A unit expression is simply a math expression where the values being operated on are units or numbers.  The operations that can be used are (in order of precedence):
+\begin{itemize}
+\item Exponentiation (\^{}); the exponent must be an integer.  Both units and numbers can be raised to an exponent
+\item Multiplication (*) and division (/).  Multiplication can also be done with a space (so "15 meter" is the same thing as "15 * meter").
+\item Addition (+) and subtraction (-).  They can only be done between units of the same dimension (measuring the same thing).  So you can add metres, inches and feet together, and you can add joules and calories together, but you can't add metres to seconds, or feet to calories, or watts to pounds.
+\end{itemize}
+
+Brackets can be used to manipulate the order of operations, and nonlinear units like Celsius and Fahrenheit cannot be used in expressions.  You can use a value in a nonlinear unit by putting brackets after it - for example, degC(12) represents the value 12 \textdegree{} C
+\subsection{Other Expressions}
+\label{sec:org8014464}
+There are also a simplified version of expressions for prefixes and dimensions.  Only multiplication, division and exponentation are supported.  Currently, exponentation is not supported for dimensions, but that may be fixed in the future.
 \end{document}
-- 
cgit v1.2.3

