Skip to content

Commit

Permalink
Remove local description list style=nextline
Browse files Browse the repository at this point in the history
I noticed while working on lwarp that some description lists were
marked locally with style=nextline. This commit removes all local style
so that the description list format is consistent across the document
and defined in the preamble.
  • Loading branch information
neilt committed Mar 11, 2024
1 parent a063414 commit d8fb4c7
Show file tree
Hide file tree
Showing 9 changed files with 39 additions and 39 deletions.
10 changes: 5 additions & 5 deletions appendices.tex
Original file line number Diff line number Diff line change
Expand Up @@ -536,7 +536,7 @@ \section{ledgersmb.conf}
\subsubsection{[main] Section}
\label{subsubsec-global-config-ledgersmb-conf-general}

\begin{description}[style=nextline]
\begin{description}
\item[language] Set language for login and admin pages.
\item[date\_format] Set the date format for the admin pages. The default is \texttt{yyyy-mm-dd}. Unset means detected from the browser)
\item[log\_level] Specifies the logging level to be used. This setting is ignored when the \texttt{log\_config} setting
Expand Down Expand Up @@ -567,7 +567,7 @@ \subsubsection{[environment] Section}

Sets shell environment variables when starting up.

\begin{description}[style=nextline]
\begin{description}
\item[PATH] If the server can't find applications, append to the path. For example:
\texttt{PATH=/bin:/usr/bin:/usr/local/bin:/usr/local/pgsql/bin}
\item [PERL5LIB] On some operating systems like macOS the perl path may need to be set. For example, on macOS using Fink's Perl libs it might be set like:
Expand All @@ -578,7 +578,7 @@ \subsubsection{[environment] Section}
\subsubsection{[paths] Section}
\label{subsubsec-global-config-ledgersmb-conf-paths}

\begin{description}[style=nextline]
\begin{description}
\item [templates] Templates base directory. Typically set to \texttt{templates}.
\item [images] Images base directory. Typically set to \texttt{UI/images}.
\item [localepath] Path to locale files. Defaults to \texttt{locale/po}.
Expand All @@ -600,7 +600,7 @@ \subsubsection{[programs] Section}
\subsubsection{[mail] Section}
\label{subsubsec-global-config-ledgersmb-conf-mail}

\begin{description}[style=nextline]
\begin{description}
\item [smtphost] The host name of the smtp server. If provided, then do not use local sendmail. Note that one of sendmail or smtphost has to be provided for email to work.
\item [sendmail] Path the local sendmail executable. If provided then do not use an smtp server. Note that one of sendmail or smtphost has to be provided for email to work.
\item [smtpport] The port number of the smtp server. Note this might vary depending on whether TLS or SSL is used.
Expand Down Expand Up @@ -641,7 +641,7 @@ \subsubsection{[printers] Section}
\subsubsection{[database] Section}
\label{subsubsec-global-config-ledgersmb-conf-database}

\begin{description}[style=nextline]
\begin{description}
\item [host] Name of the host to connect to. See the documentation of the {\tt -h} command line option at
\url{https://www.postgresql.org/docs/current/static/app-psql.html}
for more information (documentation unchanged since before 8.3, so applies to older versions as well)
Expand Down
4 changes: 2 additions & 2 deletions auto-generated/role_list_appendex.tex
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

Auto generated using LedgerSMB version 1.12.0-dev on November 21, 16:06:05 2023 CST.
Auto generated using LedgerSMB version 1.12.0-dev on March 11, 10:39:55 2024 CDT.

\begin{description}[style=nextline]
\begin{description}
\item [account\_all] \htmlspacing
This role combines all \gls{GL} \index{GL}\index{General Ledger} account and GIFI code rights.
\index{account all}
Expand Down
2 changes: 1 addition & 1 deletion ledgersmb-book.tex
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
% \end{quote}
%
% Tables of definitions or options should be formatted as follows:
% \begin{description}[style=nextline]
% \begin{description}
% \item [Major] An increment in the major release number \index{release number} can mean significant architectural,
% \gls{API}, functional, or usage
% changes. It is expected that an upgrade to a new Major version is going to be planned and tested
Expand Down
12 changes: 6 additions & 6 deletions part-administration.tex
Original file line number Diff line number Diff line change
Expand Up @@ -276,7 +276,7 @@ \subsubsection{Part information}

Every part requires the following fields to be entered:

\begin{description}[style=nextline]
\begin{description}
\item [Number] The (alphanumeric) code the company uses to identify the item
\item [Description] The (native language) description of the item, used as the default
description on sales invoices
Expand All @@ -291,7 +291,7 @@ \subsubsection{Part information}

The other fields in this section of the screen are optional:

\begin{description}[style=nextline]
\begin{description}
\item [List price] Informational; can be used for any (monetary) purpose
\item [Last cost] Last buying price, updated when a vendor invoice listing the current part
is posted
Expand Down Expand Up @@ -337,7 +337,7 @@ \subsubsection{Vendor information}
This section of the screen lists one or more vendors from which the part can be
purchased, with purchasing information for the given vendor:

\begin{description}[style=nextline]
\begin{description}
\item [Vendor code] Code used by the vendor to identify the good, to be used by
and future customization and enhancements (currently informational only)
\item [Lead time] Lead time of the part from the vendor in days
Expand All @@ -352,7 +352,7 @@ \subsubsection{Customer information}
where those are required to deviate from the default sell price. This mechanism exists
to support the marketing principle of categorizing customers.

\begin{description}[style=nextline]
\begin{description}
\item [Sell price] Price for this part to be used for this customer
\item [From] Start of the applicability window of the price (inclusive)
\item [To] End of the applicability window of the price (inclusive)
Expand Down Expand Up @@ -513,7 +513,7 @@ \section{Tax account configuration}
accounts they apply to. An account can show up any number of times, with different
Valid To dates.

\begin{description}[style=nextline]
\begin{description}
\item [Account name] The first column; not an input field
\item [Rate (\%)] The rate to be applied to the sales amount
\item [Min Taxable] The minimum amount for which the tax is applicable
Expand Down Expand Up @@ -611,7 +611,7 @@ \subsection{Creating tax forms}

Tax forms have three fields.

\begin{description}[style=nextline]
\begin{description}
\item [Country] Country to which the tax form applies
\item [Description] Name of the tax form to be displayed in drop down lists
\item [Select by Default] % ### TODO verify: Determines if the tax form check mark on invoices is checked or unchecked by default
Expand Down
28 changes: 14 additions & 14 deletions part-configuration.tex
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ \section{Apache}

items to be discussed:

\begin{description}[style=nextline]
\begin{description}
\item [Forwarding of authentication] @@@TODO
\item [PSGI configuration] @@@TODO
\item [performance] cgiD configuration: don't (yet) [but will be supported once all legacy code is gone] @@@TODO
Expand All @@ -41,7 +41,7 @@ \subsection{Differences between Apache 1.3 and 2+}
\section{PostgreSQL}
\label{sec-global-config-postgresql}

\begin{description}[style=nextline]
\begin{description}
\item [pg\_hba.conf] authentication @@@TODO \index{pg\_hba.conf}
\item [security] local vs IP connections @@@TODO
\index{Postgres} \index{Postgres Security}
Expand All @@ -54,7 +54,7 @@ \section{LedgerSMB version numbers}
LedgerSMB version numbers \index{version number} are in the form of Major.Minor.Patch-Optional Tag.
For example, if the production release is \texttt{1.9.27}, then the 1.9 development release is \texttt{1.9.28-dev}.

\begin{description}[style=nextline]
\begin{description}
\item [Major] An increment in the major release number\index{release number} can mean significant architectural, \gls{API}, functional, or usage changes. It is expected that an upgrade to a new Major version is going to be planned and tested by the user organization before upgrading.
\item [Minor] An increment in the minor release number may indicate changes to \glspl{API}\index{API}, interfaces, user instructions, etc. But these changes are not expected to have major impact and should require minor planning and testing. Often small impact enhancements are back-patched to previous Minor versions as patches.
\item [Patch] Increments in the Patch number represent bug fixes, security improvements, or enhancements that do not break existing functionality, usage, or \glspl{API}. These changes are expected to be applied to an installation as soon as possible.
Expand Down Expand Up @@ -284,7 +284,7 @@ \subsection{Account setup}

The main setup consists of the following:

\begin{description}[style=nextline]
\begin{description}
\item[Account Number] Income statements and balance sheets reports are ordered by account number. Traditionally, account numbers are 4 digits with accounts being grouped by the first digit, but this type of grouping is not enforced by LedgerSMB. Grouping is handled using headings as explained in \secref{sec-coa-accounts-structure}.
\item[Description] Should be a relative short, easy to understand description of what the account is used for.
\item[Account Type] Asset, Liability, Equity, Equity temporary, Income or Expense.
Expand All @@ -299,7 +299,7 @@ \subsubsection{Account configuration}

There are currently three types of optional summary accounts:

\begin{description}[style=nextline]
\begin{description}
\item [AR] Marking an account as a summary account for AR means that all outstanding
receivable amounts will be posted to this account. The Accounts Receivable administration
will contain the details of which amount is owed by which \gls{customer}.
Expand All @@ -309,7 +309,7 @@ \subsubsection{Account configuration}

Each account may have zero, one or more of the following options selected.

\begin{description}[style=nextline]
\begin{description}
\item[Contra] This checkmark identifies the account as a \gls{contra}\index{contra}account, which means
that the account is going to hold the opposite of an account it's associated with.
A good example of this kind would be the depreciation account associated with a fixed
Expand All @@ -336,7 +336,7 @@ \subsubsection{Include in drop-down menus}
\subsubsection{Receivables checkmarks}
\label{subsubsec-coa-AR-checkmarks}

\begin{description}[style=nextline]
\begin{description}
\item[Income (AR\_amount)] This check mark adds the account to the list of accounts
in the transaction screens which are used to post income on.

Expand Down Expand Up @@ -366,7 +366,7 @@ \subsubsection{Tracking Items}
The items on this line relate to stocked items, i.e. those tracked for inventory: parts and
assemblies.

\begin{description}[style=nextline]
\begin{description}
\item[Income (IC\_sale)] Adds the account to the selection list of income accounts on the
part and assembly definition screens.
\item[COGS (IC\_cogs)] Adds the account to the selection list of COGS @@@ accounts on the
Expand All @@ -386,7 +386,7 @@ \subsubsection{Non-tracking items}

The items on this line relate to untracked (non stocked) items, i.e. services.

\begin{description}[style=nextline]
\begin{description}
\item[Income (IC\_income)] Adds the account to the income account selection list in
the service definition screen.
\item[Expense (IC\_expense)] Adds the account to the expense account selection list in
Expand All @@ -398,7 +398,7 @@ \subsubsection{Non-tracking items}
\subsubsection{Fixed assets}
\label{subsubsec-coa-fixed-assets}

\begin{description}[style=nextline]
\begin{description}
\item[Fixed asset (Fixed\_Asset)] Marks the account as holding the original asset value for the fixed
assets module, for some classes of fixed assets.
\item[Depreciation (Asset\_Dep)] Marks the account as holding the cumulative depreciation amount
Expand Down Expand Up @@ -509,7 +509,7 @@ \subsection{Taxes}

Each row lists the following fields:

\begin{description}[style=nextline]
\begin{description}
\item [Rate (\%)] The tax rate to be applied when calculating VAT to be posted on this account.
\item [Number] Account number
\item [Valid To] The ending date of the settings in this row. This can apply to the rate as well as the ordering or the tax rules (but usually applies to the rate).
Expand Down Expand Up @@ -587,7 +587,7 @@ \subsubsection{Templates directory}
This setting indicates which set of templates - stored in the
\texttt{templates/} directory - should be used. In a standard installation, the drop down
lists two items:
\begin{description}[style=nextline]
\begin{description}
\item [demo] which contains templates based on \LaTeX, which is more commonly installed but has issues dealing with accented characters
\end{description}

Expand Down Expand Up @@ -662,7 +662,7 @@ \subsubsection{Item numbering}
The numbers shown in the input boxes will be used to generate the next number in the
numbering sequence.

\begin{description}[style=nextline]
\begin{description}
\item [GL Reference number] The default reference number for the next GL transaction.
\item [Sales invoice/ AR Transaction number] This number is used to generate an invoice
number when none is being filled out by the user.
Expand Down Expand Up @@ -723,7 +723,7 @@ \subsection{Departments}
Departments can be used to divide a company in smaller pieces. LedgerSMB distinguishes two
types of departments:

\begin{description}[style=nextline]
\begin{description}
\item [Profit centers] which can be associated with any type of transaction, including AR transactions.
\item [Cost centers] which can be associated with all types of transactions, except AR transactions.
\end{description}
Expand Down
2 changes: 1 addition & 1 deletion part-customization.tex
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ \section{Chart of Accounts import}
The first line of the file contains the headers of the columns. The
import routine expects the columns as presented in (table name).

\begin{description}[style=nextline]
\begin{description}
\item [accno] Number of the account or header
\item [desc] Description for the account or header
\item [charttype] ``H'' for heading record \\
Expand Down
6 changes: 3 additions & 3 deletions part-overview.tex
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,7 @@ \chapter{Introduction to accounting}
The purpose of an accounting system is to keep track of the company's financial status. The following reports are used to
present it:

\begin{description}[style=nextline]
\begin{description}
\item[Balance Sheet] Provides a snapshot of the financial position of a company, listing its possessions (assets), debts (liabilities) and residual value (equity).
\item[Income Statement] Also known as the ``Profit \& Loss Statement'', summarizes the income generated over a specific period and the expenses associated with it, resulting in ``Net Result''.
\item[Cashflow Statement\footnote{\label{cha-accounting-footnote-not-implemented}Not currently implemented in LedgerSMB}] Summarizes the incoming and outgoing cash flows over a specific period, resulting in ``Free Cash Flow''.
Expand All @@ -315,7 +315,7 @@ \chapter{Introduction to accounting}
\end{description}

The accounting system is composed of these parts:
\begin{description}[style=nextline]
\begin{description}
\item [Journals] Contain the company's transactions with extensive additional data; they are the first point of entry for transactions, ordered by order of entry.
\item [Ledgers] Contain aggregated data from the journals, ordered by date.
\item [Chart of Accounts] The categories by which financial data are classified.
Expand All @@ -324,7 +324,7 @@ \chapter{Introduction to accounting}
All accounting data ends up summarized in the \acrshort{GL}. Transactions may be entered in a different (sub)ledger before ending up in the \acrshort{GL}; e.g. the Sales Ledger. With the advent of computerized accounting, the use of journals is in decline: transactions are classified while directly being entered into ledgers.

In addition to the parts mentioned above the following terms are used throughout this document:
\begin{description}[style=nextline]
\begin{description}
\item [Assets] Money and anything that can be converted into money without reducing
the net equity of the business. Assets include money owed, money held, goods
available for sale, property, etc.
Expand Down
8 changes: 4 additions & 4 deletions part-processes.tex
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ \subsection{Creating a Company}

The company tab has the following fields:

\begin{description}[style=nextline]
\begin{description}
\item [Control code] Code to uniquely identify this entity. This is usually generated by clicking on \texttt{Generate Control Code} button. It is also generated automatically when clicking the \texttt{Save} button.
\item [Class] The type of entity; \gls{vendor}, \gls{customer}, etc. Required, but defaults to a known value so it needs to be checked.
\item [Name] Legal name of the company. Required.
Expand All @@ -84,7 +84,7 @@ \subsection{Creating a customer account}
following fields\footnote{To simplify the interface if they're unused, some fields
are not shown in case their selection lists are empty}:

\begin{description}[style=nextline]
\begin{description}
\item [Class] Either a \gls{customer} or \gls{vendor}
\item [Number] Number to identify this account among all other accounts in the company; when left empty, the system will generate one when you click ``Save New''
\item [Description] Textual representation of the account, usually a name
Expand Down Expand Up @@ -145,7 +145,7 @@ \section{Creating Quotations and RFQs}

The listing below describes the meaning of the per \gls{rfq} fields presented in the screen.

\begin{description}[style=nextline]
\begin{description}
\item [Vendor (Customer)] Name of the company the quotation is requested from (issued to)
\item [Currency] Currency for the intended transaction
\item [Shipping point] Address to ship to ??? % ### TODO check with Chris
Expand All @@ -159,7 +159,7 @@ \section{Creating Quotations and RFQs}

The following per item fields are listed.

\begin{description}[style=nextline]
\begin{description}
\item [Item] Order number of the item
\item [Number] Part number of the item to be ordered
\item [Description] Description or name of the item to be ordered
Expand Down
6 changes: 3 additions & 3 deletions scripts/gather-db-info.pl
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

# gather-db-info.pl
#
# Access a running LedgerSMB database and
# retrieve information to create include files for the LEdgerSMB Book.
# Access a running LedgerSMB Postgres database and
# retrieve information to create include files for the LedgerSMB Book.
#
# The user accessing the database requires enough privilages
# to read all tables.
Expand Down Expand Up @@ -81,7 +81,7 @@ ($text)

# create the description begining.
sub description_prolog {
return '\begin{description}[style=nextline]';
return '\begin{description}';
}

# create the description end.
Expand Down

0 comments on commit d8fb4c7

Please sign in to comment.