summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAdrien Hopkins <ahopk127@my.yorku.ca>2022-07-08 10:18:50 -0500
committerAdrien Hopkins <ahopk127@my.yorku.ca>2022-07-08 10:18:50 -0500
commitc2be02ac6ce0ef592b93ce11879a4f7a5c8fe201 (patch)
tree927534a2d894da70aea13e656f574325cf9ffd52 /docs
parent3f9c8cb17655e348d3e2c453a301ed7ab0e6ba9b (diff)
Added search settings to the manual and design document
Diffstat (limited to 'docs')
-rw-r--r--docs/design.org9
-rw-r--r--docs/design.pdfbin346265 -> 348080 bytes
-rw-r--r--docs/design.tex76
-rw-r--r--docs/manual.org11
-rw-r--r--docs/manual.pdfbin172013 -> 173138 bytes
-rw-r--r--docs/manual.tex42
6 files changed, 84 insertions, 54 deletions
diff --git a/docs/design.org b/docs/design.org
index 42fad74..467c018 100644
--- a/docs/design.org
+++ b/docs/design.org
@@ -1,6 +1,6 @@
#+TITLE: 7Units Design Document
#+SUBTITLE: For version 0.4.0-alpha.1
-#+DATE: 2022 June 18
+#+DATE: 2022 July 8
#+LaTeX_HEADER: \usepackage[a4paper, lmargin=25mm, rmargin=25mm, tmargin=25mm, bmargin=25mm]{geometry}
#+LaTeX_HEADER: \usepackage{xurl}
#+LaTeX: \newpage
@@ -104,6 +104,13 @@
Both of these ~View~ implementations implement ~UnitConversionView~ and ~ExpressionConversionView~.
** The Presenter
The ~Presenter~ is an intermediary between the ~View~ and the backend code. It accepts the user's input and passes it to the backend, then accepts the backend's output and passes it to the frontend for user viewing. Its main functions do not have arguments or return values; instead it takes input from and provides output to the ~View~ via its public methods.
+*** Rules
+ The ~Presenter~ has a set of function-object rules that determine some of its behaviours. Each corresponds to a setting in the ~View~, but they can be set to other values via the ~Presenter~'s setters (although nonstandard rules cannot be saved and loaded):
+ - numberDisplayRule :: A function that determines how numbers are displayed. This controls the rounding rules.
+ - prefixRepetitionRule :: A function that determines which combinations of prefixes are valid in unit expressions. This controls the unit prefix rules.
+ - searchRule :: A function that determines which prefixes are shown in the unit lists in unit conversion (which prefixed units are searchable).
+
+ These rules have been made this way to enable an incredible level of customization of these behaviours. Because any function object with the correct arguments and return type is accepted, these rules (especially the number display rule) can do much more than the default behaviours.
** Utility Classes
The frontend has many miscellaneous utility classes. Many of them are package-private. Here is a list of them, with a brief description of what they do and where they are used:
- DefaultPrefixRepetitionRule :: An enum containing the available rules determining when you can repeat prefixes. Used by the ~TabbedView~ for selecting the rule and by the ~Presenter~ for loading it from a file.
diff --git a/docs/design.pdf b/docs/design.pdf
index a7283ea..56d73a6 100644
--- a/docs/design.pdf
+++ b/docs/design.pdf
Binary files differ
diff --git a/docs/design.tex b/docs/design.tex
index 5df021f..5023fb3 100644
--- a/docs/design.tex
+++ b/docs/design.tex
@@ -1,4 +1,4 @@
-% Created 2022-06-18 Sat 16:42
+% Created 2022-07-08 Fri 10:05
% Intended LaTeX compiler: pdflatex
\documentclass[11pt]{article}
\usepackage[utf8]{inputenc}
@@ -16,7 +16,7 @@
\usepackage{hyperref}
\usepackage[a4paper, lmargin=25mm, rmargin=25mm, tmargin=25mm, bmargin=25mm]{geometry}
\usepackage{xurl}
-\date{2022 June 18}
+\date{2022 July 8}
\title{7Units Design Document\\\medskip
\large For version 0.4.0-alpha.1}
\hypersetup{
@@ -34,35 +34,35 @@
\newpage
\section{Introduction}
-\label{sec:org51b276b}
+\label{sec:orgd3381a6}
7Units is a program that can convert between units. This document details the internal design of 7Units, intended to be used by current and future developers.
\section{System Overview}
-\label{sec:orgf6d7bc7}
+\label{sec:org9bd9474}
\begin{figure}[htbp]
\centering
\includegraphics[height=144px]{./diagrams/overview-diagram.plantuml.png}
\caption{A big-picture diagram of 7Units, containing all of the major classes.}
\end{figure}
\subsection{Packages of 7Units}
-\label{sec:org4d8d5ef}
+\label{sec:org5c8f3ee}
7Units splits its code into three main packages:
\begin{description}
-\item[{\texttt{sevenUnits.unit}}] The \hyperref[sec:org72a7332]{unit system}
+\item[{\texttt{sevenUnits.unit}}] The \hyperref[sec:org1171d15]{unit system}
\item[{\texttt{sevenUnits.utils}}] Extra classes that aid the unit system.
-\item[{\texttt{sevenUnitsGUI}}] The \hyperref[sec:orgc5fc340]{front end} code
+\item[{\texttt{sevenUnitsGUI}}] The \hyperref[sec:orgb716c37]{front end} code
\end{description}
\texttt{sevenUnits.unit} depends on \texttt{sevenUnits.utils}, while \texttt{sevenUnitsGUI} depends on both \texttt{sevenUnits} packages. There is only one class that isn't in any of these packages, \texttt{sevenUnits.VersionInfo}.
\subsection{Major Classes of 7Units}
-\label{sec:org9673c34}
+\label{sec:org22c5367}
\begin{description}
-\item[{\hyperref[sec:org7bc5042]{sevenUnits.unit.Unit}}] The class representing a unit
-\item[{\hyperref[sec:orgb26c666]{sevenUnits.unit.UnitDatabase}}] A class that stores collections of units, prefixes and dimensions.
-\item[{\hyperref[sec:orge02b507]{sevenUnitsGUI.View}}] The class that handles interaction between the user and the program.
-\item[{\hyperref[sec:org020f2fb]{sevenUnitsGUI.Presenter}}] The class that handles communication between the \texttt{View} and the unit system.
+\item[{\hyperref[sec:orge128590]{sevenUnits.unit.Unit}}] The class representing a unit
+\item[{\hyperref[sec:orgc8dc0e4]{sevenUnits.unit.UnitDatabase}}] A class that stores collections of units, prefixes and dimensions.
+\item[{\hyperref[sec:orgf3ee40e]{sevenUnitsGUI.View}}] The class that handles interaction between the user and the program.
+\item[{\hyperref[sec:orgcf5cc70]{sevenUnitsGUI.Presenter}}] The class that handles communication between the \texttt{View} and the unit system.
\end{description}
\newpage
\subsection{Process of Unit Conversion}
-\label{sec:orgd348a9f}
+\label{sec:org73700d8}
\begin{figure}[htbp]
\centering
\includegraphics[width=.9\linewidth]{./diagrams/convert-units.plantuml.png}
@@ -77,7 +77,7 @@
\end{enumerate}
\newpage
\subsection{Process of Expression Conversion}
-\label{sec:orgb6405d1}
+\label{sec:org3e8ae17}
The process of expression conversion is similar to that of unit conversion.
\begin{figure}[htbp]
\centering
@@ -93,7 +93,7 @@ The process of expression conversion is similar to that of unit conversion.
\end{enumerate}
\newpage
\section{Unit System Design}
-\label{sec:org72a7332}
+\label{sec:org1171d15}
Any code related to the backend unit system is stored in the \texttt{sevenUnits.unit} package.
Here is a class diagram of the system. Unimportant methods, methods inherited from Object, getters and setters have been omitted.
@@ -104,11 +104,11 @@ Here is a class diagram of the system. Unimportant methods, methods inherited f
\end{figure}
\newpage
\subsection{Dimensions}
-\label{sec:org7cf4761}
-Dimensions represent what a unit is measuring, such as length, time, or energy. Dimensions are represented as an \hyperref[sec:org4743375]{ObjectProduct}<BaseDimension>, where \texttt{BaseDimension} is a very simple class (its only properties are a name and a symbol) which represents the dimension of a base unit; these base dimensions can be multiplied to create all other Dimensions.
+\label{sec:org14cd421}
+Dimensions represent what a unit is measuring, such as length, time, or energy. Dimensions are represented as an \hyperref[sec:orgc3e831c]{ObjectProduct}<BaseDimension>, where \texttt{BaseDimension} is a very simple class (its only properties are a name and a symbol) which represents the dimension of a base unit; these base dimensions can be multiplied to create all other Dimensions.
\subsection{Unit Classes}
-\label{sec:org7bc5042}
-Units are internally represented by the abstract class \texttt{Unit}. All units have an \hyperref[sec:org4743375]{ObjectProduct}<BaseUnit> (referred to as the base) that they are based on, a dimension (ObjectProduct<BaseDimension>), one or more names and a symbol (these last two bits of data are contained in the \texttt{NameSymbol} class). The dimension is calculated from the base unit when needed; the variable is just a cache. It has two constructors: a package-private one used to make \texttt{BaseUnit} instances, and a protected one used to make general units (for other subclasses of \texttt{Unit}). All unit classes are immutable.
+\label{sec:orge128590}
+Units are internally represented by the abstract class \texttt{Unit}. All units have an \hyperref[sec:orgc3e831c]{ObjectProduct}<BaseUnit> (referred to as the base) that they are based on, a dimension (ObjectProduct<BaseDimension>), one or more names and a symbol (these last two bits of data are contained in the \texttt{NameSymbol} class). The dimension is calculated from the base unit when needed; the variable is just a cache. It has two constructors: a package-private one used to make \texttt{BaseUnit} instances, and a protected one used to make general units (for other subclasses of \texttt{Unit}). All unit classes are immutable.
Units also have two conversion functions - one which converts from a value expressed in this unit to its base unit, and another which converts from a value expressed in the base unit to this unit. In \texttt{Unit}, they are defined as two abstract methods. This allows you to convert from any unit to any other (as long as they have the same base, i.e. you aren't converting metres to pounds). To convert from A to B, first convert from A to its base, then convert from the base to B.
@@ -133,20 +133,20 @@ There are a few more classes which play small roles in the unit system:
\item[{USCustomary}] A static utility class with instances of common units in the US Customary system (not to be confused with the British Imperial system; it has the same unit names but the values of a few units are different).
\end{description}
\subsection{Prefixes}
-\label{sec:org0a114c9}
+\label{sec:org1bd7050}
A \texttt{UnitPrefix} is a simple object that can multiply a \texttt{LinearUnit} by a value. It can calculate a new name for the unit by combining its name and the unit's name (symbols are done similarly). It can do multiplication, division and exponentation with a number, as well as multiplication and division with another prefix; all of these work by changing the prefix's multiplier.
\subsection{The Unit Database}
-\label{sec:orgb26c666}
+\label{sec:orgc8dc0e4}
The \texttt{UnitDatabase} class stores all of the unit, prefix and dimension data used by this program. It is not a representation of an actual database, just a class that stores lots of data.
Units are stored using a custom \texttt{Map} implementation (\texttt{PrefixedUnitMap}) which maps unit names to units. It is backed by two maps: one for units (without prefixes) and one for prefixes. It is programmed to include prefixes (so if units includes "metre" and prefixes includes "kilo", this map will include "kilometre", mapping it to a unit representing a kilometre). It is immutable, but you can modify the underlying maps, which is reflected in the \texttt{PrefixedUnitMap}. Other than that, it is a normal map implementation.
Prefixes and dimensions are stored in normal maps.
\subsubsection{Parsing Expressions}
-\label{sec:org0f25455}
-Each \texttt{UnitDatabase} instance has four \hyperref[sec:org082074d]{ExpressionParser} instances associated with it, for four types of expressions: unit, unit value, prefix and dimension. They are mostly similar, with operators corresponding to each operation of the corresponding class (\texttt{LinearUnit}, \texttt{LinearUnitValue}, \texttt{UnitPrefix}, \texttt{ObjectProduct<BaseDimension>}). Unit and unit value expressions use linear units; nonlinear units can be used with a special syntax (like "degC(20)") and are immediately converted to a linear unit representing their base (Kelvin in this case) before operating.
+\label{sec:orgb7ee1da}
+Each \texttt{UnitDatabase} instance has four \hyperref[sec:orgd351c2f]{ExpressionParser} instances associated with it, for four types of expressions: unit, unit value, prefix and dimension. They are mostly similar, with operators corresponding to each operation of the corresponding class (\texttt{LinearUnit}, \texttt{LinearUnitValue}, \texttt{UnitPrefix}, \texttt{ObjectProduct<BaseDimension>}). Unit and unit value expressions use linear units; nonlinear units can be used with a special syntax (like "degC(20)") and are immediately converted to a linear unit representing their base (Kelvin in this case) before operating.
\subsubsection{Parsing Files}
-\label{sec:org20173cf}
+\label{sec:org072dc65}
There are two types of data files: unit and dimension.
Unit files contain data about units and prefixes. Each line contains the name of a unit or prefix (prefixes end in a dash, units don't) followed by an expression which defines it, separated by one or more space characters (this behaviour is defined by the static regular expression \texttt{NAME\_EXPRESSION}). Unit files are parsed line by line, each line being run through the \texttt{addUnitOrPrefixFromLine} method, which splits a line into name and expression, determines whether it's a unit or a prefix, and parses the expression. Because all units are defined by others, base units need to be defined with a special expression "!"; \textbf{these units should be added to the database before parsing the file}.
@@ -154,10 +154,10 @@ Unit files contain data about units and prefixes. Each line contains the name o
Dimension files are similar, only for dimensions instead of units and prefixes.
\newpage
\section{Front-End Design}
-\label{sec:orgc5fc340}
+\label{sec:orgb716c37}
The front-end of 7Units is based on an MVP model. There are two major frontend classes, the \textbf{View} and the \textbf{Presenter}.
\subsection{The View}
-\label{sec:orge02b507}
+\label{sec:orgf3ee40e}
The \texttt{View} is the part of the frontend code that directly interacts with the user. It handles input and output, but does not do any processing. Processing is handled by the presenter and the backend code.
The \texttt{View} is an interface, not a single class, so that I can easily create multiple views without having to rewrite any processing code. This allows me to easily prototype changes to the GUI without messing with existing code.
@@ -171,10 +171,20 @@ There are currently two implementations of the \texttt{View}:
\end{description}
Both of these \texttt{View} implementations implement \texttt{UnitConversionView} and \texttt{ExpressionConversionView}.
\subsection{The Presenter}
-\label{sec:org020f2fb}
+\label{sec:orgcf5cc70}
The \texttt{Presenter} is an intermediary between the \texttt{View} and the backend code. It accepts the user's input and passes it to the backend, then accepts the backend's output and passes it to the frontend for user viewing. Its main functions do not have arguments or return values; instead it takes input from and provides output to the \texttt{View} via its public methods.
+\subsubsection{Rules}
+\label{sec:org9542834}
+The \texttt{Presenter} has a set of function-object rules that determine some of its behaviours. Each corresponds to a setting in the \texttt{View}, but they can be set to other values via the \texttt{Presenter}'s setters (although nonstandard rules cannot be saved and loaded):
+\begin{description}
+\item[{numberDisplayRule}] A function that determines how numbers are displayed. This controls the rounding rules.
+\item[{prefixRepetitionRule}] A function that determines which combinations of prefixes are valid in unit expressions. This controls the unit prefix rules.
+\item[{searchRule}] A function that determines which prefixes are shown in the unit lists in unit conversion (which prefixed units are searchable).
+\end{description}
+
+These rules have been made this way to enable an incredible level of customization of these behaviours. Because any function object with the correct arguments and return type is accepted, these rules (especially the number display rule) can do much more than the default behaviours.
\subsection{Utility Classes}
-\label{sec:orgd1f06d2}
+\label{sec:orgc49ece0}
The frontend has many miscellaneous utility classes. Many of them are package-private. Here is a list of them, with a brief description of what they do and where they are used:
\begin{description}
\item[{DefaultPrefixRepetitionRule}] An enum containing the available rules determining when you can repeat prefixes. Used by the \texttt{TabbedView} for selecting the rule and by the \texttt{Presenter} for loading it from a file.
@@ -187,15 +197,15 @@ The frontend has many miscellaneous utility classes. Many of them are package-p
\end{description}
\newpage
\section{Utility Classes}
-\label{sec:orgea2ebc4}
+\label{sec:orgc90957f}
7Units has a few general "utility" classes. They aren't directly related to units, but are used in the units system.
\subsection{ObjectProduct}
-\label{sec:org4743375}
+\label{sec:orgc3e831c}
An \texttt{ObjectProduct} represents a "product" of elements of some type. The units system uses them to represent coherent units as a product of base units, and dimensions as a product of base dimensions.
Internally, it is represented using a map mapping objects to their exponents in the product. For example, the unit "kg m\textsuperscript{2} / s\textsuperscript{2}" (i.e. a Joule) would be represented with a map like \texttt{[kg: 1, m: 2, s: -2]}.
\subsection{ExpressionParser}
-\label{sec:org082074d}
+\label{sec:orgd351c2f}
The \texttt{ExpressionParser} class is used to parse the unit, prefix and dimension expressions that are used throughout 7Units. An expression is something like "(2 m + 30 J / N) * 8 s)". Each instance represents a type of expression, containing a way to obtain values (such as numbers or units) from the text and operations that can be done on these values (such as addition, subtraction or multiplication). Each operation also has a priority, which controls the order of operations (i.e. multiplication gets a higher priority than addition).
\texttt{ExpressionParser} has a parameterized type \texttt{T}, which represents the type of the value used in the expression. The expression parser currently only supports one type of value per expression; in the expressions used by 7Units numbers are treated as a kind of unit or prefix. Operators are represented by internal types; the system distinguishes between unary operators (those that take a single value, like negation) and binary operators (those that take 2 values, like +, -, * or /).
@@ -212,13 +222,13 @@ Expressions are parsed in 2 steps:
After evaluating the last token, there should be one value left in the stack - the answer. If there isn't, the original expression was malformed.
\end{enumerate}
\subsection{Math Classes}
-\label{sec:orgac1454d}
+\label{sec:orgdadbc0d}
There are two simple math classes in 7Units:
\begin{description}
\item[{\texttt{UncertainDouble}}] Like a \texttt{double}, but with an uncertainty (e.g. \(2.0 \pm 0.4\)). The operations are like those of the regular Double, only they also calculate the uncertainty of the final value. They also have "exact" versions to help interoperation between \texttt{double} and \texttt{UncertainDouble}. It is used by the converter's Scientific Precision setting.
\item[{\texttt{DecimalComparison}}] A static utility class that contains a few alternate equals() methods for \texttt{double} and \texttt{UncertainDouble}. These methods allow a slight (configurable) difference between values to still be considered equal, to fight roundoff error.
\end{description}
\subsection{Collection Classes}
-\label{sec:orgc3dfef2}
+\label{sec:org7421746}
The \texttt{ConditionalExistenceCollections} class contains wrapper implementations of \texttt{Collection}, \texttt{Iterator}, \texttt{Map} and \texttt{Set}. These implementations ignore elements that do not pass a certain condition - if an element fails the condition, \texttt{contains} will return false, the iterator will skip past it, it won't be counted in \texttt{size}, etc. even if it exists in the original collection. Effectively, any element of the original collection that fails the test does not exist.
\end{document}
diff --git a/docs/manual.org b/docs/manual.org
index 086ae5d..6de3b93 100644
--- a/docs/manual.org
+++ b/docs/manual.org
@@ -1,6 +1,6 @@
#+TITLE: 7Units User Manual
-#+SUBTITLE: For Version 0.3.1
-#+DATE: 2021 July 6
+#+SUBTITLE: For Version 0.4.0-alpha.1
+#+DATE: 2022 July 8
#+LaTeX_HEADER: \usepackage[a4paper, lmargin=25mm, rmargin=25mm, tmargin=25mm, bmargin=25mm]{geometry}
#+LaTeX: \newpage
@@ -47,7 +47,7 @@
[[../screenshots/sample-conversion-results-expression-converter.png]]
* 7Units Settings
All settings can be accessed in the tab with the gear icon.
- #+CAPTION: The settings menu, as of version 0.3.0
+ #+CAPTION: The settings menu, as of version 0.4.0-alpha.1
#+ATTR_LaTeX: :height 250px
[[../screenshots/main-interface-settings.png]]
** Rounding Settings
@@ -65,6 +65,11 @@
- any number of yocto or yotta
- they must be in this order
- all prefixes must be of the same sign (either all magnifying or all reducing)
+** Search Settings
+ These settings control which prefixes are shown in the "Convert Units" tab. Only coherent SI units (e.g. metre, second, newton, joule) will get prefixes. Some prefixed units are created in the unitfile, and will stay regardless of this setting (though they can be removed from the unitfile).
+ - Never Include Prefixed Units :: Prefixed units will only be shown if they are explicitly added to the unitfile.
+ - Include Common Prefixes :: Every coherent unit will have its kilo- and milli- versions included in the list.
+ - Include All Single Prefixes :: Every coherent unit will have every prefixed version of it included in the list.
** Miscellaneous Settings
- Convert One Way Only :: In the simple conversion tab, only imperial/customary units will be shown on the left, and only metric units[fn:1] will be shown on the right. Units listed in the exceptions file (~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.
- 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.
diff --git a/docs/manual.pdf b/docs/manual.pdf
index e6cbb5d..71cb886 100644
--- a/docs/manual.pdf
+++ b/docs/manual.pdf
Binary files differ
diff --git a/docs/manual.tex b/docs/manual.tex
index 25a5cf7..4b8e4ab 100644
--- a/docs/manual.tex
+++ b/docs/manual.tex
@@ -1,4 +1,4 @@
-% Created 2021-07-06 Tue 15:22
+% Created 2022-07-08 Fri 10:17
% Intended LaTeX compiler: pdflatex
\documentclass[11pt]{article}
\usepackage[utf8]{inputenc}
@@ -15,9 +15,9 @@
\usepackage{capt-of}
\usepackage{hyperref}
\usepackage[a4paper, lmargin=25mm, rmargin=25mm, tmargin=25mm, bmargin=25mm]{geometry}
-\date{2021 July 6}
+\date{2022 July 8}
\title{7Units User Manual\\\medskip
-\large For Version 0.3.1}
+\large For Version 0.4.0-alpha.1}
\hypersetup{
pdfauthor={},
pdftitle={7Units User Manual},
@@ -32,10 +32,10 @@
\newpage
\section{Introduction and Purpose}
-\label{sec:org9bdf09d}
+\label{sec:org26b964e}
7Units is a program that can be used to convert units. This document outlines how to use the program.
\section{System Requirements}
-\label{sec:org6fc29c1}
+\label{sec:orgfb95788}
\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:org12dfe6f}
+\label{sec:orgc48d5d5}
\subsection{Simple Unit Conversion}
-\label{sec:org49a020a}
+\label{sec:orgd56d395}
\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:org5433cd5}
+\label{sec:org79999e9}
\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: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 \hyperref[sec:org28ae9bb]{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,15 +89,15 @@
\end{figure}
\end{enumerate}
\section{7Units Settings}
-\label{sec:org59fb50d}
+\label{sec:org6032cec}
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}
+\caption{The settings menu, as of version 0.4.0-alpha.1}
\end{figure}
\subsection{Rounding Settings}
-\label{sec:org328f0e1}
+\label{sec:orgbe67478}
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:org859bd80}
+\label{sec:org3207fad}
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.
@@ -119,16 +119,24 @@ These settings control when you are allowed to repeat unit prefixes (e.g. kiloki
\item all prefixes must be of the same sign (either all magnifying or all reducing)
\end{itemize}
\end{description}
+\subsection{Search Settings}
+\label{sec:orge76e8f6}
+These settings control which prefixes are shown in the "Convert Units" tab. Only coherent SI units (e.g. metre, second, newton, joule) will get prefixes. Some prefixed units are created in the unitfile, and will stay regardless of this setting (though they can be removed from the unitfile).
+\begin{description}
+\item[{Never Include Prefixed Units}] Prefixed units will only be shown if they are explicitly added to the unitfile.
+\item[{Include Common Prefixes}] Every coherent unit will have its kilo- and milli- versions included in the list.
+\item[{Include All Single Prefixes}] Every coherent unit will have every prefixed version of it included in the list.
+\end{description}
\subsection{Miscellaneous Settings}
-\label{sec:org7345e44}
+\label{sec:org5613324}
\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{Appendices}
-\label{sec:orgee83bb3}
+\label{sec:org03406a3}
\subsection{Unit Expressions}
-\label{sec:org05dd82b}
+\label{sec:org28ae9bb}
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
@@ -138,6 +146,6 @@ A unit expression is simply a math expression where the values being operated on
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}
+\label{sec:orgb03cf2c}
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}