php-doc-en/reference/cmark/book.xml
Joe Watkins 92cce8d39b CQL docs
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@344730 c90b9560-bf6c-de11-be94-00142212c4b1
2018-04-19 08:03:41 +00:00

97 lines
4.2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<book xml:id="book.cmark" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>CommonMark</title>
<titleabbrev>CommonMark</titleabbrev>
<preface xml:id="intro.cmark">
&reftitle.intro;
<para>
This extension provides access to the reference implementation of CommonMark, a rationalized version of Markdown syntax with a specification.
</para>
<formalpara>
<title>Parsing:</title>
<para>
The CommonMark extension provides a simple parsing API:
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('function.commonmark-parse')/db:refsect1[@role='description']/descendant::db:methodsynopsis)" />
</para>
</formalpara>
<formalpara>
<title>Rendering:</title>
<para>
The CommonMark extension provides simple rendering API that supports multiple formats:
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('function.commonmark-render')/db:refsect1[@role='description']/descendant::db:methodsynopsis)" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('function.commonmark-render-html')/db:refsect1[@role='description']/descendant::db:methodsynopsis)" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('function.commonmark-render-xml')/db:refsect1[@role='description']/descendant::db:methodsynopsis)" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('function.commonmark-render-man')/db:refsect1[@role='description']/descendant::db:methodsynopsis)" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('function.commonmark-render-latex')/db:refsect1[@role='description']/descendant::db:methodsynopsis)" />
</para>
</formalpara>
<formalpara>
<title>AST:</title>
<para>
The CommonMark extension implements visitation for CommonMark\Node objects:
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('commonmark-node.accept')/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
</para>
</formalpara>
<formalpara>
<title>CQL:</title>
<para>
The CommonMark extension provides an interface to CQL, CommonMark Query Language:
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('commonmark-cql.construct')/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])" />
</para>
</formalpara>
</preface>
&reference.cmark.setup;
&reference.cmark.commonmark.node.document;
&reference.cmark.commonmark.node.heading;
&reference.cmark.commonmark.node.paragraph;
&reference.cmark.commonmark.node.blockquote;
&reference.cmark.commonmark.node.bulletlist;
&reference.cmark.commonmark.node.orderedlist;
&reference.cmark.commonmark.node.item;
&reference.cmark.commonmark.node.text;
&reference.cmark.commonmark.node.text.strong;
&reference.cmark.commonmark.node.text.emphasis;
&reference.cmark.commonmark.node.thematicbreak;
&reference.cmark.commonmark.node.softbreak;
&reference.cmark.commonmark.node.linebreak;
&reference.cmark.commonmark.node.code;
&reference.cmark.commonmark.node.codeblock;
&reference.cmark.commonmark.node.htmlblock;
&reference.cmark.commonmark.node.htmlinline;
&reference.cmark.commonmark.node.image;
&reference.cmark.commonmark.node.link;
&reference.cmark.commonmark.node.customblock;
&reference.cmark.commonmark.node.custominline;
&reference.cmark.commonmark.node;
&reference.cmark.commonmark.interfaces.ivisitor;
&reference.cmark.commonmark.interfaces.ivisitable;
&reference.cmark.commonmark.parser;
&reference.cmark.commonmark.cql;
&reference.cmark.reference;
</book>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->