Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
MacroTransformationConfiguration | 37 | 0 | - | 0 | 0 |
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.transformation.macro; | |
21 | ||
22 | import java.util.Properties; | |
23 | ||
24 | import org.xwiki.component.annotation.Role; | |
25 | ||
26 | /** | |
27 | * Configuration properties for the Macro Transformation module. | |
28 | * <p> | |
29 | * You can override the default values for each of the configuration properties below by defining them in XWiki's | |
30 | * global configuration file using a prefix of "rendering.transformation.macro." followed by the property name. | |
31 | * For example: <code>rendering.transformation.macro.categories = toc:my Category</code> | |
32 | * | |
33 | * @version $Id: 79e3993d1bf4fd7fe3fb7c25dd2701465d2889c1 $ | |
34 | * @since 2.6RC1 | |
35 | */ | |
36 | @Role | |
37 | public interface MacroTransformationConfiguration | |
38 | { | |
39 | /** | |
40 | * @return the category names to use for the macros. These are the categories under which they'll be listed | |
41 | * in UIs for example. If a category for a macro is null then the category defined in the macro | |
42 | * descriptor (ie defined by the macro author) will be used | |
43 | */ | |
44 | Properties getCategories(); | |
45 | } |