| XQUERY/XSLT API DOCUMENTATION 4.2 |
All XQuery & XSLT Functions MarkLogic Built-In Functions Admin (xdmp:) AppServer (xdmp:) Classifier (cts:) Debug (dbg:) Document Conversion (xdmp:) Extension (xdmp:) Documents, Directories, Properties, and Locks Functions Extension Functions Function Values Functions HTTP Functions JSON Functions MarkLogic Server Functions Search Functions XML Functions XQuery Context Functions XSLT Functions map (map:) Math (math:) Profile (prof:) Search (cts:) cts:query Constructors Functions Geospatial Functions Geospatial Lexicon Functions Lexicon Functions Search Functions Search Clustering Functions Security (xdmp:) Server Monitoring (xdmp:) Spell (spell:) Update (xdmp:) XQuery Library Modules Admin Library (admin:) Actions Functions Appserver Functions Database Functions Forest Functions Group Functions Host Functions Mimetypes Functions Scheduler Functions Alerting (alert:) Elastic Compute Cloud (ec2:) Entity Enrichment (entity:) Flexible Replication (flexrep:) Geospatial Supporting Functions GEO Functions GeoRSS Functions GML Functions KML Functions MCGM Functions Information Studio (info:) Information Studio Developer (infodev:) Library Services (dls:) cts:query Constructor Functions Document Management Functions Document Update Functions Retention Policy Functions XInclude Functions Modular Documents XInclude Functions XPointer Functions PKI (pki:) Plugin (plugin:) Search (search:) Security-sec (sec:) Spelling Dictionary Management (spell:) Thesaurus (thsr:) Triggers (trgr:) Triggers Library (trgr:) WordProcessingML (ooxml:) ZIP Package (ooxml:) CPF Functions Content Processing Framework (cpf:) CSS Conversion (css:) DocBook Conversion (dbk:) Domains (dom:) Excel Conversion (excel:) Generic Conversion (cvt:) Links (lnk:) MSWord Conversion (msword:) PDF Conversion (pdf:) Pipelines (p:) Powerpoint Conversion (ppt:) XHTML Conversion (xhtml:) W3C-Standard Functions Accessor (fn:) AnyURI (fn:) Boolean (fn:) Context (fn:) DurationDateTime (fn:) Error and Trace (fn:) Node (fn:) Numeric (fn:) QName (fn:) Sequence (fn:) String (fn:) XSLT (fn:) W3C XQuery/XSLT Reference W3C XQuery Functions W3C XQuery Language W3C XSLT Language
This page was generated September 12, 2012 6:02 AM | XQuery & XSLT Built-In & Modules Function Reference
XQuery & XSLT Built-In & Module Functions
The following table lists the APIs that correspond to the CPF Functions. Click on a function name to go directly to the detailed function description, or use the tree on the left to navigate to the functions by group.
Function Summary
cpf:check-transition | Verify that the current transition is the correct one for the document.
cpf:document-get-error | Fetch a trace of the error that caused the document's processing to fail, if any.
cpf:document-get-last-updated | Determine the date and time of the last update to the document's content, if any.
cpf:document-get-processing-status | Determine the document's current processing status, if any.
cpf:document-get-state | Determine the document's current state, if any.
cpf:document-set-error | Set the document's error trace to the given value.
cpf:document-set-last-updated | Set the date and time of the document's last update.
cpf:document-set-processing-status | Set the document's processing status to the given value.
cpf:document-set-state | Set the document's state to the given state.
cpf:failure | Concludes the state action in failure, advancing the state as defined by the state transition.
cpf:success | Concludes the action successfully, advancing the state as defined by the transition.
css:convert | Convert CSS text to an equivalent XML representation that is more suitable for analysis.
css:get | Fetch the CSS for the given document, be it embedded or linked.
cvt:basename | Return the filename part of the URI, cutting off any query strings or fragments.
cvt:basepath | Return the base path of the URI, cutting off the filename.
cvt:destination-uri | Construct the destination URI from the source URI using the following rules: The path prefix of the destination URI is the same as the source URI's.
cvt:part-uri | Construct the URI for the part using the following rules: The path prefix of the part URI is the same source URI's, followed by a subdirectory name.
cvt:save-converted-documents | Save a set of converted documents, with appropriate links.
dbk:convert | Convert XHTML to DocBook lite vocabulary, if possible.
dom:add-permissions | Add permissions to the domain.
dom:add-pipeline | Add another pipeline to the set of pipelines bound to the domain.
dom:collection | Return the name of the collection in which domains are stored.
dom:configuration-create | Create a new CPF configuration.
dom:configuration-get | Returns the CPF configuration.
dom:configuration-set-default-domain | Set a new default domain for the CPF configuration.
dom:configuration-set-evaluation-context | Set a new context for the CPF configuration.
dom:configuration-set-permissions | Set new permissions for the CPF configuration.
dom:configuration-set-restart-user | Set a new restart user for the CPF configuration.
dom:create | Create a new content processing domain, along with the triggers that perform work in that domain.
dom:domain-scope | Create a domain scope element.
dom:domains | Return all the domains.
dom:evaluation-context | Create an evaluation context element.
dom:get | Find a particular domain.
dom:remove | Remove the domain and any associated triggers.
dom:remove-permissions | Remove permissions to the domain.
dom:remove-pipeline | Remove the association between a pipeline and the domain.
dom:set-description | Set the description of the domain.
dom:set-domain-scope | Set the scope of the domain.
dom:set-evaluation-context | Set the evaluation context of the domain.
dom:set-name | Set the name of the domain to something else.
dom:set-permissions | Set the permissions of the domain.
dom:set-pipelines | Bind a new set of pipelines to the domain.
excel:clean | Clean up any conversion artifacts or other infelicities, putting each sheet into its own div element.
lnk:create | Create a link between the two given documents with the given role labels and strength.
lnk:from | Find and return all the links from the given document to some other.
lnk:get | Find and return the link between the two documents, if any.
lnk:insert | Insert the given link.
lnk:remove | Remove the link between the two given documents and return the removed link.
lnk:to | Find and return all the links to the given document from some other.
msword:clean | Clean up any conversion artifacts or other infelicities.
p:action | Construct an action element.
p:collection | Return the name of the collection in which pipelines are stored.
p:condition | Construct a condition element.
p:create | Create a new content processing pipeline.
p:execute | Construct a execute element.
p:get | Find a particular pipeline.
p:get-by-id | Find a particular pipeline.
p:insert | Insert a fully constructed content processing pipeline, returning its unique ID.
p:pipelines | Return all the pipelines.
p:remove | Remove the named pipeline.
p:state-transition | Construct a new state transition element.
p:status-transition | Construct a new status transition element.
pdf:clean | Clean up any conversion artifacts or other infelicities.
pdf:get-toc | Fetch the linked TOC, if any.
pdf:insert-toc-headers | Locate TOC anchors and make them properly refer to headers at the appropriate level.
pdf:make-toc | Clean and normalize the TOC produced by raw conversion.
ppt:clean | Clean up any conversion artifacts or other infelicities, putting each slide into its own div element.
xhtml:add-lists | Infer numbered or bulleted lists and insert appropriate markup.
xhtml:clean | Clean up the XHTML: pruning empty spans, consolidating adjacent spans, etc.
xhtml:restructure | Turn an XHTML with flat structure into one with div structure based on the header elements.

© Copyright 2002-2012 MarkLogic Corporation. All rights reserved.