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