Skip to content

Commit

Permalink
Remove link atts from lq, remove longquoteref oasis-tcs#397
Browse files Browse the repository at this point in the history
  • Loading branch information
@robander
robander committed Jun 1, 2021
1 parent f83950d commit 958e504
Show file tree
Hide file tree
Showing 9 changed files with 12 additions and 149 deletions.
2 changes: 0 additions & 2 deletions doctypes/dtd/base/commonElements.ent
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,6 @@
<!ENTITY % desc "desc" >
<!ENTITY % p "p" >
<!ENTITY % note "note" >
<!ENTITY % longquoteref
"longquoteref" >
<!ENTITY % lq "lq" >
<!ENTITY % q "q" >
<!ENTITY % sl "sl" >
Expand Down
51 changes: 1 addition & 50 deletions doctypes/dtd/base/commonElements.mod
View file
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,6 @@
%basic.ph; |
%data.elements.incl; |
%foreign.unknown.incl; |
%longquoteref; |
%txt.incl;"
>
<!ENTITY % tblcell.cnt
Expand Down Expand Up @@ -742,59 +741,12 @@
<!ATTLIST note %note.attributes;>


<!-- LONG NAME: Long Quote Reference -->
<!ENTITY % longquoteref.content
"EMPTY"
>
<!ENTITY % longquoteref.attributes
"href
CDATA
#IMPLIED
keyref
CDATA
#IMPLIED
type
CDATA
#IMPLIED
format
CDATA
#IMPLIED
scope
(external |
local |
peer |
-dita-use-conref-target)
#IMPLIED
%univ-atts;"
>
<!ELEMENT longquoteref %longquoteref.content;>
<!ATTLIST longquoteref %longquoteref.attributes;>


<!-- LONG NAME: Long Quote -->
<!ENTITY % lq.content
"(%longquote.cnt;)*"
>
<!ENTITY % lq.attributes
"href
CDATA
#IMPLIED
keyref
CDATA
#IMPLIED
format
CDATA
#IMPLIED
type
CDATA
#IMPLIED
scope
(external |
local |
peer |
-dita-use-conref-target)
#IMPLIED
reftitle
"keyref
CDATA
#IMPLIED
%univ-atts;"
Expand Down Expand Up @@ -1868,7 +1820,6 @@
<!ATTLIST li class CDATA "- topic/li " >
<!ATTLIST lines class CDATA "- topic/lines " >
<!ATTLIST longdescref class CDATA "- topic/longdescref ">
<!ATTLIST longquoteref class CDATA "- topic/longquoteref ">
<!ATTLIST lq class CDATA "- topic/lq " >
<!ATTLIST media-source class CDATA "- topic/media-source ">
<!ATTLIST media-track class CDATA "- topic/media-track ">
Expand Down
75 changes: 0 additions & 75 deletions doctypes/rng/base/commonElementsMod.rng
View file
Original file line number Diff line number Diff line change
Expand Up @@ -144,9 +144,6 @@ PUBLIC "-//OASIS//ELEMENTS DITA 2.0 Common Elements//EN"
<define name="longdescref">
<ref name="longdescref.element"/>
</define>
<define name="longquoteref">
<ref name="longquoteref.element"/>
</define>
<define name="lq">
<ref name="lq.element"/>
</define>
Expand Down Expand Up @@ -662,7 +659,6 @@ PUBLIC "-//OASIS//ELEMENTS DITA 2.0 Common Elements//EN"
<ref name="basic.ph"/>
<ref name="data.elements.incl"/>
<ref name="foreign.unknown.incl"/>
<ref name="longquoteref"/>
<ref name="txt.incl"/>
</choice>
</define>
Expand Down Expand Up @@ -1332,50 +1328,6 @@ PUBLIC "-//OASIS//ELEMENTS DITA 2.0 Common Elements//EN"
<ref name="note.attributes"/>
</define>

</div>
<div>
<a:documentation>LONG NAME: Long quote reference</a:documentation>
<define name="longquoteref.content">
<empty/>
</define>
<define name="longquoteref.attributes">
<optional>
<attribute name="href"/>
</optional>
<optional>
<attribute name="keyref"/>
</optional>
<optional>
<attribute name="type"/>
</optional>
<optional>
<attribute name="format"/>
</optional>
<optional>
<attribute name="scope">
<choice>
<value>external</value>
<value>local</value>
<value>peer</value>
<value>-dita-use-conref-target</value>
</choice>
</attribute>
</optional>
<ref name="univ-atts"/>
</define>
<define name="longquoteref.element">
<element name="longquoteref" dita:longName="Long Quote Reference">
<a:documentation>The &lt;longquoteref> element provides a reference to the source of a long quote. The long quote (&lt;lq>) element itself allows an href attribute to specify the source of
a quote, but it does not allow other standard linking attributes such as keyref, scope, and format. The &lt;longquoteref> element should be used for references that make use of these
attributes. </a:documentation>
<ref name="longquoteref.attlist"/>
<ref name="longquoteref.content"/>
</element>
</define>
<define name="longquoteref.attlist" combine="interleave">
<ref name="longquoteref.attributes"/>
</define>

</div>
<div>
<a:documentation>LONG NAME: Long Quote (Excerpt)</a:documentation>
Expand All @@ -1385,31 +1337,9 @@ PUBLIC "-//OASIS//ELEMENTS DITA 2.0 Common Elements//EN"
</zeroOrMore>
</define>
<define name="lq.attributes">
<optional>
<attribute name="href"/>
</optional>
<optional>
<attribute name="keyref"/>
</optional>
<optional>
<attribute name="format"/>
</optional>
<optional>
<attribute name="type"/>
</optional>
<optional>
<attribute name="scope">
<choice>
<value>external</value>
<value>local</value>
<value>peer</value>
<value>-dita-use-conref-target</value>
</choice>
</attribute>
</optional>
<optional>
<attribute name="reftitle"/>
</optional>
<ref name="univ-atts"/>
</define>
<define name="lq.element">
Expand Down Expand Up @@ -3402,11 +3332,6 @@ PUBLIC "-//OASIS//ELEMENTS DITA 2.0 Common Elements//EN"
<attribute name="class" a:defaultValue="- topic/longdescref "/>
</optional>
</define>
<define name="longquoteref.attlist" combine="interleave">
<optional>
<attribute name="class" a:defaultValue="- topic/longquoteref "/>
</optional>
</define>
<define name="lq.attlist" combine="interleave">
<optional>
<attribute name="class" a:defaultValue="- topic/lq "/>
Expand Down
10 changes: 7 additions & 3 deletions specification/archSpec/base/processing-keyref-for-text.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,14 +44,18 @@
<xmlelement>topicmeta</xmlelement>, the content of the
<xmlelement>shortdesc</xmlelement> element also provides effective
content for a <xmlelement>desc</xmlelement> sub-element.</li>
<li>The <xmlelement>longdescref</xmlelement> and
<xmlelement>longquoteref</xmlelement> elements are empty elements
<li>The <xmlelement>longdescref</xmlelement> element is an empty element
with no effective content. Key definitions do not set effective text for
these elements.</li>
this element.</li>
<li>The <xmlelement>param</xmlelement> element does not have any effective
content, so key definitions do not result in effective content for
<xmlelement>param</xmlelement> elements.</li>
</ul>
<draft-comment author="robander" time="1 june 2021">we've allowed @keyref on
&lt;lq> for a while now. Based on discussion at today's TC (1 june 2021)
this would be interpreted as the title of the source of the quotation - thus
the removal of href/reftitle. OK to update accordingly, or does that need
further confirmation from TC?</draft-comment>
</dd>
</dlentry>
<dlentry>
Expand Down
7 changes: 3 additions & 4 deletions specification/langRef/base/harvested-content-base.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,10 +114,9 @@ this is unwieldy, the <xmlelement>data</xmlelement> element can go in the
</section>
<section>
<title><xmlelement>lq</xmlelement></title>
<p>Authors can use the <xmlatt>href</xmlatt> and <xmlatt>keyref</xmlatt> attributes to specify
the source of the quotation. Use the quote element <xmlelement>q</xmlelement> for short
quotations that are intended to be rendered inline. The <xmlelement>longquoteref</xmlelement>
element is available for more complex references to the source of a quotation.</p>
<p>Authors can use the <xmlatt>keyref</xmlatt> attribute to specify the source of the quotation.
Use the quote element <xmlelement>q</xmlelement> for short quotations that are intended to
be rendered inline.</p>
</section>
<section>
<title><xmlelement>map</xmlelement></title>
Expand Down
13 changes: 1 addition & 12 deletions specification/langRef/base/lq.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,7 @@
<refbody>
<section id="attributes">
<title>Attributes</title>
<draft-comment author="robander" time="14 May 2021"><xmlelement>longquoteref</xmlelement> was
added to help with translation, moving translatable titles out of @reftitle. Not sure why we
still have reftitle and all the linking attributes on lq itself, when that's what
longquoteref is for?</draft-comment>
<p>The following attributes are available on this element: <ph conkeyref="reuse-attributes/ref-universalatts"/>, <ph conkeyref="reuse-attributes/ref-linkatts"/>, and <xref keyref="attributes-common/attr-keyref"
><xmlatt>keyref</xmlatt></xref>, and the attributes defined below.</p>
<dl>
<dlentry id="reftitle">
<dt id="attr-reftitle"><xmlatt>reftitle</xmlatt></dt>
<dd>The title of the document or topic that is quoted.</dd>
</dlentry>
</dl>
<p conkeyref="reuse-attributes/universal-keyref"/>
</section>
<example id="example" otherprops="examples">
<title>Example</title>
Expand Down
1 change: 0 additions & 1 deletion specification/langRef/body-elements.ditamap
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
<topicref keyref="elements-li" />
<topicref keyref="elements-lines" />
<topicref keyref="elements-longdescref" />
<topicref keyref="elements-longquoteref" />
<topicref keyref="elements-lq" />
<topicref keyref="elements-note" />
<topicref keyref="elements-object" />
Expand Down
1 change: 0 additions & 1 deletion specification/langRef/key-definitions-body-elements.ditamap
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@
<keydef href="base/li.dita" keys="elements-li" />
<keydef href="base/lines.dita" keys="elements-lines" />
<keydef href="base/longdescref.dita" keys="elements-longdescref" />
<keydef href="base/longquoteref.dita" keys="elements-longquoteref" />
<keydef href="base/lq.dita" keys="elements-lq" />
<keydef href="base/note.dita" keys="elements-note" />
<keydef href="base/object.dita" keys="elements-object" />
Expand Down
1 change: 0 additions & 1 deletion specification/langRef/quick-reference/base-elements-a-to-z.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,6 @@
<sli><xref keyref="elements-linkpool"/></sli>
<sli><xref keyref="elements-linktext"/></sli>
<sli><xref keyref="elements-longdescref"/></sli>
<sli><xref keyref="elements-longquoteref"/></sli>
<sli><xref keyref="elements-lq"/></sli>
<sli><xref keyref="elements-map"/></sli>
<sli><xref keyref="elements-mapref"/></sli>
Expand Down

0 comments on commit 958e504

Please sign in to comment.