xTxT Documentation

Lists (/ol /ul /dir)

As a documentation tool, one of xTxT's primary goals is to make the management of lists simple and efficient. To that end, lists are represented visually, using tabbed indentation.

Unordered List

/ul
Item 1
Item 2
	Item 2a
		Item 2a.1
	Item 2b
Item 3
	Item 3a

renders as;

  • Item 1
  • Item 2
    • Item 2a
      • Item 2a.1
    • Item 2b
  • Item 3
    • Item 3a

Ordered List

/ol
Item 1
Item 2
	Item 2a
		Item 2a.1
	Item 2b
Item 3
	Item 3a

renders as;

  1. Item 1
  2. Item 2
    1. Item 2a
      1. Item 2a.1
    2. Item 2b
  3. Item 3
    1. Item 3a

Styling Lists

Lists can also be styled using the xTxT text-styling conventions

//ol
Item 1
Item 2
	Item \\2a\\
		Item \\2a.1\\
	\Item 2b\
Item 3
	\\\\\Item 3a\\\\\

renders as;

  1. Item 1
  2. Item 2
    1. Item 2a
      1. Item 2a.1
    2. Item 2b
  3. Item 3
    1. Item 3a

Dir

This tag is currently disabled

A list can also be created from a directory using the command;

//dir <path>[|<depth>[|<filter>[|<link-target>]]]

Params;

  • Path. REQUIRED. Identifies the location of the directory.
    • Paths may be relative to the .xtxt file location.
  • Depth. Indicates how deep the tree should go.
    • 0 means unlimited depth.
    • 1 means one level deep (just the specified dir, no subdirs)
    • n means n levels deep
  • Filter. Identifies a wildcard pattern that you wish to constrain the list to
    • e.g. *.xtxt
  • Link Target. Allows you to specify the window that the linked document opens in if the user clicks it
    • Default target is _blank (opens a new browser window).
    • Links only appear if the path is relative
//dir sampledir
//dir sampledir|*.xtxt
//dir sampledir|*.xtxt|frozone