Naposledy změněno 30. 4. 2007 Edituj Historie Poslední změny (v jiných jazycích: EN)

XML-RPC method texy1.toHtml

Converts text in Texy syntax to XHTML. Returns base64 string.

PARAMETER REQUIRED TYPE CONTAINS
text required base64 Input text. Text can be compressed using gzdeflate(), see config ‘compress’.
configuration optional struct This is explained below.

Configuration parameter details

All sub-parameters are optional.

PARAMETER TYPE MEANING
compress boolean TRUE when input and output text is compressed
utf boolean TRUE when input is encoded in UTF-8 (default)
safeMode boolean $texy->safeMode()
singleLine boolean use $texy->process(..., TRUE)
allowedClasses boolean or array $texy->allowedClasses
allowedStyles boolean or array $texy->allowedStyles
allowedTags boolean or struct $texy->allowedTags
obfuscateEmail boolean $texy->obfuscateEmail
mergeLines boolean $texy->mergeLines
blockModule.a­llowed.pre boolean $texy->blockModule->allowed->pre
blockModule.a­llowed.text boolean $texy->blockModule->allowed->text
blockModule.a­llowed.html boolean $texy->blockModule->allowed->html
formatterModu­le.lineWrap int $texy->formatterModule->lineWrap
formatterModu­le.indent boolean $texy->formatterModule->indent
headingModule­.allowed.surrou­nded boolean $texy->headingModule->allowed->surrounded
headingModule­.allowed.under­lined boolean $texy->headingModule->allowed->underlined
headingModule.top int $texy->headingModule->top
headingModule­.balancing int $texy->headingModule->balancing
imageModule.root string $texy->imageModule->root
imageModule.lin­kedRoot string $texy->imageModule->linkedRoot
imageModule.lef­tClass string $texy->imageModule->leftClass
imageModule.rig­htClass string $texy->imageModule->rightClass
imageModule.de­faultAlt string $texy->imageModule->defaultAlt
imageDescModu­le.boxClass string $texy->imageDescModule->boxClass
imageDescModu­le.leftClass string $texy->imageDescModule->leftClass
imageDescModu­le.rightClass string $texy->imageDescModule->rightClass
linkModule.allo­wed.link boolean $texy->linkModule->allowed->link
linkModule.allo­wed.email boolean $texy->linkModule->allowed->email
linkModule.allo­wed.url boolean $texy->linkModule->allowed->url
linkModule.allo­wed.quickLink boolean $texy->linkModule->allowed->quickLink
linkModule.allo­wed.references boolean $texy->linkModule->allowed->references
linkModule.root string $texy->linkModule->root
linkModule.ema­ilOnClick string $texy->linkModule->emailOnClick
linkModule.ima­geOnClick string $texy->linkModule->imageOnClick
linkModule.po­pupOnClick string $texy->linkModule->popupOnClick
linkModule.for­ceNoFollow boolean $texy->linkModule->forceNoFollow
smiliesModule­.allowed boolean $texy->smiliesModule->allowed
smiliesModule.root string $texy->smiliesModule->root
smiliesModule.class string $texy->smiliesModule->class
quoteModule.a­llowed.line boolean $texy->quoteModule->allowed->line
quoteModule.a­llowed.block boolean $texy->quoteModule->allowed->block

Fault reporting

Errors returned by the server:

Error code & message Description
1 Unknown method Returned if the server was asked to dispatch a method it didn't know about
2 Invalid return payload This error is actually generated by the client, not server, code, but signifies that a server returned something that couldn't understand.
3 Incorrect parameters This error is generated when the server has signature(s) defined for a method, and the parameters passed by the client do not match any of signatures.
4 Can't introspect: method unknown This error is generated by the builtin system.*() methods when any kind of introspection is attempted on a method undefined by the server.
5 Didn't receive 200 OK from remote server This error is generated by the client when a remote server doesn't return HTTP/1.1 200 OK in response to a request. A more detailed error report is appended to the phrase above.
100– XML parse errors Returns 100 plus the XML parser error code for the fault that occurred. The faultString returned explains where the parse error was in the incoming XML stream.
10 Type mismatch Parameter have not expected type
11 Can't decompress input text Can't decompress text using gzinflate() method.

Example

The following example converts short text Hello **world** to XHTML:

<?xml version="1.0" encoding="UTF-8"?>
<methodCall>
  <methodName>texy1.toHtml</methodName>
  <params>
    <param>
      <value><base64>U3BlY2nDoWxuw6</base64></value>
    </param>
    <param>
      <value>
        <struct>
          <member>
            <name>safeMode</name>
            <value><boolean>1</boolean></value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodCall>