Resources.FitNesseRoot.FitNesse.UserGuide.QuickReferenceGuide.content.txt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of fitnesse Show documentation
Show all versions of fitnesse Show documentation
The fully integrated standalone wiki, and acceptance testing framework.
!***< HIDDEN!
###### TEMPLATE
#!anchor ?
#| ? |${CODE} ? ${CODEend}|
!define TopFONT {!--!}
!define FONTend {!--!}
!define TopOfPAGE (${TopFONT}${SPC}${SPC}${SPC}${SPC}${SPC}${SPC}${SPC}${SPC}[[${LPAREN}to top${RPAREN}][#TopOfPAGE]]${FONTend})
!define FitNESSE {!-FitNesse-!}
| !define OPT {''[''} | !define OPTend {'']''} | !define OR {''!- |-!''} |
| !define DOT {'''.'''} | !define LT {'''<'''} | !define GT {'''>'''} |
| !define BAR {'''!- | -!'''} | !define LBRACE ('''{''') | !define RBRACE ('''}''') |
| !define DIVend {!--!} | | !define TEXT {''text''} | | !define SLASH {'''/'''} | !define NUL {} | | !define PageNAME {''!-PageName-!''} | !define PagePATH {''!-PagePath-!''} | | !define LabelNAME {''label-name''} | !define AnyPagePATH {''!-AnyPagePath-!''} | | !define CODE {!--!} | !define CODEend (${FONTend}) | #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - !define BUTTON {!--!} !define BUTTONend {!- -!} #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - !define FitNesseCHARACTERSET (${OPT}'''-Dfile.encoding=UTF-8'''${OPTend}) !define FitNesseOptCLASSPATH ('''-cp fitnesse.jar'''${OPT}''';'''${NUL}''other.jar.or.path''${OPTend}...) !define FitNesseOptEXPIRE ('''-e''' ''days'') !define FitNesseOptOMIT ('''-o''') !define FitNesseOptPORT ('''-p''' ''port#'') !define FitNesseOptROOT ('''-r''' ''N${NUL}ameOfRootPage'') !define FitNesseOptDIR ('''-d''' ''/path/to/fitnesse/root'') !define FitNesseOptLOG ('''-l''' ''/log/file/path/and/name'') !define FitNesseOptOneAUTH (''username''${NUL}''':'''${NUL}''password'') !define FitNesseOptFileAUTH (''/auth/file/path/and/name'') #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - !define HorizontalLINES (|${CODE}''over-text''${NUL}'''!------!'''${NUL}''under-text''${CODEend}|thinnest| | ${CODE}''over-text''${NUL}'''!-------!'''${NUL}''under-text''${CODEend} |safest - no conflict with workflow phase separators| |${CODE}''over-text''${NUL}'''!-----------!'''${NUL}''under-text''${CODEend}|thicker | ) #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - !define HEADINGS (${BANG}'''1''' ''largest heading text'' ${BANG}'''2''' ''middle heading text'' ${BANG}'''3''' ''smaller heading text'' and so on up to ${BANG}'''6''' ) #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - !define CollapsibleEXPANDED (${BANG}'''*''' ${OPT}''title''${OPTend} ${SPC}${SPC}'' multi-line wiki text '' ${SPC}${SPC}'' N.B.: Multiple asterisks are allowed, e.g.,'' ${BANG}'''****''' ${TEXT} '''*'''${BANG} ) !define 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} ) !define 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} ) #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - !define LSQUARE {'''['''} !define RSQUARE {''']'''} !define 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| |${CODE} ${LSQUARE}${LSQUARE}${TEXT}${RSQUARE}${LSQUARE}${AnyPagePATH}${RSQUARE}${RSQUARE} ${CODEend} | in an alias | ) #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - !define CollapSIBLE (|${CODE} ${CollapsibleEXPANDED} ${CODEend}| expanded | | |${CODE} ${CollapsibleCOLLAPSED} ${CODEend}|collapsed| | |${CODE} ${CollapsibleINVISIBLE} ${CODEend}|invisible|''useful for hidding define's, etc.''| ) #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - !define HASH {'''!-#-!'''} | !define 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 | ) #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - !define 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 | ) #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - !define 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 | ) #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - !define TocInsert (| Contents List | ${CODE} ${BANG}'''contents''' ${CODEend} | | Contents Tree | ${CODE} ${BANG}'''contents -R''' ${CODEend} | | Contents Sub-tree | ${CODE} ${BANG}'''contents -R'''${OPT}''nn''${OPTend}${CODEend} | | Contents List - Graceful | ${CODE} ${BANG}'''contents -g''' ${CODEend} | | Contents List - Properties | ${CODE} ${BANG}'''contents -p''' ${CODEend} | | Contents List - Suite Filters | ${CODE} ${BANG}'''contents -f''' ${CODEend} | | Contents List - Help Text | ${CODE} ${BANG}'''contents -h''' ${CODEend} | ) #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - !define 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}''' ${CODEend} | as a clickable link | ) #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - !define 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}''':''' ) #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - !define SearchForFIXTURE (G${NUL}raceFullName${NL}'''fit.'''G${NUL}raceFullName${NL}G${NUL}raceFullName'''Fixture'''${NL}'''fit.'''G${NUL}raceFullName'''Fixture''') !define SearchForMETHOD (graceFullMethod${LPAREN}${RPAREN}${NL}'''get'''G${NUL}raceFullMethod${LPAREN}${RPAREN}${NL}'''set'''G${NUL}raceFullMethod${LPAREN}${RPAREN} ${LPAREN}if setter context${RPAREN}) !define SearchForARG1 (methodName${LPAREN}''p1''${RPAREN}${NL}'''get'''M${NUL}ethodName(''p1''${RPAREN}${NL} '''set'''M${NUL}ethodName(''p1''${RPAREN}) !define SearchForARG1TOO (methodNameToo${LPAREN}''p1''${RPAREN}${NL}'''get'''M${NUL}ethodNameToo${LPAREN}''p1''${RPAREN}${NL}'''set'''M${NUL}ethodNameToo${LPAREN}''p1''${RPAREN}) !define SearchForARG2 (methodName${LPAREN}''p1'',''p2''${RPAREN}${NL}'''get'''M${NUL}ethodName${LPAREN}''p1'',''p2''${RPAREN}${NL}'''set'''M${NUL}ethodName${LPAREN}''p1'',''p2''${RPAREN}) !define SearchForARG2TOO (methodNameToo${LPAREN}''p1'',''p2''${RPAREN}${NL}'''get'''M${NUL}ethodNameToo${LPAREN}''p1'',''p2''${RPAREN}${NL}'''set'''M${NUL}ethodNameToo${LPAREN}''p1'',''p2''${RPAREN}) !define 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} | ) *! #******************************************************************************************* #******************************************************************************************* #******************************************************************************************* !1 ${FitNESSE} Cheat Sheet !anchor TopOfPAGE !2 Sections * '''[[ ${FitNESSE} Command Line ][#FitNesseCommandLINE]] ''' * '''[[ Character Formatting ][#CharacterFORMATTING]] ''' * '''[[ Line & Block Formatting ][#LineBlockFORMATTING]] ''' * '''[[ Links & References ][#LinksAndREFERENCES]] ''' * '''[[ Includes & Informational ][#IncludesINFORMATIONAL]] ''' * '''[[ Variable Usage ][#VARIABLES]] ''' * '''[[ Global Variables ][#GlobalVARIABLES]] ''' * '''[[ Global Properties ][#GlobalPROPERTIES]] ''' * '''[[ Testable Tables ][#TestTABLES]] ''' * '''[[ Wiki Page Actions ][#FitNesseACTIONS]] ''' #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - !2 Glossary | ${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". | #--------------------------------------------------------------------------------------------- !anchor FitNesseCommandLINE ---- !2 !-FitNesse-! Command Line and Options ${TopOfPAGE} | ${CODE} ${OPT}''path/to/java/''${OPTend}'''java''' ${FitNesseCHARACTERSET} ${FitNesseOptCLASSPATH} '''fitnesse.${FitNESSE}''' ${OPT}${FitNesseOptOMIT}${OPTend} ${OPT}${FitNesseOptPORT}${OPTend} ${OPT}${FitNesseOptDIR}${OPTend} ${OPT}${FitNesseOptROOT}${OPTend} ${OPT}${FitNesseOptEXPIRE}${OPTend} ${OPT}${FitNesseOptLOG}${OPTend} ${OPT}'''-a''' ''{''${FitNesseOptOneAUTH} ${OR} ${FitNesseOptFileAUTH}''}''${OPTend} ${OPT}''other arguments''${OPTend} ${CODEend} | | ''' ''option'' ''' | ''' ''default'' ''' | ''' ''description'' ''' | | ${CODE}'''-a''' ${FitNesseOptOneAUTH}${CODEend} | ${CODE} ''no auth'' ${CODEend} | Enforces access for one user | | ${CODE}'''-a''' ${FitNesseOptFileAUTH}${CODEend} | ${CODE} ''no auth'' ${CODEend} | Enforces access for a file of users with encrypted passwords | | ${CODE}${FitNesseOptDIR}${CODEend} | ${CODE} ${DOT} ${CODEend} | Path to the fitnesse ''wiki'' home where ${FitNESSE}Root or ''-r name'' resides | | ${CODE}${FitNesseOptEXPIRE}${CODEend} | ${CODE} '''14''' ${CODEend} | Number of days to retain older versions (.zip files) | | ${CODE}${FitNesseOptLOG}${CODEend} | ${CODE} ''off'' ${CODEend} | Where to put and what to call the run log | | ${CODE}${FitNesseOptOMIT}${CODEend} | ${CODE} ''update'' ${CODEend} | Prevents (omits) updating ${FitNESSE}Root content| | ${CODE}${FitNesseOptPORT}${CODEend} | ${CODE} '''80''' ${CODEend} | Port for ${FitNESSE} to listen on | | ${CODE}${FitNesseOptROOT}${CODEend} | ${CODE} '''${FitNESSE}Root''' ${CODEend} | Name of root folder in the fitnesse ''wiki'' home or ''-d'' path | | ${CODE}${FitNesseCHARACTERSET}${CODEend} | ${CODE} ''off'' ${CODEend} | Unicode characters support in Test History Page | #--------------------------------------------------------------------------------------------- !anchor FitNesseACTIONS !2 !-FitNesse-! Actions ${TopOfPAGE} | '''Edit''' this page | ${CODE} ''url''${NUL}'''?edit''' ${CODEend} | | '''Create''' a new page directly | ${CODE}''current-url''${NUL}'''.'''!-NewPageName-!${NUL}${CODEend}${NL}'''or''' ${NL} ${CODE}''current-url''${NUL}'''.'''!-NewPageName-!${NUL}'''?edit'''${CODEend} | | '''Test''' this page | ${CODE} ''url''${NUL}'''?test''' ${CODEend} | | '''Suite''' test this page | ${CODE} ''url''${NUL}'''?suite''' ${CODEend} | | Set '''properties''' of this page | ${CODE} ''url''${NUL}'''?properties''' ${CODEend} | | See '''versions''' of this page | ${CODE} ''url''${NUL}'''?versions''' ${CODEend} | | '''Refactor''' this page | ${CODE} ''url''${NUL}'''?refactor''' ${CODEend} | | '''Search''' pages from here | ${CODE} ''url''${NUL}'''?searchForm''' ${CODEend} | | '''Where''' is this page referenced? | ${CODE} ''url''${NUL}'''?whereUsed''' ${CODEend} | | '''Debug''' this test page | ${CODE} ''url''${NUL}'''?debug''' ${CODEend} | | '''Suite''' test this page with a suite filter "passing" | ${CODE} ''url''${NUL}'''?responder=suite&suiteFilter=passing''' ${CODEend} | #--------------------------------------------------------------------------------------------- !anchor CharacterFORMATTING !2 Character Formatting ${TopOfPAGE} | Comment | ${CODE} '''!-#-!'''${TEXT} ${CODEend} | ''Can also be used to comment-out markup'' | | Italics | ${CODE} '''!-''-!'''${TEXT}'''!-''-!''' ${CODEend} | | | Bold | ${CODE} '''!-'''-!'''${TEXT}'''!-'''-!''' ${CODEend} | | | Style | ${CODE} '''!-!style_