Warning:
This wiki has been archived and is now read-only.
View source for XHTML2/pre obsolete

Jump to: navigation, search
You do not have permission to edit this page, for the following reason:
The action you have requested is limited to users in one of the groups: Users, 106, 32107-chairs.
You can view and copy the source of this page.
__NOTOC__
= Proposal: <code>PRE</code> Is Obsolete and Should Be Removed from the XHTML2 Structural Module =

__TOC__

== Problems with <code>PRE</code> ==

The first question which must be posed in a discussion of <code>PRE</code>, is: what precisely constitues, in the words of the latest editors' 
draft of XHTML2, <q cite="http://www.w3.org/MarkUp/2009/ED-xhtml2-20090407/mod-structural.html#edef_structural_pre">whitespace in the enclosed text [which] has semantic relevance</q>? If one needs to preserve whitespace, such as in an example of python code, one should either use <code>code</code> or <code>blockcode</code> for that purpose, as the definition of the three elements: [http://www.w3.org/MarkUp/2009/ED-xhtml2-20090407/mod-structural.html#edef_structural_code <code>CODE</code>], [http://www.w3.org/MarkUp/2009/ED-xhtml2-20090407/mod-structural.html#edef_structural_blockcode <code>BLOCKCODE</code>], and [http://www.w3.org/MarkUp/2009/ED-xhtml2-20090407/mod-structural.html#edef_structural_pre <code>PRE</code>] makes clear.

If explicitly designated as "code" an assistive technology could respect and report the whitespaces contained in the string of <code>code</code>, something which is not possible with the <code>PRE</code> element, unless '''''each''''' and '''''every''''' whitespace to be preserved is '''''explicitly''''' expressed with a character entity value.

This would mitigate the necessity of definitively communicating multi-modally the presence and number of whitespaces in an example through the use of the character entity value of a "non-breaking space" (e.g. <code>&amp;nbsp;</code> or either <code>&amp;#xa0;</code> or <code>&amp;#x20;</code> (i'm not sure which is right, the first value is from an online list, the second from <cite>XML 1.0, Fourth Edition</cite>) -- if the whitespace has "semantic meaning", then the amount of whitespace '''MUST''' be explicitly expressed with markup (or the containing element '''''MUST''''' respect and not conflate whitespace in strings marked with the <code>CODE</code> or 
<code>BLOCKCODE</code> element) in order to make the number of whitespaces perceivable (theoretically definable on a per-element basis through the "<code>layout</code>" attribute, which will be discussed further, below), as well as endowing a human or assistive technology to process the precise number of whitespaces correctly.  therefore, best practice would be to use either <code>&amp;#xa0;</code> or <code>&amp;#x20;</code> or <code>&amp;nbsp;</code> for each whitespace the author desires to be preserved, as variable space delineation is a hallmark of some programming languages, and a user needs the ability to count the whitespaces (or have them correctly rendered when sent to a refreshable braille display or when embossed into tactile braille)

Optimally, one would want to use a character entity code to indicate a TAB or multiple TABs, as some programming languages use TAB delineation, and the purpose of <code>CODE</code> and <code>BLOCKCODE</code> is to '''ENSURE''' that any user can copy and paste the sample of <code>CODE</code>, with whitespaces and explicitly declared TABs preserved.

----

== Rationale for the Obscelecense of <code>PRE</code> ==

Since the following is explicitly stated in the current editors' draft of XHTML2' Structural module: 

<blockquote cite="http://www.w3.org/MakUp/2009/ED-xhtml2-20090407/mod-structural.html#edef_structural_pre">
Note that while historically one use of the <code>pre</code> element has been as a container for source code, the new <Code>blockcode</code> element more appropriate for that. 
</blockquote> 

'''''and''''', since the example of the "bad poem" in the definition of <code>PRE</code> should be controlled either by style sheets, the "<code>layout</code>" attribute (set to <code>relevant</code>) or the <code>xml:space</code> attribute, defined in <cite>Section 2.10 ("White Space Handling")</cite> in the <cite>Fifth Edition of XML 1.0</cite>: 

<blockquote cite="http://www.w3.org/TR/xml/#sec-white-space"> 

A special attribute named <code>xml:space</code> may be attached to an element to signal an intention that in that element, white space should be preserved by applications. In valid documents, this attribute, like any other, must be declared if it is used. When declared, it must be given as an enumerated type whose values are one or both of "<code>default</code>" and "<code>preserve</code>". For example: 
<br />
<br />
<code>&lt;!ATTLIST poem  xml:space (default|preserve) 'preserve'&gt;</code>
</blockquote>

'''''and''''' since the "conformance definition" for whitespace in XHTML2 states: 

<blockquote cite="http://www.w3.org/MarkUp/2009/xhtml2-ED-2009-04-07/conformance.html#conf_whitespace">

White space must be handled according to the rules of [XML]. All XHTML 2 elements preserve whitespace. 

The user agent must use the definition from CSS for processing white space characters [CSS3-TEXT]. 

</blockquote> 

----

== Proposals Concerning <code>PRE</code> ==

'''PROPOSED 1:''' the <code>PRE</code> element is no longer necessary, and therefore should be removed from the [[XHTML2/Structural|<cite>XHTML2 Structural Model</cite>]]. 

'''CAVEAT 1.1:''' at the '''''VERY''''' least -- <code>PRE</code> should be deprecated into a legacy module, but removing it altogether will eliminate future headaches and break authors of the lazy habit of using <code>PRE</code> as a lazy-catchall solution; superior mechanisms other than <code>PRE</code>, such as <code>CODE</code> and <code>BLOCKCODE</code>, have been introduced, and there is widespread support for CSS to control columnization, thereby eliminating another abuse of <code>PRE</code>.

'''PROPOSED 2:''' That the definition of <code>CODE</code> and <code>BLOCKCODE</code> be amended to indicate that whitespace, line breaks, and other "layout" compenents contained within <code>CODE</code> or <code>BLOCKCODE</code> is intended to be preserved, and that all current references to the <code>PRE</code> element be removed. An authoring tool could very easily translate individual spaces and other dilimeters (such as TAB) into the UTF-8 codes for a non-breaking whitespace and/or a TAB or TABs. This is also a strategy which a quality authoring tool would, when set to encode in UTF-8, automaically substitute the unicode values, expressed as character entity values, of "special" characters contained within <code>CODE</code> or <code>BLOCKCODE</code> into the actual character-entity for the delimitor, so that it can be faithfully and confidently communicated to the user, and which would facillitate the retention of whitespace and TABs when the string contained within <code>CODE</code> and <code>BLOCKCODE</code>.

'''PROPOSED 3:''' that the "bad poem" example be changed to reflect <cite>Section 2.10</cite> of <cite>XML 1.0 Fifth Edition</cite> through the use of the <code>xml:space</code> "<code>preserve</code>" attribute, as follows:

<pre>
<!-- begin 'bad poem' example --> 
<!-- in HEAD --> 
<!ATTLIST poem xml:space (preserve) #FIXED 'preserve'> 
<!-- in BODY --> 
<!-- ... --> 
<p xml:id="poem" layout="relevant" xml:space="preserve"> 
                If 
             I   had 
          any       talent 
             I   would 
              be a 
              poet 
</p> 
<!-- end 'bad poem' example --> 
</pre>

'''PROPOSED 4:''' That the "bad poem" example be removed from the draft altogether, an the use of spacing for stylistic effect be covered elsewhere in the document (although this could also be, and perhaps should be, handled by a pass-off to a CSS recommendation
)


----

== Related Resources ==

* [http://www.w3.org/MarkUp/tracker/issue/7  XHTML2 WG Issue 7]
** [http://www.w3.org/MarkUp/tracker/actions/70  XHTML2 WG ACTION-70]

----
* [[XHTML2|XHTML2 Individual Module Wiki Page Index]]
* [[Role|XHTML Role Module Wiki Page Index]]
* [http://www.w3.org/MarkUp/ XHTML2 Public Web Space]
* [http://www.w3.org/MarkUp/Drafts/Overview.html XHTML2 Document Development Area]
* [http://lists.w3.org/Archives/Public/public-xhtml2 public-xhtml2 email archive]
* [http://lists.w3.org/Archives/Public/html-editor html-editor email archive]
Return to XHTML2/pre obsolete.
Retrieved from "https://www.w3.org/MarkUp/xhtml2/wiki/XHTML2/pre_obsolete"
View source for XHTML2/pre obsolete

Navigation menu

Personal tools

Namespaces

Variants

Views

More

Navigation

Tools
