From ae0559a9432f85f9147eeb80b35f1b2947889acd Mon Sep 17 00:00:00 2001
From: Adrien Hopkins <adrien.p.hopkins@gmail.com>
Date: Sun, 1 Jun 2025 20:05:18 -0500
Subject: Update documentation to version 1.0.0

---
 docs/data_spec.tex | 27 ++++++++++++++++-----------
 1 file changed, 16 insertions(+), 11 deletions(-)

(limited to 'docs/data_spec.tex')

diff --git a/docs/data_spec.tex b/docs/data_spec.tex
index 879d62c..4e2475d 100644
--- a/docs/data_spec.tex
+++ b/docs/data_spec.tex
@@ -1,4 +1,4 @@
-% Created 2024-03-24 Sun 13:16
+% Created 2025-06-01 Sun 19:42
 % Intended LaTeX compiler: pdflatex
 \documentclass[11pt]{article}
 \usepackage[utf8]{inputenc}
@@ -13,15 +13,15 @@
 \usepackage{capt-of}
 \usepackage{hyperref}
 \usepackage[a4paper, lmargin=25mm, rmargin=25mm, tmargin=25mm, bmargin=25mm]{geometry}
-\date{2024 March 23}
+\date{2025 June 1}
 \title{7Units Datafile Specification\\\medskip
-\large For Version 0.5.0}
+\large For Version 1.0.0}
 \hypersetup{
  pdfauthor={},
  pdftitle={7Units Datafile Specification},
  pdfkeywords={},
  pdfsubject={},
- pdfcreator={Emacs 29.2 (Org mode 9.6.15)}, 
+ pdfcreator={Emacs 29.3 (Org mode 9.6.15)}, 
  pdflang={English}}
 \begin{document}
 
@@ -30,7 +30,7 @@
 
 \newpage
 \section{Unit and Prefix Files}
-\label{sec:org3f0bfdf}
+\label{sec:orgc529fa1}
 Unit and prefix files specify the units and prefixes that are available to 7Units.  Their format is intended to be compatible with 7Units's inspiration, \href{https://www.gnu.org/software/units/}{GNU Units}.
 
 Each unit or prefix is specified by a line in the following format:
@@ -40,7 +40,7 @@ Each unit or prefix is specified by a line in the following format:
 
 The name may not contain whitespace, but the definition can and often will.  Lines can be separated by either a line feed (0x0A) or a carriage return followed by a line feed (0x0D 0x0A).
 \subsection{Ignored Lines \& Comments}
-\label{sec:org7396c6b}
+\label{sec:orga9c97a7}
 All of the following should be ignored:
 \begin{itemize}
 \item Any line containing only whitespace
@@ -50,7 +50,7 @@ All of the following should be ignored:
 
 This allows unit and prefix files to be easily organized and divided.
 \subsection{Unit Expressions}
-\label{sec:orga56737c}
+\label{sec:orgebaa825}
 The definition part of a unit's line is a unit expression - the same sort of expression you would use in the complex unit converter.
 
 Expressions should be a standard mathematical expression, which can operate on either numbers or units.  The following operators are supported: addition (+), subtraction (-), multiplication (\texttt{*} or no operator), division (\texttt{/} or \texttt{|}), exponentation (\texttt{\textasciicircum{}}; exponent must be a number).  Brackets (\texttt{(} and \texttt{)}) may be used to change order of operations, but otherwise standard BEDMAS order is followed (exponentation first, then multiplication and division, then addition and subtraction), with two exceptions: if a number is multiplied by a unit using spaces, the multiplication will have precedence over division, and division with \texttt{|} has higher precedence than any other operator.  For example, "2 m / 1 m" is equal to the dimensionless value 2, not 2 m\textsuperscript{2}.  An example of a line defining a unit is:
@@ -60,15 +60,20 @@ yard	9 dm + 1.4 cm + 4 mm^2 / 10 mm
 
 If the definition is an exclamation mark (\texttt{!}), this defines a base unit, which is expected to already be stored in the system.
 \subsection{Prefixes \& Prefix Expressions}
-\label{sec:org28c98b9}
+\label{sec:orgd0ef1d8}
 If a line's name part ends in the ASCII dash (\texttt{-}, 0x2D), it defines a prefix instead of a unit (this dash is not included in the prefix's name).  Prefix expressions are like unit expressions, but the operands are prefixes and numbers, not units and numbers.  Because prefixes do not have a dimension, there are no base prefixes - the exclamation mark is forbidden in prefix expressions.
 \section{Dimension Files}
-\label{sec:org9530301}
+\label{sec:orgdc0ddd9}
 Dimension files give names to unit dimensions, so they can be selected in the unit converter to determine which units are shown.  Dimension files are similar to unit and prefix files, except that they use a different set of base \emph{dimensions} (defined with ! as usual), and that addition and subtraction are not supported in dimension expressions.
 \section{Metric Exception Files}
-\label{sec:org79afe10}
+\label{sec:org0587104}
 Metric exception files list exceptions to the One-Way Conversion rule.  Units included in these files are always shown on both sides of the unit converter, even if One Way Conversion is enabled.  They are just a list of units, one per line.  Ignored lines and comments work the same way as in other data files.
+\section{Locale Files}
+\label{sec:orgdc95be9}
+A locale file contains the data to translate 7Units into another language.  Each line is in the form \texttt{key=value}.  A sample locale file, with all available keys, can be found in \texttt{src/resources/locales/en.txt}.
+
+To translate 7Units, simply create another locale file in the \texttt{locales} subdirectory of your 7Units configuration directory.
 \section{Configuration Files}
-\label{sec:orgf3f6b9a}
+\label{sec:orgad1bd81}
 A configuration file contains one line for each configuration setting, in the format \texttt{key=value}.  Check the user manual for the list of configurable setting keys.  Ignored lines and comments work the same way as in other data files.
 \end{document}
-- 
cgit v1.2.3

