Skip to content

[WIP] Add RFC skeleton for interfaces #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed

[WIP] Add RFC skeleton for interfaces #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
234aed0
Add RFC skeleton for interfaces
mallardduck Apr 28, 2022
6e01215
fix end tag being commented out
mallardduck Apr 28, 2022
aa7a30f
What if we just add interface specific tags here...
mallardduck Apr 28, 2022
077e6e5
Allow new interfacesynopsis into sections
mallardduck Apr 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 91 additions & 0 deletions RFC/skeletons/interfacename.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
<?xml version="1.0" encoding="utf-8"?>
<phpdoc:classref xml:id="class.classname"
xmlns:phpdoc="http://php.net/ns/phpdoc"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns="http://docbook.org/ns/docbook">

<title>The InterfaceName interface</title>
<titleabbrev>InterfaceName</titleabbrev>

<partintro>

<!-- {{{ InterfaceName intro -->
<section xml:id="classname.intro">
&reftitle.intro;
<para>
Description of the interface.
</para>
</section>
<!-- }}} -->

<section xml:id="classname.synopsis">
&reftitle.interfacesynopsis;

<!-- {{{ Synopsis -->
<interfacesynopsis>
<ooclass><classname>InterfaceName</classname></ooclass>

<!-- {{{ Class synopsis -->
<interfacesynopsisinfo>
<oointerface>
<interfacename>InterfaceName</interfacename>
</oointerface>

<!-- If the interface extends any other interface, or two, use this (one oointerface element per interface; extends modifier only on first one)
<oointerface>
<modifier>extends</modifier>
<interfacename>InterfaceName</interfacename>
</oointerface>
-->
</interfacesynopsisinfo>
<!-- }}} -->

<!-- Edit the classname below -->
<interfacesynopsisinfo role="comment">&Methods;</interfacesynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.classname')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])">
<xi:fallback />
</xi:include>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.classname')/db:refentry/db:refsect1[@role='description']/descendant::db:destructorsynopsis[not(@role='procedural')])">
<xi:fallback />
</xi:include>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.classname')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
<xi:fallback />
</xi:include>

<!-- If the interface extends an interface use this. Repeat the <xi:include> tag for all the parent interfaces in the event of multiple extensions; i.e. class XYZ extends class XY and class XY extends class X
<classsynopsisinfo role="comment">Inherited methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.baseclassname')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural') and not(modifier='private')])">
<xi:fallback/>
</xi:include>
-->
</interfacesynopsis>
<!-- }}} -->

</section>

</partintro>

&reference.extname.entities.classname;

</phpdoc:classref>
<!-- 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
-->
29 changes: 28 additions & 1 deletion docbook/docbook-xml/docbook.dtd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -932,6 +932,33 @@

>

<!ELEMENT interfacesynopsis ((ooclass|oointerface)+, (interfacesynopsisinfo|methodsynopsis|constructorsynopsis|destructorsynopsis|fieldsynopsis|xi:include)*)>

<!ATTLIST interfacesynopsis
xmlns CDATA #FIXED "http://docbook.org/ns/docbook"
role CDATA #IMPLIED
%db.common.attributes;
%db.common.linking.attributes;
language CDATA #IMPLIED
class (class|interface) #IMPLIED

>

<!ELEMENT interfacesynopsisinfo (#PCDATA|info|textobject|inlinemediaobject|remark|superscript|subscript|xref|link|olink|anchor|biblioref|alt|annotation|indexterm|abbrev|acronym|date|emphasis|footnote|footnoteref|foreignphrase|phrase|quote|wordasword|firstterm|glossterm|coref|productnumber|productname|database|application|hardware|trademark|citation|citerefentry|citetitle|citebiblioid|author|person|personname|org|orgname|editor|jobtitle|replaceable|systemitem|option|optional|package|parameter|property|termdef|nonterminal|errorcode|errortext|errorname|errortype|prompt|envar|filename|command|computeroutput|userinput|function|varname|returnvalue|type|classname|exceptionname|interfacename|methodname|modifier|initializer|ooclass|ooexception|oointerface|tag|markup|token|symbol|literal|code|constant|email|uri|guiicon|guibutton|guimenuitem|guimenu|guisubmenu|guilabel|menuchoice|mousebutton|keycombo|keycap|keycode|keysym|shortcut|accel|inlineequation|lineannotation|co)*>

<!ATTLIST interfacesynopsisinfo
xmlns CDATA #FIXED "http://docbook.org/ns/docbook"
role CDATA #IMPLIED
%db.common.attributes;
%db.common.linking.attributes;
continuation (continues|restarts) #IMPLIED
linenumbering (numbered|unnumbered) #IMPLIED
startinglinenumber NMTOKEN #IMPLIED
language CDATA #IMPLIED
xml:space (preserve) #IMPLIED

>

<!ELEMENT ooclass ((package|modifier)*, classname)>

<!ATTLIST ooclass
Expand Down Expand Up @@ -2644,7 +2671,7 @@

>

<!ELEMENT section (((title|titleabbrev|subtitle)*, info?), (((itemizedlist|orderedlist|procedure|simplelist|variablelist|segmentedlist|glosslist|bibliolist|calloutlist|qandaset|caution|important|note|tip|warning|example|figure|table|equation|informalexample|informalfigure|informaltable|informalequation|sidebar|blockquote|address|epigraph|mediaobject|screenshot|task|productionset|constraintdef|msgset|programlisting|screen|literallayout|synopsis|programlistingco|screenco|cmdsynopsis|funcsynopsis|classsynopsis|methodsynopsis|constructorsynopsis|destructorsynopsis|fieldsynopsis|bridgehead|remark|revhistory|indexterm|anchor|para|formalpara|simpara|annotation)+, (((section)+, (simplesect)*)|(simplesect)+|(phpdoc:varentry|refentry)+)?)|((section)+, (simplesect)*)|(simplesect)+|(phpdoc:varentry|refentry|xi:include)+), (glossary|bibliography|index|toc)*)>
<!ELEMENT section (((title|titleabbrev|subtitle)*, info?), (((itemizedlist|orderedlist|procedure|simplelist|variablelist|segmentedlist|glosslist|bibliolist|calloutlist|qandaset|caution|important|note|tip|warning|example|figure|table|equation|informalexample|informalfigure|informaltable|informalequation|sidebar|blockquote|address|epigraph|mediaobject|screenshot|task|productionset|constraintdef|msgset|programlisting|screen|literallayout|synopsis|programlistingco|screenco|cmdsynopsis|funcsynopsis|classsynopsis|interfacesynopsis|methodsynopsis|constructorsynopsis|destructorsynopsis|fieldsynopsis|bridgehead|remark|revhistory|indexterm|anchor|para|formalpara|simpara|annotation)+, (((section)+, (simplesect)*)|(simplesect)+|(phpdoc:varentry|refentry)+)?)|((section)+, (simplesect)*)|(simplesect)+|(phpdoc:varentry|refentry|xi:include)+), (glossary|bibliography|index|toc)*)>

<!ATTLIST section
xmlns CDATA #FIXED "http://docbook.org/ns/docbook"
Expand Down