Author: wikier
Date: Tue May 17 04:56:20 2016
New Revision: 1744181
URL: http://svn.apache.org/viewvc?rev=1744181&view=rev
Log:
added some content to ldpath functions
Added:
marmotta/site/trunk/content/markdown/ldpath/functions.md
Removed:
marmotta/site/trunk/content/markdown/ldpath/functions.md.vm
Added: marmotta/site/trunk/content/markdown/ldpath/functions.md
URL:
http://svn.apache.org/viewvc/marmotta/site/trunk/content/markdown/ldpath/functions.md?rev=1744181&view=auto
==============================================================================
--- marmotta/site/trunk/content/markdown/ldpath/functions.md (added)
+++ marmotta/site/trunk/content/markdown/ldpath/functions.md Tue May 17
04:56:20 2016
@@ -0,0 +1,48 @@
+<head><title>LDPath - Functions</title></head> <!-- awaiting for
https://jira.codehaus.org/browse/DOXIA-472 -->
+
+# LDPath Functions
+
+The different Marmotta components can register custom LDPath functions to
extend the LDPath functionality.
+
+Currently, the following LDPath all available functions (the ones actually
registered can be checked
+at `http://host/to/marmotta/ldpath/admin/functions.html`):
+
+<table>
+ <tbody>
+ <tr>
+ <th>Name</th><th>Signature</th><th>Description</th>
+ </tr>
+
+ <tr><td>cleanHtml</td><td>fn:cleanHtml(content: LiteralList) :
LiteralList</td><td>Function to clean up HTML and remove all script and style
elements from the content. Can be used in-path, using the current context nodes
as argument.</td></tr>
+ <tr><td>concat</td><td>fn:concat(nodes : NodeList) : String</td><td>A node
function concatenating a list of nodes interpreted as strings.</td></tr>
+ <tr><td>content</td><td>fn:content(nodes : URIResourceList) :
LiteralList</td><td>Resolve the URIs passed as argument and retrieve their
content using the content reader applicable for the resource.</td></tr>
+ <tr><td>count</td><td>fn:count(nodes : URIResourceList, ...) :
IntegerLiteralList</td><td>Counts the number of resources in the
arguments</td></tr>
+ <tr><td>css</td><td>fn:css(jsoup: String [, nodes: XMLLiteralList]) :
LiteralList</td><td>Evaluate an JSoup CSS selector on either the value of the
context node or the values of the nodes passed as arguments.</td></tr>
+ <tr><td>earliest</td><td>fn:earliest(DateLiteralList):
DateLiteral</td><td>select the earliest date (min)</td></tr>
+ <tr><td>first</td><td>fn:first(nodes : NodeList) : Node</td><td>Selects
the first node in the argument list.</td></tr>
+ <tr><td>htmlText</td><td>fn:htmlText(content: LiteralList) :
LiteralList</td><td>strips all html tags and resolves html-entities like
&</td></tr>
+ <tr><td>jsoup</td><td>fn:jsoup(jsoup: String [, nodes: XMLLiteralList]) :
LiteralList</td><td>Evaluate an JSoup CSS selector on either the value of the
context node or the values of the nodes passed as arguments.</td></tr>
+ <tr><td>last</td><td>fn:last(nodes : NodeList) : Node</td><td>Returns the
last element in the node list.</td></tr>
+ <tr><td>latest</td><td>fn:latest(DateLiteralList):
DateLiteral</td><td>select the latest date (max)</td></tr>
+ <tr><td>max</td><td>fn:max(LiteralList l [, ...]) ::
NumberLiteral(s)</td><td>select the max of each argument</td></tr>
+ <tr><td>min</td><td>fn:min(LiteralList l [, ...]) ::
NumberLiteral(s)</td><td>select the min of each argument</td></tr>
+ <tr><td>removeTags</td><td>fn:removeTags(content: LiteralList) :
LiteralList</td><td>Function to remove all XML or HTML tags from the content.
Can be used in-path, using the current context nodes as argument.</td></tr>
+ <tr><td>replace</td><td>fn:replace(nodes: NodeList, regex: String,
replace: String) :: NodeList</td><td>applies a String.replaceAll on the nodes
(URI or LiteralContent resp.).</td></tr>
+ <tr><td>round</td><td>fn:round(LiteralList l) ::
IntegerLiteralList</td><td>Round each argument to the closest int/long
value</td></tr>
+ <tr><td>sort</td><td>fn:sort(nodes : NodeList [,
("string"|"number"|"date") [, ("asc"|"desc") ] ]) : NodeList </td><td>Sort the
node list passed as first argument. The second argument can be used to
determine the sort method, the third argument to determine the sort
direction.</td></tr>
+ <tr><td>strJoin</td><td>fn:strJoin(nodes: NodeList, separator: String [,
prefix: String [, suffix: String ]]) :: LiteralList</td><td>join the string
representation of all provided nodes.</td></tr>
+ <tr><td>strLeft</td><td>fn:strLeft(node::Node, length::NumericLiteral) ::
StringLiteral</td><td>take the first n chars from the string
representation</td></tr>
+ <tr><td>strlen</td><td>fn:strlen(text: Literal) :
IntegerLiteralList</td><td>returns the length of the given
StringLiterals</td></tr>
+ <tr><td>strRight</td><td>fn:strRight(node::Node, length::NumericLiteral)
:: StringLiteral</td><td>take the last n chars from the string
representation</td></tr>
+ <tr><td>substr</td><td>fn:substr(node::Node, start::NumericLiteral [,
end::NumericLiteral]) :: StringLiteral</td><td>Extract a substring for the
string representation of a node</td></tr>
+ <tr><td>wc</td><td>fn:wc(text : LiteralList) :
IntegerLiteralList</td><td>Calculates the length of the provided literals
(counting continuous chunks of letters+digits)</td></tr>
+ <tr><td>xmlText</td><td>fn:xmlText(content: LiteralList) :
LiteralList</td><td>function to remove all XML-Tags and -Entities (&...;
stuff) from the content.</td></tr>
+ <tr><td>xmlUnescape</td><td>fn:xmlUnescape(content: LiteralList) :
LiteralList</td><td>function to resolve all xml-entities in the
content</td></tr>
+ <tr><td>xpath</td><td>fn:xpath(xpath: String [, nodes: XMLLiteralList]) :
LiteralList</td><td>Evaluate an XPath expression on either the value of the
context node or the values of the nodes passed as
arguments.</td></tr></tbody></table>
+
+Legend:
+
+* Name: name of the function as registered by the different modules
+* Signature: how this LDPath function can be called
+* Description: a free text description of the LDPath function
+
