FitNesse.UserGuide.QuickReferenceGuide

#!anchor ?

variable defined: TopFONT=!lit?0?
variable defined: FONTend=!lit?1?
variable defined: TopOfPAGE=${TopFONT}${SPC}${SPC}${SPC}${SPC}${SPC}${SPC}${SPC}${SPC}[[${LPAREN}to top${RPAREN}][#TopOfPAGE]]${FONTend}

variable defined: FitNESSE=!lit?2?

variable defined: OPT=''[''	variable defined: OPTend='']''	variable defined: OR=''!lit?3?''
variable defined: DOT='''.'''	variable defined: LT='''<'''	variable defined: GT='''>'''
variable defined: BAR='''!lit?4?'''	variable defined: LBRACE='''{'''	variable defined: RBRACE='''}'''
variable defined: DIVend=!lit?5?	variable defined: LPAREN='''('''	variable defined: RPAREN=''')'''
variable defined: BANG='''!lit?6?'''	variable defined: SPC=!lit?7?	variable defined: NL=!lit?8?
variable defined: TEXT=''text''		variable defined: SLASH='''/'''	variable defined: NUL=
variable defined: PageNAME=''!lit?9?''	variable defined: PagePATH=''!lit?10?''
variable defined: LabelNAME=''label-name''	variable defined: AnyPagePATH=''!lit?11?''
variable defined: CODE=!lit?12?	variable defined: CODEend=${FONTend}
variable defined: HDR=!lit?13?	variable defined: HDRend=${TopOfPAGE}${DIVend}

variable defined: TOC=|${HDR} Sections ${DIVend}| |!c '''[[ ${FitNESSE} Command Line ][#FitNesseCommandLINE]] ''' | |!c '''[[ Character Formatting ][#CharacterFORMATTING]] ''' | |!c '''[[ Line & Block Formatting ][#LineBlockFORMATTING]] ''' | |!c '''[[ Links & References ][#LinksAndREFERENCES]] ''' | |!c '''[[ Includes & Informational ][#IncludesINFORMATIONAL]] '''| |!c '''[[ Variable Usage ][#VARIABLES]] ''' | |!c '''[[ Global Variables ][#GlobalVARIABLES]] ''' | |!c '''[[ Global Properties ][#GlobalPROPERTIES]] ''' | |!c '''[[ Testable Tables ][#TestTABLES]] ''' | |!c '''[[ Wiki Page Actions ][#FitNesseACTIONS]] ''' |
variable defined: GLOSSARY=|${HDR} Glossary ${DIVend}| |${PagePATH} |${CODE} ${PageNAME}${DOT}${OPT}${PageNAME}${OPTend} ${CODEend} | |${AnyPagePATH}|${CODE} ${OPT}${LT}${OR}${DOT}${OR}${GT}${OPTend}${PagePATH} ${CODEend} | |Symbolic Link |A locally-defined alias to any accessible page.${NL}Symbolic links are created by clicking ${BUTTON}Properties${BUTTONend}${NL}and entering information in the bottom section${NL}titled "Symbolic Links".|
variable defined: BUTTON=!lit?14?
variable defined: BUTTONend=!lit?15?
variable defined: FitNesseOptCLASSPATH='''-cp fitnesse.jar'''${OPT}''';'''${NUL}''other.jar.or.path''${OPTend}...
variable defined: FitNesseOptEXPIRE='''-e''' ''days''
variable defined: FitNesseOptOMIT='''-o'''
variable defined: FitNesseOptPORT='''-p''' ''port#''
variable defined: FitNesseOptROOT='''-r''' ''N${NUL}ameOfRootPage''
variable defined: FitNesseOptDIR='''-d''' ''/path/to/fitnesse/root''
variable defined: FitNesseOptLOG='''-l''' ''/log/file/path/and/name''
variable defined: FitNesseOptOneAUTH=''username''${NUL}''':'''${NUL}''password''
variable defined: FitNesseOptFileAUTH=''/auth/file/path/and/name''
variable defined: HorizontalLINES=|${CODE}''over-text''${NUL}'''!lit?16?'''${NUL}''under-text''${CODEend}|thinnest| |${CODE}''over-text''${NUL}'''!lit?17?'''${NUL}''under-text''${CODEend} |safest - no conflict with workflow phase separators| |${CODE}''over-text''${NUL}'''!lit?18?'''${NUL}''under-text''${CODEend}|thicker |
variable defined: HEADINGS=${BANG}'''1''' ''largest heading text'' ${BANG}'''2''' ''middle heading text'' ${BANG}'''3''' ''smaller heading text'' and so on up to &bang;6
variable defined: CollapsibleEXPANDED=${BANG}'''*''' ${OPT}''title''${OPTend} ${SPC}${SPC}'' multi-line wiki text '' ${SPC}${SPC}'' N.B.: Multiple asterisks are allowed, e.g.,'' ${BANG}'''****''' ${TEXT} '''*'''${BANG}
variable defined: CollapsibleCOLLAPSED=${BANG}'''*'''${GT} ${OPT}''title''${OPTend} ${SPC}${SPC}'' multi-line wiki text '' ${SPC}${SPC}'' N.B.: Multiple asterisks are allowed, e.g.,'' '''${BANG}****'''${GT} ${TEXT} '''*'''${BANG}
variable defined: CollapsibleINVISIBLE=${BANG}'''*'''${LT} ${OPT}''title''${OPTend} ${SPC}${SPC}'' multi-line wiki text '' ${SPC}${SPC}'' N.B.: Multiple asterisks are allowed, e.g.,'' ${BANG}'''****'''${LT} ${TEXT} '''*'''${BANG}
variable defined: PageLINKS=|${CODE} ${DOT}R${NUL}ootPage${OPT}${DOT}C${NUL}hildPage${OPTend} ${CODEend}| from root | |${CODE} S${NUL}ameLevelPage${OPT}${DOT}C${NUL}hildPage${OPTend} ${CODEend}|sibling | |${CODE} ${GT}C${NUL}hildPage${OPT}${DOT}C${NUL}hildPage${OPTend} ${CODEend}|child or symbolic|
variable defined: CollapSIBLE=|${CODE} ${CollapsibleEXPANDED} ${CODEend}| expanded | | |${CODE} ${CollapsibleCOLLAPSED} ${CODEend}|collapsed| | |${CODE} ${CollapsibleINVISIBLE} ${CODEend}|invisible|''useful for hidding define's, etc.''|
variable defined: HASH='''!lit?19?'''
variable defined: LSQUARE='''['''
variable defined: RSQUARE=''']'''

variable defined: JumpTO= |${CODE} ${TEXT} ${HASH}${LabelNAME} ${TEXT} ${CODEend} |in-line | |${CODE} ${DOT}${HASH}${LabelNAME} ${CODEend} |left-justified| |${CODE} ${LSQUARE}${LSQUARE}${TEXT}${RSQUARE}${LSQUARE}${HASH}${LabelNAME}${RSQUARE}${RSQUARE} ${CODEend}|in an alias |
variable defined: ExternalLINKS=|${CODE} '''http:'''${SLASH}${SLASH}''url-path'' ${NL} ${CODEend}| Web | |${CODE} '''http:'''${SLASH}${SLASH}'''files'''${SLASH}''localPath'' ${CODEend} |Local | |${CODE} ${LSQUARE}${LSQUARE}${TEXT}${RSQUARE}${LSQUARE}/files'''${SLASH}''localPath''${NUL}${RSQUARE}${RSQUARE} ${CODEend}|Alias | |${CODE} ${LSQUARE}${LSQUARE}${TEXT}${RSQUARE}${LSQUARE}${AnyPagePATH}${HASH}${LabelNAME}${RSQUARE}${RSQUARE} ${CODEend} |Alias | |${CODE} ${TEXT}'''@'''${TEXT}${DOT}${TEXT} ${CODEend} |mailto|
variable defined: IncludePAGE=|${CODE} ${BANG}'''include''' ${AnyPagePATH} ${CODEend}| expanded border | |${CODE} ${BANG}'''include -c''' ${AnyPagePATH} ${CODEend} |collapsed border | |${CODE} ${BANG}'''include -seamless''' ${AnyPagePATH} ${CODEend} |no border | |${CODE} ${BANG}'''include -setup''' ${AnyPagePATH} ${CODEend} |appears like S${NUL}etUp | |${CODE} ${BANG}'''include -teardown''' ${AnyPagePATH} ${CODEend} |appears like T${NUL}earDown| |${CODE} ${BAR}${SPC}${BANG}'''include ''' ${AnyPagePATH}${SPC}${BAR} ${CODEend}|in a table cell |
variable defined: PictureINSERT=|${CODE} ${BANG}'''img''' ''url-to-image-file'' ${CODEend}| in-line | |${CODE} ${BANG}'''img-l''' ''url-to-image-file'' ${CODEend} |image left-justified, text wraps on right | |${CODE} ${BANG}'''img-r''' ''url-to-image-file'' ${CODEend} |image right-justified, text wraps on the left| |${CODE} '''[['''${BANG}'''img'''${OPT}'''-l'''${OR}'''-r'''${OPTend} ''url-to-image-file''${NUL}''']['''${NUL}''some-link''${NUL}''']]''' ${CODEend}|as a clickable link |
variable defined: FixtureTABLE=${BANG}${BAR} ''fixture specification'' ${BAR} ${OPT}${BAR} ''optional table row'' ${BAR}${OPT} ''optional 2nd column'' ${BAR}${OPTend}'''...'''${OPTend} ${OPT}${BAR} ''optional table row'' ${BAR}${OPT} ''optional 2nd column'' ${BAR}${OPTend}'''...'''${OPTend} ${SPC}${SPC}${SPC}${SPC}${SPC}${SPC}${SPC}''':'''
variable defined: SearchForFIXTURE=G${NUL}raceFullName${NL}'''fit.'''G${NUL}raceFullName${NL}G${NUL}raceFullName'''Fixture'''${NL}'''fit.'''G${NUL}raceFullName'''Fixture'''

variable defined: SearchForMETHOD=graceFullMethod${LPAREN}${RPAREN}${NL}'''get'''G${NUL}raceFullMethod${LPAREN}${RPAREN}${NL}'''set'''G${NUL}raceFullMethod${LPAREN}${RPAREN} ${LPAREN}if setter context${RPAREN}

variable defined: SearchForARG1=methodName${LPAREN}''p1''${RPAREN}${NL}'''get'''M${NUL}ethodName(''p1''${RPAREN}${NL} '''set'''M${NUL}ethodName(''p1''${RPAREN}

variable defined: SearchForARG1TOO=methodNameToo${LPAREN}''p1''${RPAREN}${NL}'''get'''M${NUL}ethodNameToo${LPAREN}''p1''${RPAREN}${NL}'''set'''M${NUL}ethodNameToo${LPAREN}''p1''${RPAREN}

variable defined: SearchForARG2=methodName${LPAREN}''p1'',''p2''${RPAREN}${NL}'''get'''M${NUL}ethodName${LPAREN}''p1'',''p2''${RPAREN}${NL}'''set'''M${NUL}ethodName${LPAREN}''p1'',''p2''${RPAREN}

variable defined: SearchForARG2TOO=methodNameToo${LPAREN}''p1'',''p2''${RPAREN}${NL}'''get'''M${NUL}ethodNameToo${LPAREN}''p1'',''p2''${RPAREN}${NL}'''set'''M${NUL}ethodNameToo${LPAREN}''p1'',''p2''${RPAREN}

variable defined: FixtureNAMING=|!note The cells below are on one line regardless of word-wrapping | |'''table spec''' |'''Searches for:'''| |${CODE} ${BANG}${BAR} Grace Full Name ${BAR} ${CODEend} |${SearchForFIXTURE}| |${CODE} ${BANG}${BAR} grace full method ${BAR} ${CODEend} |${SearchForMETHOD} | |${CODE} ${BANG}${BAR} method name ${BAR}''p1''${BAR} ${CODEend} |${SearchForARG1} | |${CODE} ${BANG}${BAR} method name ${BAR}''p1''${BAR} too ${BAR} ${CODEend} |${SearchForARG1TOO}| |${CODE} ${BANG}${BAR} method name ${BAR}''p1''${BAR} also ${BAR}''p2''${BAR} ${CODEend} |${SearchForARG2} | |${CODE} ${BANG}${BAR} method name ${BAR}''p1''${BAR}''' also ${BAR}''p2''${BAR} too ${BAR} ${CODEend}|${SearchForARG2TOO}|

FitNesse Cheat Sheet

Sections

FitNesse Command Line

Character Formatting

Line & Block Formatting

Links & References

Includes & Informational

Variable Usage

Global Variables

Global Properties

Testable Tables

Wiki Page Actions

Glossary
PagePath	PageName.[PageName]
AnyPagePath	[< \|. \|>]PagePath </font>
Symbolic Link	A locally-defined alias to any accessible page. Symbolic links are created by clicking Properties and entering information in the bottom section titled "Symbolic Links".

See run.sh and run.bat for examples of default start-up scripts.

FitNesse Command Line and Options
[path/to/java/]java -cp fitnesse.jar[;other.jar.or.path]... fitnesse.FitNesse [-o] [-p port#] [-d /path/to/fitnesse/root] [-r NameOfRootPage] [-e days] [-l /log/file/path/and/name] [-a {username:password \| /auth/file/path/and/name}] [other arguments] </font>
*option*	*default*	*description*
-a <i>username</i><b>:</b><i>password</i></font>	no auth </font>	Enforces access for one user
-a /auth/file/path/and/name</font>	no auth </font>	Enforces access for a file of users with encrypted passwords
-d /path/to/fitnesse/root</font>	. </font>	Path to the fitnesse wiki home where FitNesseRoot or -r name resides
-e days</font>	14 </font>	Number of days to retain older versions (.zip files)
-l /log/file/path/and/name</font>	off </font>	Where to put and what to call the run log
-o</font>	update </font>	Prevents (omits) updating from fitnesse.org
-p port#</font>	80 </font>	Port for FitNesse to listen on
<b>-r</b> <i>NameOfRootPage[?]</i></font>	FitNesseRoot </font>	Name of root folder in the fitnesse wiki home or -d path

FitNesse Actions (to top)
Edit this page	url?edit </font>
Create a new page directly	current-url.NewPageName</font> or current-url.NewPageName?edit</font>
Test this page	url?test </font>
Suite test this page	url?suite </font>
Set properties of this page	url?properties </font>
See versions of this page	url?versions </font>
Refactor this page	url?refactor </font>
Search pages from here	url?searchForm </font>
Where is this page referenced?	url?whereUsed </font>
Debug this test page	url?debug </font>
Suite test this page with a suite filter "passing"	url?responder=suite&suiteFilter=passing </font>

Character Formatting <font style="font-family:Arial;font-size:8pt">        <a href="#TopOfPAGE"><b>(</b>to top<b>)</b></a></font></div>
Comment	#text </font>	Can also be used to comment-out markup
Italics	''text'' </font>
Bold	'''text''' </font>
Style	!style_(text) </font>	The style of text will be the CSS class <someStyle>
Strike-through	--text-- </font>
"As-is"/escaping	!-text-! </font>	Can also be used to insert HTML tags directly
"As-is"	!<text>! </font>	Will escape HTML tags so they display in plain text.
Alias Link	[[text][AnyPagePath]] </font>

Line & Block Formatting         <a href="#TopOfPAGE">(to top)</a></div>

workflow break

---- ...separates each "phase"

Horizontal Line

over-text----under-text</font>	thinnest
over-text-----under-text</font>	safest - no conflict with workflow phase separators
over-text---------under-text</font>	thicker

Note

!note text

Headings

!1 largest heading text
!2 middle heading text
!3 smaller heading text
and so on up to !6

Centered

!c text

Formatted "as is"

{{{text}}}

note: causes extra line afterward

Collapsible

!* [title] multi-line wiki text N.B.: Multiple asterisks are allowed, e.g., !******** text *! </font>	expanded
!> [title] multi-line wiki text* N.B.: Multiple asterisks are allowed, e.g., !***> text* *! </font>	collapsed
!< [title] multi-line wiki text* N.B.: Multiple asterisks are allowed, e.g., !*******< text* *! </font>	invisible	useful for hidding define's, etc.

Links & References         <a href="#TopOfPAGE">(to top)</a></div>

Page links

.RootPage[.ChildPage] </font>	from root
SameLevelPage[.ChildPage] </font>	sibling
>ChildPage[.ChildPage] </font>	child or symbolic

Cross-reference &
Suite Include

!see AnyPagePath

Define "in-page" label

!anchor label-name

a.k.a. anchor

Jump to "in-page" label

text #label-name text </font>	in-line
.#label-name </font>	left-justified
[[text][#label-name]] </font>	in an alias

External Links

http://url-path </font>	Web
http://files/localPath </font>	Local
[[text][/files'/localPath'']] </font>	Alias
[[text][AnyPagePath#label-name]] </font>	Alias
text@text.text </font>	mailto

Includes & Informational         <a href="#TopOfPAGE">(to top)</a></div>

Timestamp

!lastmodified

Timestamp

!today

Contents List

!contents

Contents Tree

!contents -R

Contents Sub-tree

!contents -R[nn]

Contents List - Graceful

!contents -g

Contents List - Properties

!contents -p

Contents List - Suite Filters

!contents -f

Contents List - Help Text

!contents -h

Include Page

!include AnyPagePath </font>	expanded border
!include -c AnyPagePath </font>	collapsed border
!include -seamless AnyPagePath </font>	no border
!include -setup AnyPagePath </font>	appears like SetUp
!include -teardown AnyPagePath </font>	appears like TearDown
\| !include AnyPagePath \| </font>	in a table cell

Picture Insert

!img url-to-image-file </font>	in-line
!img-l url-to-image-file </font>	image left-justified, text wraps on right
!img-r url-to-image-file </font>	image right-justified, text wraps on the left
[[!img[-l \|-r] url-to-image-file][some-link]] </font>	as a clickable link

Variables <font style="font-family:Arial;font-size:8pt">        <a href="#TopOfPAGE"><b>(</b>to top<b>)</b></a></font></div>
Variable Definition	!define name {value} !define name (value) </font>
Variable Usage	${name} </font>
Expression Evaluation	${=expression=} </font>	expression may contain variables

Global Variables <font style="font-family:Arial;font-size:8pt">        <a href="#TopOfPAGE"><b>(</b>to top<b>)</b></a></font></div>
NAME	Java Default	FitLibrary (Unix) Default	.NET Default
COMMAND_PATTERN </font>	java -cp %p %m	java -cp %p %m	%m %p
REMOTE_DEBUG_COMMAND</font>	java -Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 -cp %p %m	java -Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 -cp %p %m	java -Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 -cp %p %m
PATH_SEPARATOR </font>	: (system-dependent)	: (system-dependent)	;
TEST_RUNNER </font>	fit.FitServer	fitlibrary.suite.FitLibraryServer	dotnet\FitServer.exe

NAME	Default	Values	Notes
TEST_SYSTEM </font>	fit	fit\|slim	Selects the test system to use for this, and descendant pages.
SLIM_PORT </font>	8085	integer	Selects the starting port number in a range of 10 for slim.
CLASSPATH_PROPERTY </font>	nil	an environment variable	If not nil, loads classpath (as gathered from !path) into the named environment variable. See CustomizingTestExecution.
CM_SYSTEM </font>	nil	java class	Selects the class that will handle CM system events.
COLLAPSE_SETUP </font>	false	true \|false	Collapses all SetUps
COLLAPSE_TEARDOWN </font>	false	true \|false	Collapses all TearDowns
FILTER_TOC </font>	false	true \|false	Append suite fiters to TOC
HELP_PREFIX_TOC </font>	:<space>	any string	Define prefix for help text suffix
HELP_TOC </font>	false	true \|false	Append help text to TOC
MORE_SUFFIX_TOC </font>	<space>...	any string	Define sequence to show more TOC levels
PROPERTY_CHARACTERS </font>	*+@>-	any characters	Define property icons for TOC
PROPERTY_TOC </font>	false	true \|false	Append property icons to TOC
REGRACE_LINK </font>	false	true \|false	Makes links graceful
REGRACE_TOC </font>	false	true \|false	Makes !contents list graceful
RSS_PREFIX </font>	!c	!c	Link prefix for RSS Feeds
PAGE_NAME </font>	!c	Read Only	Name of current page
PAGE_PATH </font>	!c	Read Only	Fully qualified name of parent.
FITNESSE_PORT </font>	!c	Read Only	Port number that fitnesse is using.

(See the root page for overrides)

Global Properties <font style="font-family:Arial;font-size:8pt">        <a href="#TopOfPAGE"><b>(</b>to top<b>)</b></a></font></div>
path.separator </font>	(system-dependent)

(See the root page for overrides)

Testable Tables         <a href="#TopOfPAGE">(to top)</a></div>

Classpath include

!path java.path.spec

"Insert Fixture Table"
Edit List Include

!fixture path.fixture

Prevent Wikification

! | "as is" or escaped content |

Smallest Table

| text |

Fixture Table

! | fixture specification |
[ | optional table row |[ optional 2nd column |]...]
[ | optional table row |[ optional 2nd column |]...]
:

Graceful Naming

The cells below are on one line regardless of word-wrapping
table spec	Searches for:
! \| Grace Full Name \| </font>	GraceFullName fit.GraceFullName GraceFullNameFixture fit.GraceFullNameFixture
! \| grace full method \| </font>	graceFullMethod() getGraceFullMethod() setGraceFullMethod() (if setter context)
! \| method name \|p1 \| </font>	methodName(p1) getMethodName(p1) setMethodName(p1)
! \| method name \|p1 \| too \| </font>	methodNameToo(p1) getMethodNameToo(p1) setMethodNameToo(p1)
! \| method name \|p1 \| also \|p2 \| </font>	methodName(p1,p2) getMethodName(p1,p2) setMethodName(p1,p2)
! \| method name \|p1 \|' also \|p2'' \| too \| </font>	methodNameToo(p1,p2) getMethodNameToo(p1,p2) setMethodNameToo(p1,p2)

Add Child Page to QuickReferenceGuide