| <?xml version="1.0" encoding="UTF-8"?> | |
| <!-- | |
| 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. | |
| --> | |
| <document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | |
| xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd"> | |
| <properties> | |
| <title>Layouts</title> | |
| </properties> | |
| <body> | |
| <section name="Layouts"> | |
| <p>Layouts are components responsible for transforming a logging event into a string.</p> | |
| <p>More often than not, users wish to customize not only the output destination but also the output format. This is | |
| accomplished by associating a layout with an appender. All messages logged by that appender will use the given layout.</p> | |
| <subsection name="Layout reference" id="Layout_reference"> | |
| <p>The following layout classes are available:</p> | |
| <table> | |
| <thead> | |
| <tr> | |
| <th>Name</th> | |
| <th>Description</th> | |
| </tr> | |
| </thead> | |
| <tbody> | |
| <tr> | |
| <td><a href="layouts/html.html">LoggerLayoutHTML</a></td> | |
| <td> Outputs events in a HTML table.</td> | |
| </tr> | |
| <tr> | |
| <td><a href="layouts/pattern.html">LoggerLayoutPattern</a></td> | |
| <td>A flexible layout configurable via a pattern string.</td> | |
| </tr> | |
| <tr> | |
| <td><a href="layouts/simple.html">LoggerLayoutSimple</a></td> | |
| <td>A simple, non configurable layout.</td> | |
| </tr> | |
| <tr> | |
| <td><a href="layouts/serialized.html">LoggerLayoutSerialized</a></td> | |
| <td>Outputs serialized objects.</td> | |
| </tr> | |
| <tr> | |
| <td><a href="layouts/ttcc.html">LoggerLayoutTTCC</a></td> | |
| <td>Consists of Time, Thread, Category and nested diagnostic Context. | |
| <span class="label label-warning">DEPRECATED</span></td> | |
| </tr> | |
| <tr> | |
| <td><a href="layouts/xml.html">LoggerLayoutXml</a></td> | |
| <td>Outputs events as an XML document.</td> | |
| </tr> | |
| </tbody> | |
| </table> | |
| </subsection> | |
| </section> | |
| </body> | |
| </document> |