Repository: struts-site Updated Branches: refs/heads/master a62c7745a -> 62800eb17
Update PlainText result page Project: http://git-wip-us.apache.org/repos/asf/struts-site/repo Commit: http://git-wip-us.apache.org/repos/asf/struts-site/commit/62800eb1 Tree: http://git-wip-us.apache.org/repos/asf/struts-site/tree/62800eb1 Diff: http://git-wip-us.apache.org/repos/asf/struts-site/diff/62800eb1 Branch: refs/heads/master Commit: 62800eb179b1bf0a0e6b44684fe040282780ab35 Parents: a62c774 Author: Lukasz Lenart <lukaszlen...@apache.org> Authored: Tue Sep 12 12:27:46 2017 +0200 Committer: Lukasz Lenart <lukaszlen...@apache.org> Committed: Tue Sep 12 12:27:46 2017 +0200 ---------------------------------------------------------------------- source/core-developers/plaintext-result.md | 35 ++++++++++++++----------- 1 file changed, 20 insertions(+), 15 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/struts-site/blob/62800eb1/source/core-developers/plaintext-result.md ---------------------------------------------------------------------- diff --git a/source/core-developers/plaintext-result.md b/source/core-developers/plaintext-result.md index 74777fe..8bfae9d 100644 --- a/source/core-developers/plaintext-result.md +++ b/source/core-developers/plaintext-result.md @@ -5,24 +5,29 @@ title: PlainText Result # PlainText Result +## Description +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. -~~~~~~~ -{snippet:id=description|javadoc=true|url=org.apache.struts2.dispatcher.PlainTextResult} -~~~~~~~ +## Parameters -#####Parameters##### + - `location` (default) - location of the file (jsp/html) to be displayed as plain text. + - `charSet` (optional) - character set to be used. This character set will be used to set the response type + (eg. `Content-Type=text/plain; charset=UTF-8`) and when reading using a `Reader`. Some example of charSet would be + UTF-8, ISO-8859-1 etc. +## Examples +```xml +<action name="displayJspRawContent" > + <result type="plainText">/myJspFile.jsp</result> +</action> -~~~~~~~ -{snippet:id=params|javadoc=true|url=org.apache.struts2.dispatcher.PlainTextResult} -~~~~~~~ - -#####Examples##### - - - -~~~~~~~ -{snippet:id=example|lang=xml|javadoc=true|url=org.apache.struts2.dispatcher.PlainTextResult} -~~~~~~~ +<action name="displayJspRawContent" > + <result type="plainText"> + <param name="location">/myJspFile.jsp</param> + <param name="charSet">UTF-8</param> + </result> +</action> +```
