OKB-128: What is CFS2XML?

Cfs2xml.exe is a utility designed for advanced users that outputs Onfolio collection data as XML, optionally transformed using one or more XSLT stylesheets. It is located in your Onfolio installation directory (if you have installed using Onfolio 2.0 or later). It requires Onfolio 2.0 Professional or later to run. It must be run from the command line.

Command line syntax:

cfs2xml [options] <input-cfs-file> <output-file>

Options:

-xsl <xsl-file>

Apply this XSL transformation on the output (Use this option repeatedly to chain XSLTs)

-rss

Generate an RSS feed for the items output from the collection using the specified url as the channel link. The rss feed will be output in the root directory using the filename "rss.xml". When specifying this option the -publishdirurl (-pdurl) option must also be specified.

-rsslink

Optional parameter that specifies an explicit url for the RSS feed homepage. If not specified then the RSS feed homepage will be the -pdurl (see below) combined with the publishing output file.

-rssmaxitems <items>

Maxiumum number of items to include in rss feed.

-rssmaxage <days>

Maximum age (in days) of items to include in the rss feed.

-pdurl, -publishdirurl <url>

Specify the URL for the directory where items are published to. Required if the -rss option is specified.

-nf, -nofiles

Do not marshal out supporting files, such as captured files and/or pages.

-wlp, -weblinkspref

If a web item which has supporting files also has a link to a source url then publish the link and do not publish the supporting files.

-flp, -filelinkspref

If a file item which has supporting files also has a link to a source url then publish the link and do not publish the file contents.

-noemptyf

Remove empty folders (folders with no items) from the published output.

-sd, -supportdir <dirname>

Specify a directory into which to put supporting files, such as captured files and/or pages. By default, the name of the output file (minus ext.) plus "_files" will be used.

-root <rootid>

Specify the ID of the item or folder you want to output (by default, the collection root is used). You can find out the ID of an item or folder by looking in the raw XML generated by cfs2xml.

-f, -force

Force execution of the requested command-line (automatically says yes to any prompts such as prompting whether to overwrite existing files)

-q, -quiet

Suppress most output.

-v, -verbose

Print more output.