Home Page

Return to Knotts simulation homepage: Knotts Simulation Group

Overview

This is the lab book for the Knotts Simulation Group. Group members can use this for training, displaying results, posting helps, etc.
We ask group members to follow the page set-up outlined below. This allows for continuity and later students will be able to read what you have posted and continue from there.
Also outlined below are basic commands for editing the workbook. If there are any missing that should be included please add them to the list.

Important Notes

When stepping through a process, any command to be directly typed into bash is preceeded by: $
Italicized words are words that change and you will need to fill them in based on your circumstances

Format

You should try to make your pages easy to understand and with the reader in mind. Write them generally and avoid specific and unnecessary details.
Main theme headings will use the underline heading
Subsequent sub-heading will use the small text heading
- Examples should be used to outline the concept, avoid micromanaging.
- Your examples should not require someone to needlessly enter vim and change an example-specific line or two.

Basic Workbook Editing Commands

More commands can be found at:

Start-of-Line Commands

Unless otherwise specified, all of these commands must start in the first character position (no spaces to begin the line)

(:Title ThePageTitleName:) This titles your page and must be done on the first line.
!TheHeadingTitle Creates a large font heading
!!TheHeadingTitle Creates a heading with a line underneath
!!!TheSubHeadingTitle Creates a sub-heading
* Denotes a bullet point

** Two denote indented bullet points, more "*" can be used for multi-level lists.

# Denotes a numbered list. The page will automatically number them in the right order

## Two denote an indented sub-list, more "#" can be use for multi-level numbered lists.

[==] Terminates a numbered sequence, must be on its own line. Termination is also achieved with a line of non-list text.

%item value=3% After the numbered list command, this command changes the list element to the number indicated after the equal sign, in this case 3.

-> Indents the line. Using more dashes will increase the length of the indent. Make sure the preceding line doesn't end with a line break as it is implied.
---- Four dashes will break the page and add a line across the page. Make sure the preceding line doesn't end with a line break as it is implied.
one or more consecutive empty lines in code is rendered as one empty line on the notebook.

In-Line Commands

These commands can executed within the body of your writing or tables.

\\ New Line. Use two backslashes at the end of a line to indicate a new line. Any command from the previous section implies an end to the line just before and a double backslash is not needed
\\\ Creates a double line break and is also executed at the end of the line
[[<<]] Forces a line break that also clears all floating elements (lists, table etc.)
''ItalicFont'' Displays contents with italic font
'''BoldFont''' Displays contents with bold font
{+UnderlineFont+} Displays contents with an underline
@@TypwriterFont@@ Displays contents in a font similar to "bash" font
'+BigFont+' Displays contents with a big font. Using ++ makes it even larger
'-SmallFont-' Displays contents with a small font.
char'^Superscript^' Creates a superscript on the character one previous ex: x²
char'_Subscript_' Creates a subscript on the character one previous ex: y₍₀₎
[[PageLinkOrHyperlink | OptionalDisplayName]] Creates a link to another page or website. Event occurs on the current browser. To open on a new window/tab see below.
%newwin% ArgumentToBeExecutedOnNewWindow %% This will open a new tab/window and then execute the command. Typically coupled with above command.
[@Contents@] Commands within these bounds will not be executed and will be displayed in a "bash" font
(:if false:) ... (:ifend:) The field between the two commands will be commented out and not printed to the page

Table Commands

First an example:

Col 1	Col 2
CellText1	CellText2
CellText3	CellText4
CellText5	CellText6

And the code:
||border=1
||! Col 1 || Col 2 ||
|| CellText1 || CellText2 ||
|| CellText3 || CellText4 ||
|| CellText5 || CellText6 ||

||border=1 This command indicates how thick you want your boarder. Omitting this will fill the page with an un-boarded table.
||! Col 1 || Col 2 || This command indicates the name of each column. NOTE putting an "!" before the name will make the column name bold.
|| CellText1 || CellText2 || This is where your you enter the cell contents. You can use any of the "in-line" commands you want.