Sign Up
Log In
Log In
or
Sign Up
Places
All Projects
Status Monitor
Collapse sidebar
home:Ledest:erlang:25
erlang
1651-erl_docgen-Add-new-XML-tag-change.patch
Overview
Repositories
Revisions
Requests
Users
Attributes
Meta
File 1651-erl_docgen-Add-new-XML-tag-change.patch of Package erlang
From b5a017f1f987ee761eeff5b29df95715b410ac9e Mon Sep 17 00:00:00 2001 From: Sverker Eriksson <sverker@erlang.org> Date: Fri, 28 Oct 2022 15:36:48 +0200 Subject: [PATCH 1/2] erl_docgen: Add new XML tag <change> Like <note> but aimed for describing semantic changes between releases. --- lib/erl_docgen/priv/css/otp_doc.css | 14 +++++++++++++- lib/erl_docgen/priv/dtd/application.dtd | 2 +- lib/erl_docgen/priv/dtd/book.dtd | 4 ++-- lib/erl_docgen/priv/dtd/chapter.dtd | 4 ++-- lib/erl_docgen/priv/dtd/common.dtd | 3 ++- lib/erl_docgen/priv/dtd/common.refs.dtd | 8 ++++---- lib/erl_docgen/priv/dtd/part.dtd | 2 +- lib/erl_docgen/priv/xsl/db_html.xsl | 15 +++++++++++++++ lib/erl_docgen/priv/xsl/db_man.xsl | 13 ++++++++++++- lib/erl_docgen/priv/xsl/db_pdf.xsl | 17 ++++++++++++++++- lib/erl_docgen/src/docgen_xml_to_chunk.erl | 6 +++--- 11 files changed, 71 insertions(+), 17 deletions(-) diff --git a/lib/erl_docgen/priv/css/otp_doc.css b/lib/erl_docgen/priv/css/otp_doc.css index d8615c7c4f..796d2f4096 100644 --- a/lib/erl_docgen/priv/css/otp_doc.css +++ b/lib/erl_docgen/priv/css/otp_doc.css @@ -286,7 +286,7 @@ a:visited { color: #1b6ec2; text-decoration: none } background-color: #f3f3f3; } -.note, .warning, .do, .dont { +.note, .change, .warning, .do, .dont { border: 1px solid #495057; margin: 1em 0; } @@ -302,6 +302,18 @@ a:visited { color: #1b6ec2; text-decoration: none } font-size: 0.9em; padding: 0.5em 1em; } +.change .label { + background-color: steelblue; + color: #fefefe; + font-weight: bold; + padding: 0.5em 1em; +} +.change .content { + background: #f8f9fa; + line-height: 120%; + font-size: 0.9em; + padding: 0.5em 1em; +} .warning .label { background: #c92a2a; color: #fefefe; diff --git a/lib/erl_docgen/priv/dtd/application.dtd b/lib/erl_docgen/priv/dtd/application.dtd index 25ef0d1261..5b56251a4d 100644 --- a/lib/erl_docgen/priv/dtd/application.dtd +++ b/lib/erl_docgen/priv/dtd/application.dtd @@ -25,6 +25,6 @@ %common.header; <!ELEMENT application (header,description?,include+) > -<!ELEMENT description (%block;|quote|br|marker|warning|note|dont|do)* > +<!ELEMENT description (%block;|quote|br|marker|warning|note|change|dont|do)* > <!ELEMENT include EMPTY > <!ATTLIST include file CDATA #REQUIRED> diff --git a/lib/erl_docgen/priv/dtd/book.dtd b/lib/erl_docgen/priv/dtd/book.dtd index 326bf3369a..709ffbb901 100644 --- a/lib/erl_docgen/priv/dtd/book.dtd +++ b/lib/erl_docgen/priv/dtd/book.dtd @@ -39,7 +39,7 @@ <!ELEMENT pagetext (#PCDATA) > <!ELEMENT preamble (contents?,preface?) > -<!ELEMENT preface (title?,(%block;|quote|br|marker|warning|note|dont|do|table)*) > +<!ELEMENT preface (title?,(%block;|quote|br|marker|warning|note|change|dont|do|table)*) > <!ELEMENT insidecover (#PCDATA|br|theheader|vfill|vspace|tt|bold| include)* > @@ -69,7 +69,7 @@ <!ELEMENT onepart (title?,description?,include+) > <!ATTLIST onepart lift (yes|no) "no" > -<!ELEMENT description (%block;|quote|br|marker|warning|note|dont|do)* > +<!ELEMENT description (%block;|quote|br|marker|warning|note|change|dont|do)* > <!ELEMENT include EMPTY > <!ATTLIST include file CDATA #REQUIRED> diff --git a/lib/erl_docgen/priv/dtd/chapter.dtd b/lib/erl_docgen/priv/dtd/chapter.dtd index 3e9113d798..b1a48b1c4c 100644 --- a/lib/erl_docgen/priv/dtd/chapter.dtd +++ b/lib/erl_docgen/priv/dtd/chapter.dtd @@ -30,9 +30,9 @@ <!-- Structure --> -<!ELEMENT chapter (header,(%block;|quote|warning|note|dont|do|br| +<!ELEMENT chapter (header,(%block;|quote|warning|note|change|dont|do|br| image|marker|table)*,section*) > <!ELEMENT section (marker*,title, - (%block;|quote|warning|note|dont|do|br|image|marker| + (%block;|quote|warning|note|change|dont|do|br|image|marker| table|section)*) > <!ATTLIST section ghlink CDATA #IMPLIED> diff --git a/lib/erl_docgen/priv/dtd/common.dtd b/lib/erl_docgen/priv/dtd/common.dtd index 2b7a83aabc..861a7e4c3e 100644 --- a/lib/erl_docgen/priv/dtd/common.dtd +++ b/lib/erl_docgen/priv/dtd/common.dtd @@ -36,6 +36,7 @@ <!ELEMENT quote (p)* > <!ELEMENT warning (%block;|quote|br|marker)* > <!ELEMENT note (%block;|quote|br|marker)* > +<!ELEMENT change (%block;|quote|br|marker)* > <!ELEMENT dont (%block;|quote|br|marker)* > <!ELEMENT do (%block;|quote|br|marker)* > <!ELEMENT c (#PCDATA|anno)* > @@ -53,7 +54,7 @@ <!ATTLIST list type (ordered|bulleted) "bulleted" > <!ELEMENT taglist (tag,item+)+ > <!ELEMENT tag (#PCDATA|c|i|em|br|%refs;|marker|anno)* > -<!ELEMENT item (%inline;|%block;|warning|note|dont|do|quote|table)* > +<!ELEMENT item (%inline;|%block;|warning|note|change|dont|do|quote|table)* > <!-- References --> diff --git a/lib/erl_docgen/priv/dtd/common.refs.dtd b/lib/erl_docgen/priv/dtd/common.refs.dtd index 280efcd99c..08e26a8b27 100644 --- a/lib/erl_docgen/priv/dtd/common.refs.dtd +++ b/lib/erl_docgen/priv/dtd/common.refs.dtd @@ -25,7 +25,7 @@ <!ENTITY % common.header SYSTEM "common.header.dtd" > %common.header; -<!ELEMENT description (%block;|quote|br|marker|warning|note|dont|do)* > +<!ELEMENT description (%block;|quote|br|marker|warning|note|change|dont|do)* > <!ATTLIST description ghlink CDATA #IMPLIED> <!ELEMENT funcs (fsdescription?,func+) > <!ELEMENT func (name+,fsummary,(type|type_desc)*,desc?) > @@ -38,15 +38,15 @@ name_i CDATA #IMPLIED> <!ELEMENT v (#PCDATA|%refs;)* > <!ELEMENT d (#PCDATA|%refs;|c|i|em)* > -<!ELEMENT desc (%block;|quote|br|marker|warning|note|dont|do)* > +<!ELEMENT desc (%block;|quote|br|marker|warning|note|change|dont|do)* > <!ELEMENT authors (aname,email)+ > <!ELEMENT aname (#PCDATA) > <!ELEMENT email (#PCDATA) > <!ELEMENT section (marker*,title,(%block;|quote|br|marker| - warning|note|dont|do|section)*) > + warning|note|change|dont|do|section)*) > <!ATTLIST section ghlink CDATA #IMPLIED> <!ELEMENT fsdescription (marker*,title,(%block;|quote|br|marker| - warning|note|dont|do|section)*) > + warning|note|change|dont|do|section)*) > <!ATTLIST fsdescription ghlink CDATA #IMPLIED> <!ELEMENT datatypes (datatype_title?,datatype)+ > <!ELEMENT datatype_title (#PCDATA) > diff --git a/lib/erl_docgen/priv/dtd/part.dtd b/lib/erl_docgen/priv/dtd/part.dtd index 6329413f0e..57de542767 100644 --- a/lib/erl_docgen/priv/dtd/part.dtd +++ b/lib/erl_docgen/priv/dtd/part.dtd @@ -25,6 +25,6 @@ %common.header; <!ELEMENT part (header,description?,include+) > -<!ELEMENT description (%block;|quote|br|marker|warning|note|dont|do)* > +<!ELEMENT description (%block;|quote|br|marker|warning|note|change|dont|do)* > <!ELEMENT include EMPTY > <!ATTLIST include file CDATA #REQUIRED> diff --git a/lib/erl_docgen/priv/xsl/db_html.xsl b/lib/erl_docgen/priv/xsl/db_html.xsl index f47b294ea9..82b83fe886 100644 --- a/lib/erl_docgen/priv/xsl/db_html.xsl +++ b/lib/erl_docgen/priv/xsl/db_html.xsl @@ -1283,6 +1283,21 @@ </div> </xsl:template> + <!-- Change --> + <xsl:template match="change"> + <xsl:param name="chapnum"/> + <div class="change"> + <div class="label">Change</div> + <div class="content"> + <p> + <xsl:apply-templates> + <xsl:with-param name="chapnum" select="$chapnum"/> + </xsl:apply-templates> + </p> + </div> + </div> + </xsl:template> + <!-- Warning --> <xsl:template match="warning"> <xsl:param name="chapnum"/> diff --git a/lib/erl_docgen/priv/xsl/db_man.xsl b/lib/erl_docgen/priv/xsl/db_man.xsl index de89aa6b17..927f9436d6 100644 --- a/lib/erl_docgen/priv/xsl/db_man.xsl +++ b/lib/erl_docgen/priv/xsl/db_man.xsl @@ -539,6 +539,17 @@ <xsl:text> </xsl:text> </xsl:template> + <!-- Change --> + <xsl:template match="change"> + <xsl:text> .LP </xsl:text> + <xsl:text> .RS -4</xsl:text> + <xsl:text> .B </xsl:text> + <xsl:text>Change:</xsl:text> + <xsl:text> .RE</xsl:text> + <xsl:apply-templates/> + <xsl:text> </xsl:text> + </xsl:template> + <!-- Warning --> <xsl:template match="warning"> <xsl:text> .LP </xsl:text> @@ -572,7 +583,7 @@ <xsl:text> </xsl:text> </xsl:template> - <xsl:template match="warning/p | note/p | dont/p | do/p"> + <xsl:template match="warning/p | note/p | change/p | dont/p | do/p"> <xsl:variable name="content"> <xsl:text> </xsl:text> <xsl:apply-templates/> diff --git a/lib/erl_docgen/priv/xsl/db_pdf.xsl b/lib/erl_docgen/priv/xsl/db_pdf.xsl index ba5e3c3491..aaa0536601 100644 --- a/lib/erl_docgen/priv/xsl/db_pdf.xsl +++ b/lib/erl_docgen/priv/xsl/db_pdf.xsl @@ -980,7 +980,7 @@ </fo:block> - <xsl:apply-templates select="section|quote|warning|note|br|image|marker|table|p|pre|code|list|taglist|codeinclude"> + <xsl:apply-templates select="section|quote|warning|note|change|br|image|marker|table|p|pre|code|list|taglist|codeinclude"> <xsl:with-param name="partnum" select="$partnum"/> <xsl:with-param name="chapnum"><xsl:number/></xsl:with-param> </xsl:apply-templates> @@ -1145,6 +1145,21 @@ </fo:block> </xsl:template> + <!-- Change --> + <xsl:template match="change"> + <xsl:param name="partnum"/> + <fo:block xsl:use-attribute-sets="note-warning"> + <fo:block xsl:use-attribute-sets="note-title"> + <xsl:text>Change:</xsl:text> + </fo:block> + <fo:block xsl:use-attribute-sets="note-warning-content"> + <xsl:apply-templates> + <xsl:with-param name="partnum" select="$partnum"/> + </xsl:apply-templates> + </fo:block> + </fo:block> + </xsl:template> + <!-- Warning --> <xsl:template match="warning"> <xsl:param name="partnum"/> diff --git a/lib/erl_docgen/src/docgen_xml_to_chunk.erl b/lib/erl_docgen/src/docgen_xml_to_chunk.erl index a26412e557..a795b205c2 100644 --- a/lib/erl_docgen/src/docgen_xml_to_chunk.erl +++ b/lib/erl_docgen/src/docgen_xml_to_chunk.erl @@ -238,7 +238,7 @@ build_dom({ignorableWhitespace, String}, #state{dom=[{Name,_,_} = _E|_]} = State) -> case lists:member(Name, [p,pre,input,code,quote,warning, - note,dont,do,c,b,i,em,strong, + note,change,dont,do,c,b,i,em,strong, seemfa,seeerl,seetype,seeapp, seecom,seecref,seefile,seeguide, tag,item]) of @@ -387,9 +387,9 @@ transform([{marker,Attrs,Content}|T],Acc) -> %% transform <url href="external URL"> Content</url> to <a href.... transform([{url,Attrs,Content}|T],Acc) -> transform(T,[{a,a2b(Attrs),transform(Content,[])}|Acc]); -%% transform note/warning/do/don't to <p class="thing"> +%% transform note/change/warning/do/don't to <p class="thing"> transform([{What,[],Content}|T],Acc) - when What =:= note; What =:= warning; What =:= do; What =:= dont -> + when What =:= note; What =:= change; What =:= warning; What =:= do; What =:= dont -> WhatP = {'div',[{class,atom_to_binary(What)}], transform(Content,[])}, transform(T,[WhatP|Acc]); -- 2.35.3
Locations
Projects
Search
Status Monitor
Help
OpenBuildService.org
Documentation
API Documentation
Code of Conduct
Contact
Support
@OBShq
Terms
openSUSE Build Service is sponsored by
The Open Build Service is an
openSUSE project
.
Sign Up
Log In
Places
Places
All Projects
Status Monitor
