1. Project Clover database Sat Feb 2 2019 06:45:20 CET
  2. Package org.xwiki.rendering.configuration

File RenderingConfiguration.java

 

Code metrics

0
0
0
1
73
11
0
-
-
0
-

Classes

Class Line # Actions
RenderingConfiguration 38 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /*
2    * See the NOTICE file distributed with this work for additional
3    * information regarding copyright ownership.
4    *
5    * This is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU Lesser General Public License as
7    * published by the Free Software Foundation; either version 2.1 of
8    * the License, or (at your option) any later version.
9    *
10    * This software is distributed in the hope that it will be useful,
11    * but WITHOUT ANY WARRANTY; without even the implied warranty of
12    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13    * Lesser General Public License for more details.
14    *
15    * You should have received a copy of the GNU Lesser General Public
16    * License along with this software; if not, write to the Free
17    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19    */
20    package org.xwiki.rendering.configuration;
21   
22    import java.util.List;
23    import java.util.Properties;
24   
25    import org.xwiki.component.annotation.Role;
26   
27    /**
28    * Configuration properties for the Rendering module.
29    * <p>
30    * You can override the default values for each of the configuration properties below by defining them in XWiki's
31    * global configuration file using a prefix of "rendering" followed by the property name. For example:
32    * <code>rendering.linkLabelFormat = %s.%p</code>
33    *
34    * @version $Id: 3eec6b25799ba4e0ae8ee0d62149eba23972dafb $
35    * @since 1.6M1
36    */
37    @Role
 
38    public interface RenderingConfiguration
39    {
40    /**
41    * A link label format is the format used to decide how to display links that have no label.
42    * By default the page name is displayed. However it's possible to customize it using the
43    * following tokens:
44    * <ul>
45    * <li><strong>%w</strong>: wiki name</li>
46    * <li><strong>%s</strong>: space name</li>
47    * <li><strong>%p</strong>: page name</li>
48    * <li><strong>%P</strong>: page name with spaces between camel case words, i.e. "My Page"
49    * if the page name is "MyPage"</li>
50    * <li><strong>%t</strong>: page title</li>
51    * </ul>
52    * Note that if the page title is empty or not defined then it defaults to %p. This is also the case
53    * if the title cannot be retrieved for the document.
54    *
55    * The default is "%p". Some examples: "%s.%p", "%w:%s.%p".
56    *
57    * @return the format to use to display link labels when the user hasn't specified a label
58    */
59    String getLinkLabelFormat();
60   
61    /**
62    * @return the list of InterWiki definitions. Each InterWiki definition is made of an alias and a base URL.
63    * @see org.xwiki.rendering.listener.reference.InterWikiResourceReference
64    */
65    Properties getInterWikiDefinitions();
66   
67    /**
68    * @return the names of transformations to execute when rendering document content, ordered by transformation
69    * priority (highest priority first)
70    * @since 3.3M1
71    */
72    List<String> getTransformationNames();
73    }