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 739557 2009-01-31 13:54:32Z vsiveton $
34 * @since 1.0
35 */
36 public interface XdocMarkup
37 extends HtmlMarkup
38 {
39 /** XDOC namespace: "http://maven.apache.org/XDOC/2.0" target="alexandria_uri">http://maven.apache.org/XDOC/2.0" */
40 String XDOC_NAMESPACE = "http://maven.apache.org/XDOC/2.0";
41
42 /** XDOC system id: "http://maven.apache.org/xsd/xdoc-2.0.xsd" target="alexandria_uri">http://maven.apache.org/xsd/xdoc-2.0.xsd" */
43 String XDOC_SYSTEM_ID = "http://maven.apache.org/xsd/xdoc-2.0.xsd";
44
45 // ----------------------------------------------------------------------
46 // Specific Xdoc tags
47 // ----------------------------------------------------------------------
48
49 /** Xdoc tag for <code>author</code> */
50 Tag AUTHOR_TAG = new Tag()
51 {
52 /** {@inheritDoc} */
53 public String toString()
54 {
55 return "author";
56 }
57 };
58
59 /** Xdoc tag for <code>date</code> */
60 Tag DATE_TAG = new Tag()
61 {
62 /** {@inheritDoc} */
63 public String toString()
64 {
65 return "date";
66 }
67 };
68
69 /** Xdoc tag for <code>document</code> */
70 Tag DOCUMENT_TAG = new Tag()
71 {
72 /** {@inheritDoc} */
73 public String toString()
74 {
75 return "document";
76 }
77 };
78
79 /** Xdoc tag for <code>macro</code> */
80 Tag MACRO_TAG = new Tag()
81 {
82 /** {@inheritDoc} */
83 public String toString()
84 {
85 return "macro";
86 }
87 };
88
89 /** Xdoc tag for <code>properties</code> */
90 Tag PROPERTIES_TAG = new Tag()
91 {
92 /** {@inheritDoc} */
93 public String toString()
94 {
95 return "properties";
96 }
97 };
98
99 /** Xdoc tag for <code>section</code> */
100 Tag SECTION_TAG = new Tag()
101 {
102 /** {@inheritDoc} */
103 public String toString()
104 {
105 return "section";
106 }
107 };
108
109 /** Xdoc tag for <code>source</code> */
110 Tag SOURCE_TAG = new Tag()
111 {
112 /** {@inheritDoc} */
113 public String toString()
114 {
115 return "source";
116 }
117 };
118
119 /** Xdoc tag for <code>subsection</code> */
120 Tag SUBSECTION_TAG = new Tag()
121 {
122 /** {@inheritDoc} */
123 public String toString()
124 {
125 return "subsection";
126 }
127 };
128 }