Example of what can be done with the CodeCogs documentation system
View version details
Contents  |
|
This page illustrate the many different formating option you have when constructing a page. It also forms a test page to ensure all features of the system are working adequately. In all case the plain text formating is shown followed immediately with the rendered/formatted text.
Begin And End
One of the more important structural commands is
and
which mark out a block of text for special processing. In the following subsections, different block structures are investigates
Code:
- To insert computer code or even an block of data it often looks better if you place it within a 'code' block which will then highlight keywords and format numbers etc. This code block will be used in all our examples on this page:
\begin{code}
int fn(int a, double b)
{
\ do something here
return a+b;
}
\end{code}
gives
int fn(int a, double b)
{
\\ do something here
return a+b;
}
Quote:
- To insert a quote into your text, use:
\begin{quote}
The quick brown fox jumps over the lazy dog
\end{quote}
The quick brown fox jumps over the lazy dog
Yellow:
- To make an important note or warning stand out, use
\begin{yellow}
The quick brown fox jumps over the lazy dog
\end{yellow}
The quick brown fox jumps over the lazy dog
Center:
- To center a piece of text
\begin{center}
The quick brown fox jumps over the lazy dog
\end{center}
The quick brown fox jumps over the lazy dog
Right:
- To place some text on the right size of the screen within a separate area
\begin{right}
The quick brown fox jumps over the lazy dog
\end{right}
This is the normal text
The quick brown fox jumps over the lazy dog
This is the normal text
Equation:
- There are several ways to write an equation, usually we recommend you use '\[' and '\]'. However, you can also use 'equation' within a begin-end block
\begin{equation}
e=mc^2
\end{equation}
Equations
Previously we already mentioned that you could use the \begin{equation} ... \end{equation} block commands, however this is somewhat long handed. An easily alternative is:
\[e=mc^2\]
which gives
For equations that you want to appear on the same line as the text, we use dollar symbols:
The first greek letter, $\alpha$ over the second, $\beta$, is $\frac{\alpha}{\beta}$.
The first greek letter,

over the second,

, is

.
You may have noticed the fraction within the inline equation is compressed to help it fit on the line. If you don't need this, or if you want your equation to appear full size the easiest approach is to add \displaystyle to the front of the equation:
The first greek letter, $\alpha$ over the second, $\beta$, is $\displaystyle \frac{\alpha}{\beta}$.
The first greek letter,

over the second,

, is

.
Equation Numbering:
- To the right of all block equation, an equation number is automatically added. This starts at '1' for the first block equation on the page and continues sequently. Often within the text you would like to refer to the equation. e.g. Equation (2) was derived by Einstein.
In long documents it is frequently very difficult to keep track of the equations numbers, and if you add an addition equation then equations assigned to equations after than added will all increase. To resolve this we allow you to assign you own internal number to any equation you write and refer to this within your text. We therefore introduce the hash, as in # to identify equations and refer to them later. e.g.
\[f=ma\]#42
\[v=u+2 a s\]#43
Newton wrote equation #42 all by himself. Equation (#43) helps you find
the final velocity of an object given its starting speed, acceleration and time of acceleration.
Newton wrote equation 3 all by himself. Equation (4) helps you find the final velocity of an object given its starting speed, acceleration and time of acceleration.
Lists
There are three main list styles that the documentation system will help you write. To make a list, you need to start each list line with a space, followedge by '-','#' or '@' for the three different forms possible:
Bullet Point List:
- first
- second
- third
Numeric List:
# first
# second
# third
- first
- second
- third
Alphabetical List:
@ first
@ second
@ third
- first
- second
- third
For more complex list styles use HTML commands.
Last Modified: 2009-03-27 00:07:04 Page Rendered: 2010-03-09 15:41:54