1 package org.apache.maven.doxia.module.xdoc;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import javax.swing.text.html.HTML.Tag;
23
24 import org.apache.maven.doxia.markup.HtmlMarkup;
25
26 /**
27 * List of <code>Xdoc</code> markups.
28 * <br/>
29 * Xdoc uses several {@link javax.swing.text.html.HTML.Tag} and {@link javax.swing.text.html.HTML.Attribute}
30 * as markups and custom tags.
31 *
32 * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
33 * @version $Id: XdocMarkup.java 1633964 2014-10-23 22:01:01Z hboutemy $
34 * @since 1.0
35 */
36 @SuppressWarnings( "checkstyle:interfaceistype" )
37 public interface XdocMarkup
38 extends HtmlMarkup
39 {
40 /** XDOC namespace: "http://maven.apache.org/XDOC/2.0" */
41 String XDOC_NAMESPACE = "http://maven.apache.org/XDOC/2.0";
42
43 /** XDOC system id: "http://maven.apache.org/xsd/xdoc-2.0.xsd" */
44 String XDOC_SYSTEM_ID = "http://maven.apache.org/xsd/xdoc-2.0.xsd";
45
46 // ----------------------------------------------------------------------
47 // Specific Xdoc tags
48 // ----------------------------------------------------------------------
49
50 /** Xdoc tag for <code>author</code> */
51 Tag AUTHOR_TAG = new Tag()
52 {
53 /** {@inheritDoc} */
54 public String toString()
55 {
56 return "author";
57 }
58 };
59
60 /** Xdoc tag for <code>date</code> */
61 Tag DATE_TAG = new Tag()
62 {
63 /** {@inheritDoc} */
64 public String toString()
65 {
66 return "date";
67 }
68 };
69
70 /** Xdoc tag for <code>document</code> */
71 Tag DOCUMENT_TAG = new Tag()
72 {
73 /** {@inheritDoc} */
74 public String toString()
75 {
76 return "document";
77 }
78 };
79
80 /** Xdoc tag for <code>macro</code> */
81 Tag MACRO_TAG = new Tag()
82 {
83 /** {@inheritDoc} */
84 public String toString()
85 {
86 return "macro";
87 }
88 };
89
90 /** Xdoc tag for <code>properties</code> */
91 Tag PROPERTIES_TAG = new Tag()
92 {
93 /** {@inheritDoc} */
94 public String toString()
95 {
96 return "properties";
97 }
98 };
99
100 /** Xdoc tag for <code>section</code> */
101 Tag SECTION_TAG = new Tag()
102 {
103 /** {@inheritDoc} */
104 public String toString()
105 {
106 return "section";
107 }
108 };
109
110 /** Xdoc tag for <code>source</code> */
111 Tag SOURCE_TAG = new Tag()
112 {
113 /** {@inheritDoc} */
114 public String toString()
115 {
116 return "source";
117 }
118 };
119
120 /** Xdoc tag for <code>subsection</code> */
121 Tag SUBSECTION_TAG = new Tag()
122 {
123 /** {@inheritDoc} */
124 public String toString()
125 {
126 return "subsection";
127 }
128 };
129 }