6.3: More Advanced Typesetting Standards

Last updated
Save as PDF

Page ID: 151078

\( \newcommand{\vecs}[1]{\overset { \scriptstyle \rightharpoonup} {\mathbf{#1}} } \) \( \newcommand{\vecd}[1]{\overset{-\!-\!\rightharpoonup}{\vphantom{a}\smash {#1}}} \)\(\newcommand{\id}{\mathrm{id}}\) \( \newcommand{\Span}{\mathrm{span}}\) \( \newcommand{\kernel}{\mathrm{null}\,}\) \( \newcommand{\range}{\mathrm{range}\,}\) \( \newcommand{\RealPart}{\mathrm{Re}}\) \( \newcommand{\ImaginaryPart}{\mathrm{Im}}\) \( \newcommand{\Argument}{\mathrm{Arg}}\) \( \newcommand{\norm}[1]{\| #1 \|}\) \( \newcommand{\inner}[2]{\langle #1, #2 \rangle}\) \( \newcommand{\Span}{\mathrm{span}}\) \(\newcommand{\id}{\mathrm{id}}\) \( \newcommand{\Span}{\mathrm{span}}\) \( \newcommand{\kernel}{\mathrm{null}\,}\) \( \newcommand{\range}{\mathrm{range}\,}\) \( \newcommand{\RealPart}{\mathrm{Re}}\) \( \newcommand{\ImaginaryPart}{\mathrm{Im}}\) \( \newcommand{\Argument}{\mathrm{Arg}}\) \( \newcommand{\norm}[1]{\| #1 \|}\) \( \newcommand{\inner}[2]{\langle #1, #2 \rangle}\) \( \newcommand{\Span}{\mathrm{span}}\)\(\newcommand{\AA}{\unicode[.8,0]{x212B}}\)

One of the strengths of the Libretexts project is that all pages share similar formatting so it is easy to mix content from different sources. This page contains general formatting rules.

All section headings should use h1, h2, h3, etc …
All text should be full justified.
All number lists should use the CKE list options, this also includes bullets
Erase all indentations
Try to avoid underlines (use bold or italic instead)
Full justify all text (it is automatic, but can be overwritten)
Format figures
Make sure all equations are in MathJax, do not import as images

Units

Where possible, there should be universal adoption of SI units and formatting. To a large extent SI formatting has already been adopted by the contributors to LibreTexts. I note a few exceptions below.
The energy of activation is preferably abbreviated as E_a, not Ea.
Spaces should be inserted in long numbers, for example, 34 500 J/mol is preferred to 34500 J/mol.
Spaces should be included between numbers and units. For example, 273 K is preferred to 273K.
Use the degree symbol when describing degrees Celsius. For example, 25 ⁰C is preferred to 25 C.
Where ‘sec’ is used, change to ‘s’.

Figure Coding (ADVANCED)

While images can be added to pages directly as discussed previously, we have a more advanced system for tying a figure caption to the figure. For now, this is added by selecting the "AddFigureCenterCenter" template.

Once the template is embedded, there will be two spots to add the image and the caption.

This <figure> system is the HTML5 code for semantic representation of images. This allows us to tie in the figure caption to the figure so that they cannot be broken (e.g., by a page break in printing PDFs). It has several additional benefits as well. It acts as a that we can control over the entire site via CSS which allows for a standardization - this applies to the <figcaption> text that is tied to the <figure> code. It also provides a semantic background for the image so that Google and others can tie the figcaption to the figure.