You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by sc...@apache.org on 2006/11/13 21:22:45 UTC

svn commit: r474489 - in /incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/uima/masters: ./ common_book_info.xml overview_and_setup.xml reference.xml tools.xml tutorials_and_guides.xml xinclude.mod

Author: schor
Date: Mon Nov 13 12:22:44 2006
New Revision: 474489

URL: http://svn.apache.org/viewvc?view=rev&rev=474489
Log:
cleanup from Jira issues uima-3 and uima-5: some reorg, a couple of chapters more or less converted to docbook

Added:
    incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/uima/masters/
    incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/uima/masters/common_book_info.xml
    incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/uima/masters/overview_and_setup.xml
    incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/uima/masters/reference.xml
    incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/uima/masters/tools.xml
    incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/uima/masters/tutorials_and_guides.xml
    incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/uima/masters/xinclude.mod

Added: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/uima/masters/common_book_info.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/uima/masters/common_book_info.xml?view=auto&rev=474489
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/uima/masters/common_book_info.xml (added)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/uima/masters/common_book_info.xml Mon Nov 13 12:22:44 2006
@@ -0,0 +1,77 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
+<!--
+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.
+-->  
+<bookinfo>
+    <!--  instead of copyright, license statment per Apache legal
+       THIS COPYRIGHT IS COMMENTED OUT
+    <copyright>
+      <year>2006</year>
+
+      <holder>The Apache Software Foundation</holder>
+    </copyright>
+    -->
+
+    <releaseinfo>Version 2.0</releaseinfo>
+
+    <productname>UIMA</productname>
+
+    <authorgroup>
+      <corpauthor>The Apache UIMA Development Community</corpauthor>
+    </authorgroup>
+
+ <!--
+    <mediaobject>
+      <imageobject>
+        <imagedata fileref="images/UIMAlogoLarge.png"/>
+      </imageobject>
+    </mediaobject>
+ -->
+    <legalnotice>
+      <warning>
+        <title>Warning and Disclaimer</title>
+        <para>The ASF licenses this documentation
+           to you under the Apache License, Version 2.0 (the
+           "License"); you may not use this documentation except in compliance
+           with the License.  You may obtain a copy of the License at
+           </para>
+           <para>
+             http://www.apache.org/licenses/LICENSE-2.0
+           </para>
+           <para>
+           Unless required by applicable law or agreed to in writing,
+           this documentation and its contents are distributed under the License 
+           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.
+           </para>
+      </warning>
+      <note>
+        <title>Trademarks</title>
+        <para>All terms mentioned in the text that are known to be trademarks or 
+        service marks have been appropriately capitalized.  Use of such terms
+        in this book should not be regarded as affecting the validity of the
+        the trademark or service mark.
+        </para>
+      </note>
+    </legalnotice>
+  </bookinfo>
\ No newline at end of file

Added: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/uima/masters/overview_and_setup.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/uima/masters/overview_and_setup.xml?view=auto&rev=474489
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/uima/masters/overview_and_setup.xml (added)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/uima/masters/overview_and_setup.xml Mon Nov 13 12:22:44 2006
@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
+  <!ENTITY % xinclude SYSTEM "xinclude.mod">
+  %xinclude;
+  ]>
+<!--
+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.
+-->
+<book lang="en" >
+  <title>UIMA SDK Overview and Setup Guide</title>
+  <xi:include href="common_book_info.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+
+  <toc/>
+  <!--
+  <preface>
+    <xi:include href="../overview_and_setup/acknowledgements.xml"/>
+  </preface>
+    -->
+  <xi:include href="../overview_and_setup/SDK_overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+  <xi:include href="../overview_and_setup/conceptual_overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+  <xi:include href="../overview_and_setup/SDK_installation_and_setup.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+  <xi:include href="../overview_and_setup/FAQs.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+  <xi:include href="../overview_and_setup/glossary.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+  <xi:include href="notices_and_trademarks.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+  </book>

Added: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/uima/masters/reference.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/uima/masters/reference.xml?view=auto&rev=474489
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/uima/masters/reference.xml (added)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/uima/masters/reference.xml Mon Nov 13 12:22:44 2006
@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
+<!--
+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.
+-->
+<book lang="en" xmlns:xi="http://www.w3.org/2001/XInclude">
+  <title>UIMA SDK Reference</title>
+  <xi:include href="common_book_info.xml"/>
+
+  <toc/>
+  
+  <xi:include href="reference/JavaDocs.xml"/>
+  <xi:include href="reference/XML_Component_Descriptor.xml"/>
+  <xi:include href="reference/XML_Collection_Processing_Engine_Descriptor.xml"/>
+  <xi:include href="reference/CAS.xml"/>
+  <xi:include href="reference/JCas.xml"/>
+  <xi:include href="reference/PEAR.xml"/>
+  <xi:include href="reference/XMI_CAS_Serialization.xml"/>
+  <xi:include href="Notices_and_Trademarks.xml"/>
+  </book>

Added: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/uima/masters/tools.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/uima/masters/tools.xml?view=auto&rev=474489
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/uima/masters/tools.xml (added)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/uima/masters/tools.xml Mon Nov 13 12:22:44 2006
@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
+<!--
+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.
+-->
+<book lang="en" xmlns:xi="http://www.w3.org/2001/XInclude">
+  <title>UIMA SDK Tools Guide and Reference</title>
+  <para>This book describes the tools that are part of the 
+  UIMA distribution, and how to use them.
+  </para>
+  <xi:include href="common_book_info.xml"/>
+
+  <toc/> 
+  <xi:include href="tools/Component_Descriptor_Editor.xml"/>
+  <xi:include href="tools/Collection_Processing_Engine_Configurator.xml"/>
+  <xi:include href="tools/Eclipse_UIMA_Component_Launcher.xml"/>
+  <xi:include href="tools/PEAR_Packager.xml"/>
+  <xi:include href="tools/PEAR_Installer.xml"/>
+  <xi:include href="tools/PEAR_Merger.xml"/>
+  <xi:include href="tools/Document_Analyzer.xml"/>
+  <xi:include href="tools/JCasGen.xml"/>
+  <xi:include href="tools/XCAS_Annotation_viewer.xml"/>
+  <xi:include href="Notices_and_Trademarks.xml"/>
+  </book>

Added: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/uima/masters/tutorials_and_guides.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/uima/masters/tutorials_and_guides.xml?view=auto&rev=474489
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/uima/masters/tutorials_and_guides.xml (added)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/uima/masters/tutorials_and_guides.xml Mon Nov 13 12:22:44 2006
@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
+<!--
+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.
+-->
+<book lang="en" xmlns:xi="http://www.w3.org/2001/XInclude">
+  <title>UIMA SDK Tutorial and Developers' Guides</title>
+  <xi:include href="common_book_info.xml"/>
+
+  <toc/>
+  
+  <xi:include href="Tutorial_Annotator_and_Analysis_Engine.xml"/>
+  <xi:include href="Tutorial_Collection_Processing_Engine.xml"/>
+  <xi:include href="guide/Applications.xml"/>
+  <xi:include href="guide/Sofas.xml"/>
+  <xi:include href="guide/Multiple_Views.xml"/>
+  <xi:include href="guide/CAS_Multiplier.xml"/>
+  <xi:include href="guide/XMI_and_EMF_Interoperability.xml"/>
+  <xi:include href="Notices_and_Trademarks.xml"/>
+  </book>

Added: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/uima/masters/xinclude.mod
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/uima/masters/xinclude.mod?view=auto&rev=474489
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/uima/masters/xinclude.mod (added)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/uima/masters/xinclude.mod Mon Nov 13 12:22:44 2006
@@ -0,0 +1,13 @@
+<!ELEMENT xi:include (xi:fallback?) >
+<!ATTLIST xi:include
+  xmlns:xi   CDATA        #FIXED      "http://www.w3.org/2001/XInclude"
+  href       CDATA        #REQUIRED
+  parse      (xml|text)   "xml"
+  encoding   CDATA        #IMPLIED >
+
+<!ELEMENT xi:fallback ANY>
+<!ATTLIST xi:fallback
+  xmlns:xi   CDATA        #FIXED      "http://www.w3.org/2001/XInclude" >
+
+<!ENTITY % local.chapter.class "| xi:include">
+<!ENTITY % local.book.class "| xi:include">