Repository: struts-site Updated Branches: refs/heads/asf-site 77840af47 -> 0dccbe248
Updates production by Jenkins Project: http://git-wip-us.apache.org/repos/asf/struts-site/repo Commit: http://git-wip-us.apache.org/repos/asf/struts-site/commit/0dccbe24 Tree: http://git-wip-us.apache.org/repos/asf/struts-site/tree/0dccbe24 Diff: http://git-wip-us.apache.org/repos/asf/struts-site/diff/0dccbe24 Branch: refs/heads/asf-site Commit: 0dccbe2489992b620788bcb5d2cb966cd5d786f2 Parents: 77840af Author: jenkins <bui...@apache.org> Authored: Tue Sep 12 10:28:28 2017 +0000 Committer: jenkins <bui...@apache.org> Committed: Tue Sep 12 10:28:28 2017 +0000 ---------------------------------------------------------------------- content/core-developers/plaintext-result.html | 33 +++++++++++++++------- 1 file changed, 23 insertions(+), 10 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/struts-site/blob/0dccbe24/content/core-developers/plaintext-result.html ---------------------------------------------------------------------- diff --git a/content/core-developers/plaintext-result.html b/content/core-developers/plaintext-result.html index 362a738..ff7b772 100644 --- a/content/core-developers/plaintext-result.html +++ b/content/core-developers/plaintext-result.html @@ -127,20 +127,33 @@ <a class="edit-on-gh" href="https://github.com/apache/struts-site/edit/master/source/core-developers/plaintext-result.md"; title="Edit this page on GitHub">Edit on GitHub</a> <h1 id="plaintext-result">PlainText Result</h1> -<div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="err">snippet:id=description|javadoc=true|url=org.apache.struts2.dispatcher.PlainTextResult</span><span class="p">}</span><span class="w"> -</span></code></pre> -</div> +<h2 id="description">Description</h2> -<p>#####Parameters#####</p> +<p>A result that send the content out as plain text. Useful typically when needed +to display the raw content of a JSP or Html file for example.</p> -<div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="err">snippet:id=params|javadoc=true|url=org.apache.struts2.dispatcher.PlainTextResult</span><span class="p">}</span><span class="w"> -</span></code></pre> -</div> +<h2 id="parameters">Parameters</h2> + +<ul> + <li><code class="highlighter-rouge">location</code> (default) - location of the file (jsp/html) to be displayed as plain text.</li> + <li><code class="highlighter-rouge">charSet</code> (optional) - character set to be used. This character set will be used to set the response type +(eg. <code class="highlighter-rouge">Content-Type=text/plain; charset=UTF-8</code>) and when reading using a <code class="highlighter-rouge">Reader</code>. Some example of charSet would be +UTF-8, ISO-8859-1 etc.</li> +</ul> + +<h2 id="examples">Examples</h2> -<p>#####Examples#####</p> +<div class="highlighter-rouge"><pre class="highlight"><code><span class="nt"><action</span> <span class="na">name=</span><span class="s">"displayJspRawContent"</span> <span class="nt">></span> + <span class="nt"><result</span> <span class="na">type=</span><span class="s">"plainText"</span><span class="nt">></span>/myJspFile.jsp<span class="nt"></result></span> +<span class="nt"></action></span> -<div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="err">snippet:id=example|lang=xml|javadoc=true|url=org.apache.struts2.dispatcher.PlainTextResult</span><span class="p">}</span><span class="w"> -</span></code></pre> +<span class="nt"><action</span> <span class="na">name=</span><span class="s">"displayJspRawContent"</span> <span class="nt">></span> + <span class="nt"><result</span> <span class="na">type=</span><span class="s">"plainText"</span><span class="nt">></span> + <span class="nt"><param</span> <span class="na">name=</span><span class="s">"location"</span><span class="nt">></span>/myJspFile.jsp<span class="nt"></param></span> + <span class="nt"><param</span> <span class="na">name=</span><span class="s">"charSet"</span><span class="nt">></span>UTF-8<span class="nt"></param></span> + <span class="nt"></result></span> +<span class="nt"></action></span> +</code></pre> </div> </section>
