php/archived-doc-en
1
0
Fork 0
mirror of https://github.com/php/doc-en.git synced 2026-03-23 23:32:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

cmark: fix XML by converting para to simpara tags via script (#5153)

Browse Source
This commit is contained in:
Gina Peter Banyard
2026-01-18 23:09:34 +00:00
committed by GitHub
parent 6dcc757d98
commit 876a6a3931
36 changed files with 312 additions and 385 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
reference/cmark/book.xml
View File

@@ -1,46 +1,45 @@
<?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:xi="http://www.w3.org/2001/XInclude">
<book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="book.cmark">
<?phpdoc extension-membership="pecl" ?>
<title>CommonMark</title>
<titleabbrev>CommonMark</titleabbrev>
<preface xml:id="intro.cmark">
&reftitle.intro;
<para>
<simpara>
This extension provides access to the reference implementation of CommonMark, a rationalized version of Markdown syntax with a specification.
</para>
</simpara>
<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)" />
<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)" />
<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')])" />
<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')])" />
<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>
@@ -76,7 +75,6 @@
&reference.cmark.reference;
</book>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

18
reference/cmark/commonmark.cql.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.commonmark-cql" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.commonmark-cql" role="class">
<title>The CommonMark\CQL class</title>
<titleabbrev>CommonMark\CQL</titleabbrev>
@@ -11,9 +10,9 @@
<!-- {{{ CommonMark\Parser intro -->
<section xml:id="commonmark-cql.intro">
&reftitle.intro;
<para>
<simpara>
CommonMark Query Language is a DSL for describing how to travel through a CommonMark Node tree implemented as a parser and compiler for a small set of instructions, and a virtual machine for executing those instructions.
</para>
</simpara>
<formalpara>
<title>Paths:</title>
<para>
@@ -38,7 +37,7 @@
<title>Subqueries</title>
<para>
CQL can be instructed how to travel by using a subquery like <literal>[/firstChild]</literal>. For example, <literal>/firstChild/children[/firstChild]</literal> will travel to the first child node of all the children of the first child node.
</para>
</para>
</formalpara>
<formalpara>
<title>Loop Constraints</title>
@@ -78,7 +77,7 @@
<title>Implementation Notes</title>
<para>
While CQL has been implemented as part of the PHP CommonMark extension, it stands separately from PHP and does not use PHP's virtual machine or internal representation of values.
</para>
</para>
</formalpara>
</section>
<!-- }}} -->
@@ -99,10 +98,10 @@
<!-- }}} -->
<classsynopsisinfo role="comment">&Constructor;</classsynopsisinfo>
<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')])" />
<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')])"/>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.commonmark-cql')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.commonmark-cql')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
</classsynopsis>
<!-- }}} -->
@@ -114,7 +113,6 @@
&reference.cmark.commonmark.cql.invoke;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

12
reference/cmark/commonmark.interfaces.ivisitable.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.commonmark-interfaces-ivisitable" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.commonmark-interfaces-ivisitable" role="class">
<title>The CommonMark\Interfaces\IVisitable interface</title>
<titleabbrev>CommonMark\Interfaces\IVisitable</titleabbrev>
@@ -11,9 +10,9 @@
<!-- {{{ CommonMark\Interfaces\IVisitable intro -->
<section xml:id="commonmark-interfaces-ivisitable.intro">
&reftitle.intro;
<para>
<simpara>
</para>
</simpara>
</section>
<!-- }}} -->
@@ -32,8 +31,8 @@
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.commonmark-interfaces-ivisitable')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.commonmark-interfaces-ivisitable')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
</classsynopsis>
<!-- }}} -->
@@ -44,7 +43,6 @@
&reference.cmark.commonmark.interfaces.ivisitable.accept;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

10
reference/cmark/commonmark.interfaces.ivisitor.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.commonmark-interfaces-ivisitor" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.commonmark-interfaces-ivisitor" role="class">
<title>The CommonMark\Interfaces\IVisitor interface</title>
<titleabbrev>CommonMark\Interfaces\IVisitor</titleabbrev>
@@ -11,9 +10,9 @@
<!-- {{{ CommonMark\Interfaces\IVisitor intro -->
<section xml:id="commonmark-interfaces-ivisitor.intro">
&reftitle.intro;
<para>
<simpara>
</para>
</simpara>
</section>
<!-- }}} -->
@@ -50,7 +49,7 @@
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.commonmark-interfaces-ivisitor')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.commonmark-interfaces-ivisitor')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
</classsynopsis>
<!-- }}} -->
@@ -62,7 +61,6 @@
&reference.cmark.commonmark.interfaces.ivisitor.leave;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

12
reference/cmark/commonmark.node.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.commonmark-node" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.commonmark-node" role="class">
<title>Abstract CommonMark\Node</title>
<titleabbrev>CommonMark\Node</titleabbrev>
@@ -11,9 +10,9 @@
<!-- {{{ CommonMark\Node intro -->
<section xml:id="commonmark-node.intro">
&reftitle.intro;
<para>
<simpara>
Represents an Abstract Node, this final abstract is not for direct use by the programmer.
</para>
</simpara>
</section>
<!-- }}} -->
@@ -35,7 +34,7 @@
<oointerface>
<interfacename>CommonMark\Interfaces\IVisitable</interfacename>
</oointerface>
<oointerface>
<interfacename>Traversable</interfacename>
</oointerface>
@@ -99,7 +98,7 @@
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.commonmark-node')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.commonmark-node')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
</classsynopsis>
<!-- }}} -->
@@ -117,7 +116,6 @@
&reference.cmark.commonmark.node.accept;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

14
reference/cmark/commonmark.parser.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.commonmark-parser" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.commonmark-parser" role="class">
<title>The CommonMark\Parser class</title>
<titleabbrev>CommonMark\Parser</titleabbrev>
@@ -11,9 +10,9 @@
<!-- {{{ CommonMark\Parser intro -->
<section xml:id="commonmark-parser.intro">
&reftitle.intro;
<para>
<simpara>
Provides an incremental parser as an alternative to the simple Parsing API function
</para>
</simpara>
</section>
<!-- }}} -->
@@ -34,10 +33,10 @@
<!-- }}} -->
<classsynopsisinfo role="comment">&Constructor;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('commonmark-parser.construct')/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('commonmark-parser.construct')/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])"/>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.commonmark-parser')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.commonmark-parser')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
</classsynopsis>
<!-- }}} -->
@@ -50,7 +49,6 @@
&reference.cmark.commonmark.parser.finish;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

14
reference/cmark/commonmark/cql/construct.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="commonmark-cql.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="commonmark-cql.construct">
<refnamediv>
<refname>CommonMark\CQL::__construct</refname>
<refpurpose>CQL Construction</refpurpose>
@@ -13,9 +12,9 @@
<modifier>public</modifier> <methodname>CommonMark\CQL::__construct</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</constructorsynopsis>
<para>
</para>
<simpara>
</simpara>
</refsect1>
@@ -25,16 +24,15 @@
<varlistentry>
<term><parameter>query</parameter></term>
<listitem>
<para>
<simpara>
a CQL string
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

10
reference/cmark/commonmark/cql/invoke.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="commonmark-cql.invoke" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="commonmark-cql.invoke">
<refnamediv>
<refname>CommonMark\CQL::__invoke</refname>
<refpurpose>CQL Execution</refpurpose>
@@ -14,10 +13,10 @@
<methodparam><type>CommonMark\Node</type><parameter>root</parameter></methodparam>
<methodparam><type>callable</type><parameter>handler</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Shall invoke the current CQL function on the given <parameter>root</parameter>,
executing the given <parameter>handler</parameter> on entry to a <type>CommonMark\Node</type>
</para>
</simpara>
</refsect1>
@@ -27,7 +26,7 @@
<varlistentry>
<term><parameter>root</parameter></term>
<listitem>
<para>the root node of a tree</para>
<simpara>the root node of a tree</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -52,7 +51,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

12
reference/cmark/commonmark/interfaces/ivisitable/accept.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="commonmark-interfaces-ivisitable.accept" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="commonmark-interfaces-ivisitable.accept">
<refnamediv>
<refname>CommonMark\Interfaces\IVisitable::accept</refname>
<refpurpose>Visitation</refpurpose>
@@ -22,9 +21,9 @@
<varlistentry>
<term><parameter>visitor</parameter></term>
<listitem>
<para>
<simpara>
An object implementing <classname>CommonMark\Interfaces\IVisitor</classname>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -33,13 +32,12 @@
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><xref linkend="commonmark-interfaces-ivisitor.enter" /></member>
<member><xref linkend="commonmark-interfaces-ivisitor.leave" /></member>
<member><xref linkend="commonmark-interfaces-ivisitor.enter"/></member>
<member><xref linkend="commonmark-interfaces-ivisitor.leave"/></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

30
reference/cmark/commonmark/interfaces/ivisitor/enter.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="commonmark-interfaces-ivisitor.enter" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="commonmark-interfaces-ivisitor.enter">
<refnamediv>
<refname>CommonMark\Interfaces\IVisitor::enter</refname>
<refpurpose>Visitation</refpurpose>
@@ -22,9 +21,9 @@
<varlistentry>
<term><parameter>visitable</parameter></term>
<listitem>
<para>
<simpara>
The current <classname>CommonMark\Interfaces\IVisitable</classname> being entered
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -32,33 +31,32 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returning <varname>CommonMark\Interfaces\IVisitor::Done</varname> will cause the backing iterator to exit.
</para>
<para>
</simpara>
<simpara>
Returning <varname>CommonMark\Interfaces\IVisitor::Enter</varname> will reset the backing iterator at entering the current <classname>IVisitable</classname>
</para>
<para>
</simpara>
<simpara>
Returning <varname>CommonMark\Interfaces\IVisitor::Leave</varname> will reset the backing iterator at exiting the current <classname>IVisitable</classname>
</para>
<para>
</simpara>
<simpara>
Returning an <classname>IVisitable</classname> will reset the backing iterator at entering the given <classname>IVisitable</classname>
</para>
<para>
</simpara>
<simpara>
Returning nothing will allow the backing iterator to continue
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><xref linkend="commonmark-interfaces-ivisitable.accept" /></member>
<member><xref linkend="commonmark-interfaces-ivisitable.accept"/></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

30
reference/cmark/commonmark/interfaces/ivisitor/leave.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="commonmark-interfaces-ivisitor.leave" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="commonmark-interfaces-ivisitor.leave">
<refnamediv>
<refname>CommonMark\Interfaces\IVisitor::leave</refname>
<refpurpose>Visitation</refpurpose>
@@ -22,9 +21,9 @@
<varlistentry>
<term><parameter>visitable</parameter></term>
<listitem>
<para>
<simpara>
The current <classname>CommonMark\Interfaces\IVisitable</classname> being exited
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -32,33 +31,32 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returning <varname>CommonMark\Interfaces\IVisitor::Done</varname> will cause the backing iterator to exit.
</para>
<para>
</simpara>
<simpara>
Returning <varname>CommonMark\Interfaces\IVisitor::Enter</varname> will reset the backing iterator at entering the current <classname>IVisitable</classname>
</para>
<para>
</simpara>
<simpara>
Returning <varname>CommonMark\Interfaces\IVisitor::Leave</varname> will reset the backing iterator at exiting the current <classname>IVisitable</classname>
</para>
<para>
</simpara>
<simpara>
Returning an <classname>IVisitable</classname> will reset the backing iterator at exiting the given <classname>IVisitable</classname>
</para>
<para>
</simpara>
<simpara>
Returning nothing will allow the backing iterator to continue
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><xref linkend="commonmark-interfaces-ivisitable.accept" /></member>
<member><xref linkend="commonmark-interfaces-ivisitable.accept"/></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

12
reference/cmark/commonmark/node/accept.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="commonmark-node.accept" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="commonmark-node.accept">
<refnamediv>
<refname>CommonMark\Node::accept</refname>
<refpurpose>Visitation</refpurpose>
@@ -22,9 +21,9 @@
<varlistentry>
<term><parameter>visitor</parameter></term>
<listitem>
<para>
<simpara>
An object implementing <classname>CommonMark\Interfaces\IVisitor</classname>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -33,14 +32,13 @@
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><xref linkend="commonmark-interfaces-ivisitor.enter" /></member>
<member><xref linkend="commonmark-interfaces-ivisitor.leave" /></member>
<member><xref linkend="commonmark-interfaces-ivisitor.enter"/></member>
<member><xref linkend="commonmark-interfaces-ivisitor.leave"/></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/cmark/commonmark/node/appendchild.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="commonmark-node.appendchild" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="commonmark-node.appendchild">
<refnamediv>
<refname>CommonMark\Node::appendChild</refname>
<refpurpose>AST Manipulation</refpurpose>
@@ -13,9 +12,9 @@
<modifier>public</modifier> <type>CommonMark\Node</type><methodname>CommonMark\Node::appendChild</methodname>
<methodparam><type>CommonMark\Node</type><parameter>child</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
&warn.undocumented.func;
@@ -27,9 +26,9 @@
<varlistentry>
<term><parameter>child</parameter></term>
<listitem>
<para>
</para>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -37,14 +36,13 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
<simpara>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

12
reference/cmark/commonmark/node/bulletlist/construct.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="commonmark-node-bulletlist.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="commonmark-node-bulletlist.construct">
<refnamediv>
<refname>CommonMark\Node\BulletList::__construct</refname>
<refpurpose>BulletList Construction</refpurpose>
@@ -11,7 +10,7 @@
&reftitle.description;
<constructorsynopsis>
<modifier>public</modifier> <methodname>CommonMark\Node\BulletList::__construct</methodname>
<void />
<void/>
</constructorsynopsis>
<constructorsynopsis>
<modifier>public</modifier> <methodname>CommonMark\Node\BulletList::__construct</methodname>
@@ -22,9 +21,9 @@
<methodparam><type>int</type><parameter>tight</parameter></methodparam>
<methodparam><type>int</type><parameter>delimiter</parameter></methodparam>
</constructorsynopsis>
<para>
<simpara>
</para>
</simpara>
&warn.undocumented.func;
@@ -41,7 +40,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
</refsect1>
-->
@@ -49,7 +48,6 @@
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

22
reference/cmark/commonmark/node/codeblock/construct.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="commonmark-node-codeblock.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="commonmark-node-codeblock.construct">
<refnamediv>
<refname>CommonMark\Node\CodeBlock::__construct</refname>
<refpurpose>CodeBlock Construction</refpurpose>
@@ -14,9 +13,9 @@
<methodparam><type>string</type><parameter>fence</parameter></methodparam>
<methodparam><type>string</type><parameter>literal</parameter></methodparam>
</constructorsynopsis>
<para>
<simpara>
</para>
</simpara>
&warn.undocumented.func;
@@ -28,17 +27,17 @@
<varlistentry>
<term><parameter>fence</parameter></term>
<listitem>
<para>
</para>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>literal</parameter></term>
<listitem>
<para>
</para>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -50,7 +49,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
</refsect1>
-->
@@ -58,7 +57,6 @@
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

12
reference/cmark/commonmark/node/heading/construct.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="commonmark-node-heading.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="commonmark-node-heading.construct">
<refnamediv>
<refname>CommonMark\Node\Heading::__construct</refname>
<refpurpose>Heading Construction</refpurpose>
@@ -11,15 +10,15 @@
&reftitle.description;
<constructorsynopsis>
<modifier>public</modifier> <methodname>CommonMark\Node\Heading::__construct</methodname>
<void />
<void/>
</constructorsynopsis>
<constructorsynopsis>
<modifier>public</modifier> <methodname>CommonMark\Node\Heading::__construct</methodname>
<methodparam><type>int</type><parameter>level</parameter></methodparam>
</constructorsynopsis>
<para>
<simpara>
</para>
</simpara>
&warn.undocumented.func;
@@ -36,7 +35,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
</refsect1>
-->
@@ -44,7 +43,6 @@
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

24
reference/cmark/commonmark/node/image/construct.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="commonmark-node-image.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="commonmark-node-image.construct">
<refnamediv>
<refname>CommonMark\Node\Image::__construct</refname>
<refpurpose>Image Construction</refpurpose>
@@ -11,7 +10,7 @@
&reftitle.description;
<constructorsynopsis>
<modifier>public</modifier> <methodname>CommonMark\Node\Image::__construct</methodname>
<void />
<void/>
</constructorsynopsis>
<constructorsynopsis>
<modifier>public</modifier> <methodname>CommonMark\Node\Image::__construct</methodname>
@@ -22,9 +21,9 @@
<methodparam><type>string</type><parameter>url</parameter></methodparam>
<methodparam><type>string</type><parameter>title</parameter></methodparam>
</constructorsynopsis>
<para>
<simpara>
</para>
</simpara>
&warn.undocumented.func;
@@ -36,17 +35,17 @@
<varlistentry>
<term><parameter>url</parameter></term>
<listitem>
<para>
</para>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>title</parameter></term>
<listitem>
<para>
</para>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -58,7 +57,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
</refsect1>
-->
@@ -66,7 +65,6 @@
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/cmark/commonmark/node/insertafter.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="commonmark-node.insertafter" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="commonmark-node.insertafter">
<refnamediv>
<refname>CommonMark\Node::insertAfter</refname>
<refpurpose>AST Manipulation</refpurpose>
@@ -13,9 +12,9 @@
<modifier>public</modifier> <type>CommonMark\Node</type><methodname>CommonMark\Node::insertAfter</methodname>
<methodparam><type>CommonMark\Node</type><parameter>sibling</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
&warn.undocumented.func;
@@ -27,9 +26,9 @@
<varlistentry>
<term><parameter>sibling</parameter></term>
<listitem>
<para>
</para>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -37,14 +36,13 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
<simpara>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/cmark/commonmark/node/insertbefore.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="commonmark-node.insertbefore" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="commonmark-node.insertbefore">
<refnamediv>
<refname>CommonMark\Node::insertBefore</refname>
<refpurpose>AST Manipulation</refpurpose>
@@ -13,9 +12,9 @@
<modifier>public</modifier> <type>CommonMark\Node</type><methodname>CommonMark\Node::insertBefore</methodname>
<methodparam><type>CommonMark\Node</type><parameter>sibling</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
&warn.undocumented.func;
@@ -27,9 +26,9 @@
<varlistentry>
<term><parameter>sibling</parameter></term>
<listitem>
<para>
</para>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -37,14 +36,13 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
<simpara>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

24
reference/cmark/commonmark/node/link/construct.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="commonmark-node-link.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="commonmark-node-link.construct">
<refnamediv>
<refname>CommonMark\Node\Link::__construct</refname>
<refpurpose>Link Construction</refpurpose>
@@ -11,7 +10,7 @@
&reftitle.description;
<constructorsynopsis>
<modifier>public</modifier> <methodname>CommonMark\Node\Link::__construct</methodname>
<void />
<void/>
</constructorsynopsis>
<constructorsynopsis>
<modifier>public</modifier> <methodname>CommonMark\Node\Link::__construct</methodname>
@@ -22,9 +21,9 @@
<methodparam><type>string</type><parameter>url</parameter></methodparam>
<methodparam><type>string</type><parameter>title</parameter></methodparam>
</constructorsynopsis>
<para>
<simpara>
</para>
</simpara>
&warn.undocumented.func;
@@ -36,17 +35,17 @@
<varlistentry>
<term><parameter>url</parameter></term>
<listitem>
<para>
</para>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>title</parameter></term>
<listitem>
<para>
</para>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -58,7 +57,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
</refsect1>
-->
@@ -66,7 +65,6 @@
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

30
reference/cmark/commonmark/node/orderedlist/construct.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="commonmark-node-orderedlist.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="commonmark-node-orderedlist.construct">
<refnamediv>
<refname>CommonMark\Node\OrderedList::__construct</refname>
<refpurpose>OrderedList Construction</refpurpose>
@@ -11,7 +10,7 @@
&reftitle.description;
<constructorsynopsis>
<modifier>public</modifier> <methodname>CommonMark\Node\OrderedList::__construct</methodname>
<void />
<void/>
</constructorsynopsis>
<constructorsynopsis>
<modifier>public</modifier> <methodname>CommonMark\Node\OrderedList::__construct</methodname>
@@ -28,9 +27,9 @@
<methodparam><type>int</type><parameter>delimiter</parameter></methodparam>
<methodparam><type>int</type><parameter>start</parameter></methodparam>
</constructorsynopsis>
<para>
<simpara>
</para>
</simpara>
&warn.undocumented.func;
@@ -42,25 +41,25 @@
<varlistentry>
<term><parameter>tight</parameter></term>
<listitem>
<para>
</para>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>delimiter</parameter></term>
<listitem>
<para>
</para>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>start</parameter></term>
<listitem>
<para>
</para>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -72,7 +71,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
</refsect1>
-->
@@ -80,7 +79,6 @@
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/cmark/commonmark/node/prependchild.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="commonmark-node.prependchild" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="commonmark-node.prependchild">
<refnamediv>
<refname>CommonMark\Node::prependChild</refname>
<refpurpose>AST Manipulation</refpurpose>
@@ -13,9 +12,9 @@
<modifier>public</modifier> <type>CommonMark\Node</type><methodname>CommonMark\Node::prependChild</methodname>
<methodparam><type>CommonMark\Node</type><parameter>child</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
&warn.undocumented.func;
@@ -27,9 +26,9 @@
<varlistentry>
<term><parameter>child</parameter></term>
<listitem>
<para>
</para>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -37,14 +36,13 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
<simpara>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/cmark/commonmark/node/replace.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="commonmark-node.replace" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="commonmark-node.replace">
<refnamediv>
<refname>CommonMark\Node::replace</refname>
<refpurpose>AST Manipulation</refpurpose>
@@ -13,9 +12,9 @@
<modifier>public</modifier> <type>CommonMark\Node</type><methodname>CommonMark\Node::replace</methodname>
<methodparam><type>CommonMark\Node</type><parameter>target</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
&warn.undocumented.func;
@@ -27,9 +26,9 @@
<varlistentry>
<term><parameter>target</parameter></term>
<listitem>
<para>
</para>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -37,14 +36,13 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
<simpara>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

18
reference/cmark/commonmark/node/text/construct.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="commonmark-node-text.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="commonmark-node-text.construct">
<refnamediv>
<refname>CommonMark\Node\Text::__construct</refname>
<refpurpose>Text Construction</refpurpose>
@@ -11,15 +10,15 @@
&reftitle.description;
<constructorsynopsis>
<modifier>public</modifier> <methodname>CommonMark\Node\Text::__construct</methodname>
<void />
<void/>
</constructorsynopsis>
<constructorsynopsis>
<modifier>public</modifier> <methodname>CommonMark\Node\Text::__construct</methodname>
<methodparam><type>string</type><parameter>literal</parameter></methodparam>
</constructorsynopsis>
<para>
<simpara>
</para>
</simpara>
&warn.undocumented.func;
@@ -31,9 +30,9 @@
<varlistentry>
<term><parameter>literal</parameter></term>
<listitem>
<para>
</para>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -45,7 +44,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
</refsect1>
-->
@@ -53,7 +52,6 @@
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

16
reference/cmark/commonmark/node/unlink.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="commonmark-node.unlink" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="commonmark-node.unlink">
<refnamediv>
<refname>CommonMark\Node::unlink</refname>
<refpurpose>AST Manipulation</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>CommonMark\Node::unlink</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
&warn.undocumented.func;
@@ -28,14 +27,13 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
<simpara>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

12
reference/cmark/commonmark/parser/construct.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="commonmark-parser.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="commonmark-parser.construct">
<refnamediv>
<refname>CommonMark\Parser::__construct</refname>
<refpurpose>Parsing</refpurpose>
@@ -13,9 +12,9 @@
<modifier>public</modifier> <methodname>CommonMark\Parser::__construct</methodname>
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
</constructorsynopsis>
<para>
<simpara>
</para>
</simpara>
&warn.undocumented.func;
@@ -27,9 +26,9 @@
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
<simpara>
A mask of:
</para>
</simpara>
<variablelist>
<varlistentry>
<term>
@@ -78,7 +77,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

16
reference/cmark/commonmark/parser/finish.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="commonmark-parser.finish" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="commonmark-parser.finish">
<refnamediv>
<refname>CommonMark\Parser::finish</refname>
<refpurpose>Parsing</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>CommonMark\Node</type><methodname>CommonMark\Parser::finish</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
&warn.undocumented.func;
@@ -28,14 +27,13 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
<simpara>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/cmark/commonmark/parser/parse.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="commonmark-parser.parse" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="commonmark-parser.parse">
<refnamediv>
<refname>CommonMark\Parser::parse</refname>
<refpurpose>Parsing</refpurpose>
@@ -13,9 +12,9 @@
<modifier>public</modifier> <type>void</type><methodname>CommonMark\Parser::parse</methodname>
<methodparam><type>string</type><parameter>buffer</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
&warn.undocumented.func;
@@ -27,9 +26,9 @@
<varlistentry>
<term><parameter>buffer</parameter></term>
<listitem>
<para>
</para>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -37,14 +36,13 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
<simpara>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

13
reference/cmark/configure.xml
View File

@@ -1,20 +1,17 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<section xml:id="cmark.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="cmark.installation">
&reftitle.install;
<para>
<simpara>
Use <option role="configure">--with-cmark[=DIR]</option> when compiling PHP.
</para>
</simpara>
<para>
<simpara>
Windows users should include <filename>php_cmark.dll</filename> into &php.ini;
</para>
</simpara>
</section>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/cmark/functions/commonmark.parse.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.commonmark-parse" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.commonmark-parse">
<refnamediv>
<refname>CommonMark\Parse</refname>
<refpurpose>Parsing</refpurpose>
@@ -14,9 +13,9 @@
<methodparam><type>string</type><parameter>content</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Shall parse <parameter>content</parameter>
</para>
</simpara>
</refsect1>
@@ -26,17 +25,17 @@
<varlistentry>
<term><parameter>content</parameter></term>
<listitem>
<para>
<simpara>
markdown string
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
<simpara>
A mask of:
</para>
</simpara>
<variablelist>
<varlistentry>
<term>
@@ -86,14 +85,13 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Shall return root CommonMark\Node
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

24
reference/cmark/functions/commonmark.render.html.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.commonmark-render-html" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.commonmark-render-html">
<refnamediv>
<refname>CommonMark\Render\HTML</refname>
<refpurpose>Rendering</refpurpose>
@@ -14,9 +13,9 @@
<methodparam><type>CommonMark\Node</type><parameter>node</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
&warn.undocumented.func;
@@ -28,17 +27,17 @@
<varlistentry>
<term><parameter>node</parameter></term>
<listitem>
<para>
</para>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
<simpara>
A mask of:
</para>
</simpara>
<variablelist>
<varlistentry>
<term>
@@ -98,14 +97,13 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
<simpara>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

30
reference/cmark/functions/commonmark.render.latex.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.commonmark-render-latex" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.commonmark-render-latex">
<refnamediv>
<refname>CommonMark\Render\Latex</refname>
<refpurpose>Rendering</refpurpose>
@@ -15,9 +14,9 @@
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>width</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
&warn.undocumented.func;
@@ -29,17 +28,17 @@
<varlistentry>
<term><parameter>node</parameter></term>
<listitem>
<para>
</para>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
<simpara>
A mask of:
</para>
</simpara>
<variablelist>
<varlistentry>
<term>
@@ -97,9 +96,9 @@
<varlistentry>
<term><parameter>width</parameter></term>
<listitem>
<para>
</para>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -107,14 +106,13 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
<simpara>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

30
reference/cmark/functions/commonmark.render.man.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.commonmark-render-man" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.commonmark-render-man">
<refnamediv>
<refname>CommonMark\Render\Man</refname>
<refpurpose>Rendering</refpurpose>
@@ -15,9 +14,9 @@
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>width</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
&warn.undocumented.func;
@@ -29,17 +28,17 @@
<varlistentry>
<term><parameter>node</parameter></term>
<listitem>
<para>
</para>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
<simpara>
A mask of:
</para>
</simpara>
<variablelist>
<varlistentry>
<term>
@@ -97,9 +96,9 @@
<varlistentry>
<term><parameter>width</parameter></term>
<listitem>
<para>
</para>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -107,14 +106,13 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
<simpara>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

30
reference/cmark/functions/commonmark.render.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.commonmark-render" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.commonmark-render">
<refnamediv>
<refname>CommonMark\Render</refname>
<refpurpose>Rendering</refpurpose>
@@ -15,9 +14,9 @@
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>width</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
&warn.undocumented.func;
@@ -29,17 +28,17 @@
<varlistentry>
<term><parameter>node</parameter></term>
<listitem>
<para>
</para>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
<simpara>
A mask of:
</para>
</simpara>
<variablelist>
<varlistentry>
<term>
@@ -97,9 +96,9 @@
<varlistentry>
<term><parameter>width</parameter></term>
<listitem>
<para>
</para>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -107,14 +106,13 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
<simpara>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

24
reference/cmark/functions/commonmark.render.xml.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.commonmark-render-xml" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.commonmark-render-xml">
<refnamediv>
<refname>CommonMark\Render\XML</refname>
<refpurpose>Rendering</refpurpose>
@@ -14,9 +13,9 @@
<methodparam><type>CommonMark\Node</type><parameter>node</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
&warn.undocumented.func;
@@ -28,17 +27,17 @@
<varlistentry>
<term><parameter>node</parameter></term>
<listitem>
<para>
</para>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
<simpara>
A mask of:
</para>
</simpara>
<variablelist>
<varlistentry>
<term>
@@ -98,14 +97,13 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
<simpara>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

22
reference/cmark/setup.xml
View File

@@ -1,37 +1,35 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<chapter xml:id="cmark.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="cmark.setup">
&reftitle.setup;
<section xml:id="cmark.requirements">
&reftitle.required;
<para>
<simpara>
The CommonMark extension requires the (C) reference implementation of <link xlink:href="&url.git.hub;commonmark/cmark">cmark</link>.
</para>
</simpara>
</section>
<section xml:id="cmark.installation">
&reftitle.install;
<para>
<simpara>
The CommonMark extension releases are hosted by PECL and source is hosted on
<link xlink:href="&url.git.hub;krakjoe/cmark">github</link>,
<link xlink:href="&url.git.hub;krakjoe/cmark">github</link>,
the easiest route to installation is the normal PECL route:
<link xlink:href="&url.pecl.package;cmark">&url.pecl.package;cmark</link>.
</para>
<para>
</simpara>
<simpara>
Windows users can download prebuilt release binaries from the <link xlink:href="&url.pecl.package;cmark">PECL</link> website.
</para>
</simpara>
<caution>
<para>
<simpara>
Windows users need to take the additional step of adding cmark.dll (distributed with Windows releases) to their <envar>PATH</envar>.
</para>
</simpara>
</caution>
</section>
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml