maven-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From hbout...@apache.org
Subject [maven-doxia] branch master updated: [DOXIA-565] improved Doxia Document descriptor reference
Date Thu, 16 Nov 2017 13:03:46 GMT
This is an automated email from the ASF dual-hosted git repository.

hboutemy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-doxia.git


The following commit(s) were added to refs/heads/master by this push:
     new 1e62dde  [DOXIA-565] improved Doxia Document descriptor reference
1e62dde is described below

commit 1e62dde86b1bcf0bbfec37e2a5f0b2e6d178bacb
Author: Hervé Boutemy <hboutemy@apache.org>
AuthorDate: Thu Nov 16 14:03:45 2017 +0100

    [DOXIA-565] improved Doxia Document descriptor reference
---
 doxia-core/src/main/mdo/document.mdo           | 19 +++++++++---
 doxia-core/src/site/apt/using-document-xsd.apt | 42 --------------------------
 doxia-core/src/site/site.xml                   |  8 +++--
 3 files changed, 19 insertions(+), 50 deletions(-)

diff --git a/doxia-core/src/main/mdo/document.mdo b/doxia-core/src/main/mdo/document.mdo
index a338c49..aaea2f3 100644
--- a/doxia-core/src/main/mdo/document.mdo
+++ b/doxia-core/src/main/mdo/document.mdo
@@ -19,12 +19,21 @@
   under the License.
 -->
 
-<model xmlns="http://modello.codehaus.org/MODELLO/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://modello.codehaus.org/MODELLO/1.0.0 http://modello.codehaus.org/xsd/modello-1.0.0.xsd"
-  xml.namespace="http://maven.apache.org/DOCUMENT/${version}">
+<model xmlns="http://codehaus-plexus.github.io/MODELLO/1.8.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://codehaus-plexus.github.io/MODELLO/1.8.0 http://codehaus-plexus.github.io/modello/xsd/https://codehaus-plexus.github.io/modello/xsd/modello-1.8.0.xsd"
+  xml.namespace="http://maven.apache.org/DOCUMENT/${version}"
+  xml.schemaLocation="http://maven.apache.org/xsd/document-${version}.xsd">
   <id>document</id>
   <name>Document</name>
   <description><![CDATA[
-    <p>This is a reference for the Document model used in Doxia.</p>
+    <p>This is a reference for the Document descriptor model used in Doxia, also known
as <code>pdf.xml</code>.</p>
+    <p>It is composed of 3 parts:</p>
+    <ol>
+      <li>document metadata, mostly inspired by the
+        <a href="http://docs.oasis-open.org/office/v1.1/">Open Document Format Specification
v. 1.1</a></li>
+      <li>table of content,</li>
+      <li>cover description.</li>
+    </ol>
     <p>An XSD is available at:</p>
     <ul>
       <li><a href="http://maven.apache.org/xsd/document-1.0.1.xsd">http://maven.apache.org/xsd/document-1.0.1.xsd</a>.</li>
@@ -63,7 +72,7 @@
           </association>
           <identifier>true</identifier>
         </field>
-        <field>
+        <field xdoc.separator="blank">
           <name>toc</name>
           <description><![CDATA[
             The TOC (Table of Contents) information properties.
@@ -74,7 +83,7 @@
           </association>
           <identifier>true</identifier>
         </field>
-        <field>
+        <field xdoc.separator="blank">
           <name>cover</name>
           <description><![CDATA[
             The meta data to construct a cover page for the document.
diff --git a/doxia-core/src/site/apt/using-document-xsd.apt b/doxia-core/src/site/apt/using-document-xsd.apt
deleted file mode 100644
index 6fb2317..0000000
--- a/doxia-core/src/site/apt/using-document-xsd.apt
+++ /dev/null
@@ -1,42 +0,0 @@
- -----
- Using Schema Document 1.0.1
- -----
- Vincent Siveton
- ------
- 2009-01-28
- ------
-
-~~ Licensed to the Apache Software Foundation (ASF) under one
-~~ or more contributor license agreements.  See the NOTICE file
-~~ distributed with this work for additional information
-~~ regarding copyright ownership.  The ASF licenses this file
-~~ to you under the Apache License, Version 2.0 (the
-~~ "License"); you may not use this file except in compliance
-~~ with the License.  You may obtain a copy of the License at
-~~
-~~   http://www.apache.org/licenses/LICENSE-2.0
-~~
-~~ Unless required by applicable law or agreed to in writing,
-~~ software distributed under the License is distributed on an
-~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-~~ KIND, either express or implied.  See the License for the
-~~ specific language governing permissions and limitations
-~~ under the License.
-
-~~ NOTE: For help with the syntax of this file, see:
-~~ http://maven.apache.org/doxia/references/apt-format.html
-
-Using Schema Document 1.0.1
-
-  The Decoration XSD is located {{{http://maven.apache.org/xsd/document-1.0.1.xsd}here}}.
-
-  Your favorite IDE probably supports XSD schema's for .xml files. You need to specify the
following:
-
-+-----+
-<document xmlns="http://maven.apache.org/DOCUMENT/1.0.1"
-  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-  xsi:schemaLocation="http://maven.apache.org/DOCUMENT/1.0.1 http://maven.apache.org/xsd/document-1.0.1.xsd"
-  outputName="...">
-...
-</document>
-+-----+
diff --git a/doxia-core/src/site/site.xml b/doxia-core/src/site/site.xml
index 03a252c..5af18f4 100644
--- a/doxia-core/src/site/site.xml
+++ b/doxia-core/src/site/site.xml
@@ -35,9 +35,11 @@
       <!--item name="FAQ" href="faq.html"/-->
     </menu>
 
-    <menu name="Document Schema">
-      <item name="Reference" href="document.html"/>
-      <item name="Using Document Schema" href="using-document-xsd.html"/>
+    <menu name="Descriptors Reference">
+      <item name="Document Model Reference" href="document.html"/>
+    </menu>
+
+    <menu name="Development">
       <item name="Using RandomAccessSink" href="using-randomaccesssink.html"/>
     </menu>
 

-- 
To stop receiving notification emails like this one, please contact
['"commits@maven.apache.org" <commits@maven.apache.org>'].

Mime
View raw message