Template details

The following tables document of all of the templates available with details of the variables that are valid for each template. Some examples of how the templates are used are also shown.

Table 1. Key Text

Name	Description	Variables	Examples
Key title	Key title	none	Key
			Legende
Stitch entry flat	Stitch key entry in flat mode	${abbreviation} - abbreviation of stitch	RS: knit WS: purl
		${displayString} - display string of stitch. If not defined, then name of stitch	RS - knit, WS - purl
		${longDescription} - long description of stitch
		${WSabbreviation} - abbreviation of WS stitch
		${WSdisplayString} - display string of WS stitch. If not defined, then name of WS stitch
		${WSlongDescription} - long description of WS stitch
Stitch entry circular	Stitch key entry in circular mode	${abbreviation} - abbreviation of stitch	knit
		${displayString} - display string of stitch. If not defined, then name of stitch	k - knit
		${longDescription} - long description of stitch
Yarn alias	Yarn key alias format	${alias} - alias of yarn if defined	(MC)
			MC :
Yarn entry	Yarn key entry	${name} - name of yarn	Green (MC)
		${yarnAlias} - output from yarn alias template	MC : green

Table 2. Stitch Glossary

Name	Description	Variables	Examples
Glossary title	Glossary title	none	Stitch Glossary
Stitch entry	Stitch entry in glossary	${abbreviation} - abbreviation of stitch	ssk: Slip, slip, knit.
		${displayString} - display string of stitch. If not defined, then name of stitch
		${longDescription} - long description of stitch
		${keyEntryText} - text of the key entry in the key

Table 3. Row Labels (text output)

Name	Description	Variables	Examples
Row label	Label for a single row	${ID} - row identifier	Row 1:
			Reihe 1:
Row label RS	Label for a single row with RS label	${ID} - row identifer	Row 1 (RS):
			Row 1 (Right Side):
Row label WS	Label for a single row with WS label	${ID} - row identifier	Row 1 (WS):
			Row 1 (Wrong Side):
Round label	Label for a single round	${ID} - round identifier	Round 2:
			2. Runde:
Row all RS label	Label for a row plus all RS rows	${ID} - the identifier of the first row	Row 1 and all RS rows:
			Row 1 and all right side rows:
Row all WS label	Label for a row plus all WS rows	${ID} - the identifier of the first row	Row 2 and all WS rows:
			Row 2 and all wrong side rows:
Round all even label	Label for a round plus all even rounds	${ID} - the identifier of the first round	Round 2 and all even-numbered rounds:
			Round 2 and all even rounds:
Round all odd label	Label for a round plus all odd rounds	${ID} - the identifier of the first round	Round 1 and all odd-numbered rounds:
			Round 2 and all odd rounds:
Edited row label	Edited label for a single row or round	${ID} - the identifier of the row or round	Setup row
Row range label	Label for a range of rows	${firstID} - the identifier of the first row in the range	Rows 1-4:
		${lastID} - the identifier of the last row in the range	Reihen 1 - 4:
Round range label	Label for a range of rounds	${firstID} - the identifier of the first round in the range	Rounds 1-4:
		${lastID} - the identifier of the last round in the range	Runden 1 - 4:

Table 4. Row Labels for 2 pass charts (text output)

Name	Description	Variables	Examples
Row label (two pass)	Label for a single row in a two pass chart	${ID} - row identifier	Row 1 LS LC:
		${pass} - pass identifier	Row 1 (LS, LC):
		${side} - workside identifier	Row 1 LC (LS):
Round label (two pass)	Label for a single round in a two pass chart	${ID} - round identifier	Round 2 LC:
		${pass} - pass identifier	Round 2 with LC:
Special instruction for pass 1 label in a flat	Special instruction to be added to the written output for a pass 1 row in a two pass chart to be knit flat	none	Do not turn work! Slide
Special instruction for pass 2 label in a flat	Special instruction to be added to the written output for a pass 2 row in a two pass chart to be knit flat	none	Turn
Row repeat	Repeat of a single row in a two pass chart	${repeatRowID} - identifier of the row to be repeated	repeat row 1 LS DC
		${repeatRowPass} - pass of the row to be repeated
		${repeatRowSide} - side of the row to be repeated
Round repeat	Repeat of a single row in a two pass chart	${repeatRowID} - identifier of the round to be repeated	repeat round 1 LS DC
		${repeatRowPass} - pass of the round to be repeated
Rows repeat	Repeat of a range of rows in a two pass chart	${firstRepeatRowsID} - identifier of the first row to be repeated	repeat rows 1 LS DC - 5 LS DC
		${firstRepeatRowsPass} - pass of the first row to be repeated
		${firstRepeatRowsSide} - side of the first row to be repeated
		${lastRepeatRowsID} - identifier of the last row to be repeated
		${lastRepeatRowsPass} - pass of the last row to be repeated
		${lastRepeatRowsSide} - side of the last row to be repeated
Rounds repeat	Repeat of a range of rounds in a two pass chart	${firstRepeatRowsID} - identifier of the first round to be repeated	repeat rounds 1 DC - 5 DC
		${firstRepeatRowsPass} - pass of the first round to be repeated
		${lastRepeatRowsID} - identifier of the last round to be repeated
		${lastRepeatRowsPass} - pass of the last round to be repeated
Row range label	Label for a range of rows in a two pass chart	${firstID} - identifier of the first row	Rows 1 LS DC - 5 LS DC:
		${firstPass} - pass of the first row
		${firstSide} - side of the first row
		${lastID} - identifier of the last row
		${lastPass} - pass of the last row
		${lastSide} - side of the last row
Round range label	Label for a range of rounds in a two pass chart	${firstID} - identifier of the first round	repeat rounds 1 DC - 5 DC
		${firstPass} - pass of the first round
		${lastID} - identifier of the last round
		${lastPass} - pass of the last round

Table 5. Repeats

Name	Description	Variables	Examples
Asterisk repeat	Asterisk repeat	${repeatContents} - the text for the stitches inside the repeat	*k2, p2; work from *
			*2 re, 2 li; ab * arbeiten
Round bracket repeat	Round bracket repeat	${repeatContents} - the text for the stitches inside the repeat	(k1, p1)
			{k1, p1}
Implicit repeat	Implicit repeat	${repeatContents} - the text for the stitches inside the repeat	(k1, p1)
			[k1, p1]
Implicit qualifier	Implicit qualifier	${mathsFormatOutput} - output from the Maths Format qualifier	x 5
		${timesFormatOutput} - output from the Times Format qualifier	five times
Row repeat	Row repeat	${repeatRowID} - the identifier for the row to be repeated	repeat row 4
			Reihe 4 wdh.
Round repeat	Round repeat	${repeatRowID} - the identifier for the round to be repeated	repeat round 4
			Runde 4 wdh.
Rows repeat	Rows repeat	${firstRepeatRowsID} - the identifier for the first row to be repeated	repeat rows 4 - 7
		${lastRepeatRowsID} - the identifier for the last row to be repeated	Reihen 4 - 7 wdh.
Rounds repeat	Rounds repeat	${firstRepeatRowsID} - the identifier for the first round to be repeated	repeat rounds 4 - 7
		${lastRepeatRowsID} - the identifier for the last round to be repeated	Runden 4 - 7 wdh.
Times 1 qualifier	Times 1 qualifier	none	once
Times 2 qualifier	Times 2 qualifier	none	twice
Times qualifier	Times qualifier	${repeatCount} - total times that a repeat is worked displayed as digits	5 mal
		${repeatCountWords} - total times that a repeat is worked displayed as words	five times
Maths format times qualifier	Maths format times qualifier	${repeatCount} - total times that a repeat is worked displayed as digits	x 5
		${repeatCountWords} - total times that a repeat is worked displayed as words	x five

Table 6. Row Contents

Name	Description	Variables	Examples
Stitch template regular single	Stitch regular format for single stitch - for all stitches except knit and purl	${stitchDisplayString} - display string if defined, else abbreviation if defined, else stitch name	knit into fb
		${stitchAbbreviation} - abbreviation if defined, else stitch name	kfb
		${stitchName} - stitch name
Stitch template condensed single	Stitch condensed format for single stitch - for knit and purl	${stitchDisplayString} - display string if defined, else abbreviation if defined, else stitch name	k1
		${stitchAbbreviation} - abbreviation if defined, else stitch name	k
		${stitchName} - stitch name
Stitch template regular	Stitch regular format for multiple stitches - for all stitches except knit and purl	${stitchDisplayString} - display string if defined, else abbreviation if defined, else stitch name	knit into fb
		${stitchAbbreviation} - abbreviation if defined, else stitch name	kfb
		${stitchName} - stitch name	1/1 RC x five
		${numberLabel} - number of the stitch displayed as digits	(1/1 RC) x 5
		${numberWordLabel} - number of the stitch displayed as words
Stitch template condensed	Stitch condensed format for multiple stitches - for knit and purl	${stitchDisplayString} - display string if defined, else abbreviation if defined, else stitch name	k5
		${stitchAbbreviation} - abbreviation if defined, else stitch name	k 5
		${stitchName} - stitch name	knit 5
		${numberLabel} - number of the stitch displayed as digits	5 rechts
		${numberWordLabel} - number of the stitch displayed as words
Stitch with number and yarn label	Stitch with number and yarn - used when colour included in written instructions	${stitchTemplateOutput} - output from one of the stitch templates	k5 in MC
		${yarnLabel} - yarn/colour identifier; alias if defined, else name	2 links rot
Stitch with number label	Stitch with number only (no yarn)	${stitchTemplateOutput} - output from one of the stitch templates	k5
			2 links
Number of stitches in a yarn label	Number of stitches in a yarn (no stitch)	${yarnLabel} - yarn/colour identifier; alias if defined, else name	5 MC, 2 CC
		${numberLabel} - number of the stitch displayed as digits	five green, 2 red
		${numberWordLabel} - number of the stitch displayed as words	A2, B3, A2
Work all stitches	Work all stitches in a row - used when all the stitches in a row are the same	${stitchDisplayString} - display string if defined, else abbreviation if defined, else stitch name	knit
		${stitchAbbreviation} - abbreviation if defined, else stitch name	k to end
		${stitchName} - stitch name	knit to end
Work stitch row prefix	Work stitch row prefix - used when all stitches are the same but in different colours	${stitchDisplayString} - display string if defined, else abbreviation if defined, else stitch name	work knit as follows;
		${stitchAbbreviation} - abbreviation if defined, else stitch name	k all stitches as follows,
		${stitchName} - stitch name
Using yarn row prefix	Using yarn row prefix - used when stitches are different but in the same colour	${yarnLabel} - yarn/colour identifier; alias if defined, else name	using MC,
			with green,

Table 7. Stitch Count

Name	Description	Variables	Examples
Stitch count	Total number of stitches	${stitchCount} - total number of stitches in the row/round	(16 sts)
			(16 Maschen)
Stitch count singular	Stitch count when there is only 1 stitch	none	(1 st)
			(1 Masche)

Table 8. Row Format

Name	Description	Variables	Examples
Row/round format	Format of complete row/round	${rowLabelTemplateOutput} - output generated by row/round label template	Row 1: k2, p2. (4 sts)
		${rowContentsTemplateOutput} - output generated for row/round contents	Row 1: k2, p2 (4 sts)
		${stitchCountTemplateOutput} - output generated for stitch count

Table 9. Row Labels (2 pass charts)

Name	Description	Variables	Examples
2 pass round label	Label for round on a 2 pass chart	${ID} - round identifier in 2 pass chart	2 LC
		${pass} - pass identifier in 2 pass chart	2 (LC)
2 pass row label	Label for row on a 2 pass chart	${ID} - row identifier in 2 pass chart	1 LS LC
		${pass} - pass identifier in 2 pass chart	1 (LS, LC)
		${side} - workside identifier in 2 pass chart