001package org.apache.maven.doxia.module.xdoc; 002 003/* 004 * Licensed to the Apache Software Foundation (ASF) under one 005 * or more contributor license agreements. See the NOTICE file 006 * distributed with this work for additional information 007 * regarding copyright ownership. The ASF licenses this file 008 * to you under the Apache License, Version 2.0 (the 009 * "License"); you may not use this file except in compliance 010 * with the License. You may obtain a copy of the License at 011 * 012 * http://www.apache.org/licenses/LICENSE-2.0 013 * 014 * Unless required by applicable law or agreed to in writing, 015 * software distributed under the License is distributed on an 016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 017 * KIND, either express or implied. See the License for the 018 * specific language governing permissions and limitations 019 * under the License. 020 */ 021 022import javax.swing.text.html.HTML.Tag; 023 024import org.apache.maven.doxia.markup.HtmlMarkup; 025 026/** 027 * List of <code>Xdoc</code> markups. 028 * <br/> 029 * Xdoc uses several {@link javax.swing.text.html.HTML.Tag} and {@link javax.swing.text.html.HTML.Attribute} 030 * as markups and custom tags. 031 * 032 * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a> 033 * @version $Id$ 034 * @since 1.0 035 */ 036@SuppressWarnings( "checkstyle:interfaceistype" ) 037public interface XdocMarkup 038 extends HtmlMarkup 039{ 040 /** XDOC namespace: "http://maven.apache.org/XDOC/2.0" */ 041 String XDOC_NAMESPACE = "http://maven.apache.org/XDOC/2.0"; 042 043 /** XDOC system id: "http://maven.apache.org/xsd/xdoc-2.0.xsd" */ 044 String XDOC_SYSTEM_ID = "http://maven.apache.org/xsd/xdoc-2.0.xsd"; 045 046 // ---------------------------------------------------------------------- 047 // Specific Xdoc tags 048 // ---------------------------------------------------------------------- 049 050 /** Xdoc tag for <code>author</code> */ 051 Tag AUTHOR_TAG = new Tag() 052 { 053 /** {@inheritDoc} */ 054 public String toString() 055 { 056 return "author"; 057 } 058 }; 059 060 /** Xdoc tag for <code>date</code> */ 061 Tag DATE_TAG = new Tag() 062 { 063 /** {@inheritDoc} */ 064 public String toString() 065 { 066 return "date"; 067 } 068 }; 069 070 /** Xdoc tag for <code>document</code> */ 071 Tag DOCUMENT_TAG = new Tag() 072 { 073 /** {@inheritDoc} */ 074 public String toString() 075 { 076 return "document"; 077 } 078 }; 079 080 /** Xdoc tag for <code>macro</code> */ 081 Tag MACRO_TAG = new Tag() 082 { 083 /** {@inheritDoc} */ 084 public String toString() 085 { 086 return "macro"; 087 } 088 }; 089 090 /** Xdoc tag for <code>properties</code> */ 091 Tag PROPERTIES_TAG = new Tag() 092 { 093 /** {@inheritDoc} */ 094 public String toString() 095 { 096 return "properties"; 097 } 098 }; 099 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}