Arbortext Command Language > Functions by Alphabetical Listing > stylesheet_get_list_doc
  
stylesheet_get_list_doc
stylesheet_get_list_doc(labels[], paths[], is_styler[], use[, doc[, maxlabelchars[, labeltitleonly]]])
This function returns information on valid stylesheets for doc in the labels, paths, and is_styler arrays.
The labels for valid doc stylesheets fill the labels[] array. Arbortext Editor generates labels by combining the stylesheet title (if any) and path into a string and truncating it if necessary so that it is no longer than maxlabelchars. A stylesheet title is specified in the Stylesheet ID processing instruction in the stylesheet file (<?APT StylesheetID ... Title="title" ...>). These labels are what Arbortext Editor displays in the user interface.
The absolute path of each valid stylesheet fills the paths[] array.
Values of 0 and 1 fill the is_styler[] array. A 1 means you can use the stylesheet with Arbortext Styler, a 0 means that you cannot use the stylesheet with Arbortext Styler.
Valid stylesheets are .style, .xsl, and .fos files whose publishing type matches use. A stylesheet's type is derived from the CompositionTypes attribute on the StylesheetID processing instruction.
Valid use types are any, htmlfile, htmlhelp, print, pdf, web, wordxml, and xsl. If use is any, all .style, .xsl, and .fos files are returned.
The following table describes the default stylesheet publishing types if a stylesheet file does not have a StylesheetID processing instruction:
Stylesheet type
Default publishing types
Valid screen stylesheet
Can edit using Arbortext Styler
FOSI (.fos file)
print, pdf, htmlfile
Yes
No
XSL (.xsl)
print, pdf, htmlfile, xsl
Yes
Yes
XSL-FO
print, pdf, xsl
No
No
Other XSL
xsl
No
No
Arbortext Styler (.style)
print, pdf, htmlfile, htmlhelp, web
Yes
Yes
If doc is omitted or 0, the current document is used.
maxlabelchars controls the maximum number of characters included in the returned labels. If maxlabelchars is omitted, the label length defaults to 50.
If labeltitleonly is 1, then the label is the stylesheet title, if it exists. If the stylesheet title doesn't exist, the label is the path to the stylesheet.
Related Topics
Stylesheet overview
Select Stylesheets dialog box
stylesheet_get_list_dir function
stylesheet_list_add function
Stylesheet ID processing instruction
Associating a stylesheet with your document
Stylesheet association processing instruction
Using Arbortext Publishing Engine for publishing documents