RELEASE_2_1_13/src/webapp/samples/text-wrap/welcome.html - cocoon - Git at Google

 <!--
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You under the Apache License, Version 2.0
   (the "License"); you may not use this file except in compliance with
   the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
 -->
 <html>
 <head>
 <title>Various methods to handle long lines of text</title>
 </head>
 <body>
 <h1>Various methods to handle long lines of text</h1>

 <p>
 Sometimes the lines inside &lt;source&gt; elements are too wide,
 which can make the resulting pages too wide to view on screen or to print.
 The width of the long source line causes the whole page layout to be that
 same width. A web page that is wider than the screen is a complete bastard to
 read - you have to scroll right and left all the time. And printing in
 landscape orientation is not very nice either.
 (See Issue report
 <a href="http://issues.apache.org/jira/browse/COCOON-841">COCOON-841</a>.)
 </p>

 <p>
 If everyone followed code conventions for Java and XML then this
 would not happen. However, there is no way to guarantee that.
 </p>

 <p>
 Of course, there is the workaround solution to edit the offending source
 elements to specifically break long lines. Not good for automated solutions
 or separation of concerns.
 </p>

 <p>
 We need to find a way to consistently split lines that are too wide.
 Here are demonstrations of various solutions. Each one has pros and cons.
 Please help to enhance these solutions so that one can soon be implemented.
 (See <a href="#notes">Notes</a> below.)
 </p>

 <p>
 The following examples are deliberately extreme to ensure that the issues
 are triggered.
 </p>

 <h2>Using no special handling</h2>
 <p>No special handling was done for the
 &lt;source&gt; elements. The content is wrapped with a &lt;pre&gt; element.
 Note the long right-left scrollbar.
 </p>
 <ul>
 <li>
 <a href="raw/with-word-boundaries">Long Line With Word Boundaries</a>
 </li>
 <li>
 <a href="raw/without-word-boundaries">Long Line Without Word Boundaries</a>
 </li>
 <li>
 <a href="raw/cdata-model">CDATA and deeply embedded xml content model</a>
 </li>
 <li>
 <a href="raw/cdata-model-2">CDATA and deeply embedded xml content model with long names</a>
 </li>
 </ul>

 <h2>Using the "split.xsl" stylesheet</h2>
 <p>All &lt;source&gt; elements had their long lines wrapped at a defined
 width (72) by the included split.xsl stylesheet. Lines with no whitespace
 (such as long URLs) are forcefully split at 72 characters.
 The content is wrapped with a &lt;pre&gt; element.
 </p>
 <p>Note: In past Cocoons this stylesheet has been reported to be a memory
 hog on certain JVMs. How does it go for you?
 </p>
 <ul>
 <li>
 <a href="split/with-word-boundaries">Long Line With Word Boundaries</a>
 </li>
 <li>
 <a href="split/without-word-boundaries">Long Line Without Word Boundaries</a>
 </li>
 <li>
 <a href="split/cdata-model">CDATA and deeply embedded xml content model</a>
 </li>
 <li>
 <a href="split/cdata-model-2">CDATA and deeply embedded xml content model with long names</a>
 </li>
 </ul>

 <h2>Using the "wrap2para.xsl" stylesheet</h2>
 <p>Only &lt;source&gt; elements that contain an xml content model had their
 lines handled by the included wrap2para.xsl stylesheet. It does not intend to
 address all cases of source, only type=xml source.
 Lines are each wrapped with a styled &lt;p&gt; element.
 </p>
 <ul>
 <li>
 <a href="wrap2para/cdata-model">CDATA and deeply embedded xml content model</a>
 </li>
 <li>
 <a href="wrap2para/cdata-model-2">CDATA and deeply embedded xml content model with long names</a>
 </li>
 </ul>

 <h2>Using the "docnbsp.xsl" stylesheet</h2>
 <p>
 Sequences of two consecutive spaces are replaced by a non-breaking space
 and a regular space.
 Each line is encased in a &lt;code&gt;&lt;br/&gt;
 This method keeps the text indentation that would be obtained with a &lt;pre&gt;
 while still allowing line wrapping by the browser.
 This utilises the <a href="http://exslt.org/">exslt extension</a> for strings.
 </p>
 <ul>
 <li>
 <a href="nbsp/with-word-boundaries">Long Line With Word Boundaries</a>
 </li>
 <li>
 <a href="nbsp/without-word-boundaries">Long Line Without Word Boundaries</a>
 </li>
 <li>
 <a href="nbsp/cdata-model">CDATA and deeply embedded xml content model</a>
 </li>
 <li>
 <a href="nbsp/cdata-model-2">CDATA and deeply embedded xml content model with long names</a>
 </li>
 </ul>

 <a name="notes" />
 <h2>Other notes</h2>
 <p>
 Suggested enhancements include: using the @type attribute; "content sniff"; ...
 </p>

 <p>
 There may be some other solutions. Suggestions include the Chaperon Block
 and maybe the Slop Block.
 </p>

 <p>
 See the issue report
 (<a href="http://issues.apache.org/jira/browse/COCOON-841">COCOON-841</a>)
 and the links to the cocoon-dev and forrest-dev mail discussion.
 </p>

 <p>
 Some testcase documents ...
 </p>
 <ul>
 <li><a href="http://forrest.apache.org/docs/your-project.html">Using Forrest</a></li>
 <li><a href="http://cocoon.apache.org/2.1/userdocs/concepts/modules.html">Modules</a></li>
 </ul>

 </body>
 </html>
	<!--
	Licensed to the Apache Software Foundation (ASF) under one or more
	contributor license agreements. See the NOTICE file distributed with
	this work for additional information regarding copyright ownership.
	The ASF licenses this file to You under the Apache License, Version 2.0
	(the "License"); you may not use this file except in compliance with
	the License. You may obtain a copy of the License at

	http://www.apache.org/licenses/LICENSE-2.0

	Unless required by applicable law or agreed to in writing, software
	distributed under the License is distributed on an "AS IS" BASIS,
	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	See the License for the specific language governing permissions and
	limitations under the License.
	-->
	<html>
	<head>
	<title>Various methods to handle long lines of text</title>
	</head>
	<body>
	<h1>Various methods to handle long lines of text</h1>

	<p>
	Sometimes the lines inside <source> elements are too wide,
	which can make the resulting pages too wide to view on screen or to print.
	The width of the long source line causes the whole page layout to be that
	same width. A web page that is wider than the screen is a complete bastard to
	read - you have to scroll right and left all the time. And printing in
	landscape orientation is not very nice either.
	(See Issue report
	<a href="http://issues.apache.org/jira/browse/COCOON-841">COCOON-841</a>.)
	</p>

	<p>
	If everyone followed code conventions for Java and XML then this
	would not happen. However, there is no way to guarantee that.
	</p>

	<p>
	Of course, there is the workaround solution to edit the offending source
	elements to specifically break long lines. Not good for automated solutions
	or separation of concerns.
	</p>

	<p>
	We need to find a way to consistently split lines that are too wide.
	Here are demonstrations of various solutions. Each one has pros and cons.
	Please help to enhance these solutions so that one can soon be implemented.
	(See <a href="#notes">Notes</a> below.)
	</p>

	<p>
	The following examples are deliberately extreme to ensure that the issues
	are triggered.
	</p>

	<h2>Using no special handling</h2>
	<p>No special handling was done for the
	<source> elements. The content is wrapped with a <pre> element.
	Note the long right-left scrollbar.
	</p>
	<ul>
	<li>
	<a href="raw/with-word-boundaries">Long Line With Word Boundaries</a>
	</li>
	<li>
	<a href="raw/without-word-boundaries">Long Line Without Word Boundaries</a>
	</li>
	<li>
	<a href="raw/cdata-model">CDATA and deeply embedded xml content model</a>
	</li>
	<li>
	<a href="raw/cdata-model-2">CDATA and deeply embedded xml content model with long names</a>
	</li>
	</ul>

	<h2>Using the "split.xsl" stylesheet</h2>
	<p>All <source> elements had their long lines wrapped at a defined
	width (72) by the included split.xsl stylesheet. Lines with no whitespace
	(such as long URLs) are forcefully split at 72 characters.
	The content is wrapped with a <pre> element.
	</p>
	<p>Note: In past Cocoons this stylesheet has been reported to be a memory
	hog on certain JVMs. How does it go for you?
	</p>
	<ul>
	<li>
	<a href="split/with-word-boundaries">Long Line With Word Boundaries</a>
	</li>
	<li>
	<a href="split/without-word-boundaries">Long Line Without Word Boundaries</a>
	</li>
	<li>
	<a href="split/cdata-model">CDATA and deeply embedded xml content model</a>
	</li>
	<li>
	<a href="split/cdata-model-2">CDATA and deeply embedded xml content model with long names</a>
	</li>
	</ul>

	<h2>Using the "wrap2para.xsl" stylesheet</h2>
	<p>Only <source> elements that contain an xml content model had their
	lines handled by the included wrap2para.xsl stylesheet. It does not intend to
	address all cases of source, only type=xml source.
	Lines are each wrapped with a styled <p> element.
	</p>
	<ul>
	<li>
	<a href="wrap2para/cdata-model">CDATA and deeply embedded xml content model</a>
	</li>
	<li>
	<a href="wrap2para/cdata-model-2">CDATA and deeply embedded xml content model with long names</a>
	</li>
	</ul>

	<h2>Using the "docnbsp.xsl" stylesheet</h2>
	<p>
	Sequences of two consecutive spaces are replaced by a non-breaking space
	and a regular space.
	Each line is encased in a <code><br/>
	This method keeps the text indentation that would be obtained with a <pre>
	while still allowing line wrapping by the browser.
	This utilises the <a href="http://exslt.org/">exslt extension</a> for strings.
	</p>
	<ul>
	<li>
	<a href="nbsp/with-word-boundaries">Long Line With Word Boundaries</a>
	</li>
	<li>
	<a href="nbsp/without-word-boundaries">Long Line Without Word Boundaries</a>
	</li>
	<li>
	<a href="nbsp/cdata-model">CDATA and deeply embedded xml content model</a>
	</li>
	<li>
	<a href="nbsp/cdata-model-2">CDATA and deeply embedded xml content model with long names</a>
	</li>
	</ul>

	<a name="notes" />
	<h2>Other notes</h2>
	<p>
	Suggested enhancements include: using the @type attribute; "content sniff"; ...
	</p>

	<p>
	There may be some other solutions. Suggestions include the Chaperon Block
	and maybe the Slop Block.
	</p>

	<p>
	See the issue report
	(<a href="http://issues.apache.org/jira/browse/COCOON-841">COCOON-841</a>)
	and the links to the cocoon-dev and forrest-dev mail discussion.
	</p>

	<p>
	Some testcase documents ...
	</p>
	<ul>
	<li><a href="http://forrest.apache.org/docs/your-project.html">Using Forrest</a></li>
	<li><a href="http://cocoon.apache.org/2.1/userdocs/concepts/modules.html">Modules</a></li>
	</ul>

	</body>
	</html>