forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cross...@apache.org
Subject svn commit: r230528 - in /forrest/trunk: main/fresh-site/src/documentation/content/xdocs/ main/fresh-site/src/documentation/content/xdocs/samples/ main/fresh-site/src/documentation/resources/schema/ main/webapp/resources/schema/ main/webapp/resources/s...
Date Sat, 06 Aug 2005 06:31:32 GMT
Author: crossley
Date: Fri Aug  5 23:31:16 2005
New Revision: 230528

URL: http://svn.apache.org/viewcvs?rev=230528&view=rev
Log:
Use sets of symbols as xml entities for character replacement.

Added:
    forrest/trunk/main/fresh-site/src/documentation/content/xdocs/samples/xml-entities.xml
  (with props)
    forrest/trunk/main/fresh-site/src/documentation/resources/schema/symbols-project-v10.ent
  (with props)
    forrest/trunk/main/webapp/resources/schema/entity/symbols-core-v10.ent   (with props)
Modified:
    forrest/trunk/main/fresh-site/src/documentation/content/xdocs/site.xml
    forrest/trunk/main/fresh-site/src/documentation/resources/schema/catalog.xcat
    forrest/trunk/main/webapp/resources/schema/catalog.forrest
    forrest/trunk/main/webapp/resources/schema/catalog.forrest.xcat
    forrest/trunk/main/webapp/resources/schema/dtd/common-charents-v10.mod
    forrest/trunk/site-author/content/xdocs/docs_0_80/faq.xml
    forrest/trunk/site-author/status.xml

Added: forrest/trunk/main/fresh-site/src/documentation/content/xdocs/samples/xml-entities.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/main/fresh-site/src/documentation/content/xdocs/samples/xml-entities.xml?rev=230528&view=auto
==============================================================================
--- forrest/trunk/main/fresh-site/src/documentation/content/xdocs/samples/xml-entities.xml
(added)
+++ forrest/trunk/main/fresh-site/src/documentation/content/xdocs/samples/xml-entities.xml
Fri Aug  5 23:31:16 2005
@@ -0,0 +1,82 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Copyright 2002-2004 The Apache Software Foundation or its licensors,
+  as applicable.
+
+  Licensed 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.
+-->
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd"
[
+<!ENTITY % symbols-project
+    PUBLIC "-//Apache Forrest//ENTITIES Symbols Project v1.0//EN"
+    "symbols-project-v10.ent"> 
+  %symbols-project;
+]>
+<document> 
+  <header> 
+    <title>Using XML entities for character replacements</title> 
+  </header> 
+  <body> 
+    <p>
+      All of the normal xml character entities are available for use
+      in your source documents.
+      So you can use "<code>&amp;trade;</code>"
+      for the trademark symbol (&trade;)
+      and use "<code>&amp;ouml;</code>"
+      for special accents (&ouml;).
+    </p>
+    <p>
+      Forrest also has some default sets of symbols. There is one set
+      for the core of Forrest. These are automatically available
+      for use in the "document-v*" series of document types.
+      (If you want to use them in another document type, then you
+      need to specify them in the document type declaration of your
+      xml instance documents or in your custom DTD. See below.)
+    </p>
+    <p>
+      For example,
+      use "<code>&amp;for-s;</code>" to represent the strong
+      text string "&for-s;". See the list of available symbols at
+      <code>main/webapp/resources/schema/entity/symbols-core-v10.ent</code>
+      which shows that that example entity was declared as
+      <code><![CDATA[<strong>Apache Forrest</strong>]]></code>.
+    </p>
+    <p>
+      You can supply lists of symbols for your own project too.
+      Create a fresh site with 'forrest seed' and see the set
+      <code>src/documentation/resources/schema/symbols-project-v10.ent</code>
+    </p>
+    <p>
+      For example,
+      use "<code>&amp;myp-t;</code>" to represent the project name
+      together with trademark symbol "&myp-t;".
+    </p>
+    <p>
+      The set of project symbols is already configured. To use the symbols
+      in your documents, add to the document type declaration. For example,
+      see the source for this document
+      (<code>src/documentation/content/xdocs/samples/xml-entites.xml</code>)
+      which declares the project symbol set ...
+    </p>
+    <source><![CDATA[
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd"
[
+<!ENTITY % symbols-project
+    PUBLIC "-//Apache Forrest//ENTITIES Symbols Project v1.0//EN"
+    "symbols-project-v10.ent"> 
+  %symbols-project;
+]>
+<document> 
+  ...
+]]></source>
+  </body>
+</document>

Propchange: forrest/trunk/main/fresh-site/src/documentation/content/xdocs/samples/xml-entities.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: forrest/trunk/main/fresh-site/src/documentation/content/xdocs/site.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/main/fresh-site/src/documentation/content/xdocs/site.xml?rev=230528&r1=230527&r2=230528&view=diff
==============================================================================
--- forrest/trunk/main/fresh-site/src/documentation/content/xdocs/site.xml (original)
+++ forrest/trunk/main/fresh-site/src/documentation/content/xdocs/site.xml Fri Aug  5 23:31:16
2005
@@ -65,6 +65,8 @@
     <sample-custom label="Custom Schema" href="customSchema.html" 
       description="Custom XML schema and doctypes"/>
     <custom-example href="custom.html" description="A custom XML file"/>
+    <xml-entities label="XML entities" href="xml-entities.html" 
+      description="Using XML entities for character replacements"/>
     <faq label="FAQ" href="faq.html" description="Frequently Asked Questions" />
     <locationmap label="Locationmap" href="locationmap/index.html" description="Locationmaps
allow the user URL space to be different from the storage URL Space"/>
     <subdir label="Subdir" href="subdir/">

Modified: forrest/trunk/main/fresh-site/src/documentation/resources/schema/catalog.xcat
URL: http://svn.apache.org/viewcvs/forrest/trunk/main/fresh-site/src/documentation/resources/schema/catalog.xcat?rev=230528&r1=230527&r2=230528&view=diff
==============================================================================
--- forrest/trunk/main/fresh-site/src/documentation/resources/schema/catalog.xcat (original)
+++ forrest/trunk/main/fresh-site/src/documentation/resources/schema/catalog.xcat Fri Aug
 5 23:31:16 2005
@@ -22,8 +22,12 @@
 <catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"
          prefer="public">
 
-<!-- Download  -->
+<!-- Example catalog entry -->
 <public publicId="-//Acme//DTD Hello Document V1.0//EN"
         uri="hello-v10.dtd"/>
+
+<!-- Sets of symbols. e.g. for string replacements -->
+<public publicId="-//Apache Forrest//ENTITIES Symbols Project v1.0//EN"
+        uri="symbols-project-v10.ent"/>
 
 </catalog>

Added: forrest/trunk/main/fresh-site/src/documentation/resources/schema/symbols-project-v10.ent
URL: http://svn.apache.org/viewcvs/forrest/trunk/main/fresh-site/src/documentation/resources/schema/symbols-project-v10.ent?rev=230528&view=auto
==============================================================================
--- forrest/trunk/main/fresh-site/src/documentation/resources/schema/symbols-project-v10.ent
(added)
+++ forrest/trunk/main/fresh-site/src/documentation/resources/schema/symbols-project-v10.ent
Fri Aug  5 23:31:16 2005
@@ -0,0 +1,9 @@
+<!-- Typical invocation:
+  <!ENTITY % symbols-project
+      PUBLIC "-//Apache Forrest//ENTITIES Symbols Project v1.0//EN"
+      "symbols-project-v10.ent">
+  %symbols-project;
+-->
+<!ENTITY myp "My Project Name">
+<!ENTITY myp-s "<strong>My Project Name</strong>">
+<!ENTITY myp-t "My Project Name&trade;">

Propchange: forrest/trunk/main/fresh-site/src/documentation/resources/schema/symbols-project-v10.ent
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: forrest/trunk/main/webapp/resources/schema/catalog.forrest
URL: http://svn.apache.org/viewcvs/forrest/trunk/main/webapp/resources/schema/catalog.forrest?rev=230528&r1=230527&r2=230528&view=diff
==============================================================================
--- forrest/trunk/main/webapp/resources/schema/catalog.forrest (original)
+++ forrest/trunk/main/webapp/resources/schema/catalog.forrest Fri Aug  5 23:31:16 2005
@@ -116,6 +116,10 @@
 PUBLIC "ISO 8879:1986//ENTITIES Added Latin 1//EN//XML"
        "entity/ISOlat1.pen"
 
+<!-- Sets of symbols. e.g. for string replacements -->
+PUBLIC "-//Apache Forrest//ENTITIES Symbols Core v1.0//EN"
+       "entity/symbols-core-v10.ent"
+
 -- Old DTDs --
 PUBLIC "-//APACHE//DTD Skin Configuration V0.6-2//EN"
         "dtd/skinconfig-v06-2.dtd"

Modified: forrest/trunk/main/webapp/resources/schema/catalog.forrest.xcat
URL: http://svn.apache.org/viewcvs/forrest/trunk/main/webapp/resources/schema/catalog.forrest.xcat?rev=230528&r1=230527&r2=230528&view=diff
==============================================================================
--- forrest/trunk/main/webapp/resources/schema/catalog.forrest.xcat (original)
+++ forrest/trunk/main/webapp/resources/schema/catalog.forrest.xcat Fri Aug  5 23:31:16 2005
@@ -63,7 +63,11 @@
         uri="dtd/projectInfo/developers-v10.dtd"/>
 <public publicId="-//APACHE//ENTITIES Developers V1.0//EN"
         uri="dtd/projectInfo/developers-v10.mod"/>
-        
+
+<!-- Sets of symbols. e.g. for string replacements -->
+<public publicId="-//Apache Forrest//ENTITIES Symbols Core v1.0//EN"
+        uri="entity/symbols-core-v10.ent"/>
+
 <!-- New unfinished DTDs -->
 <public publicId="-//APACHE//DTD Skin Configuration V0.7-1//EN"
         uri="dtd/skinconfig-v07-1.dtd"/>

Modified: forrest/trunk/main/webapp/resources/schema/dtd/common-charents-v10.mod
URL: http://svn.apache.org/viewcvs/forrest/trunk/main/webapp/resources/schema/dtd/common-charents-v10.mod?rev=230528&r1=230527&r2=230528&view=diff
==============================================================================
--- forrest/trunk/main/webapp/resources/schema/dtd/common-charents-v10.mod (original)
+++ forrest/trunk/main/webapp/resources/schema/dtd/common-charents-v10.mod Fri Aug  5 23:31:16
2005
@@ -71,5 +71,14 @@
 %ISOdia;
 
 <!-- =============================================================== -->
+<!-- Sets of symbols. e.g. for string replacements -->
+<!-- =============================================================== -->
+
+<!ENTITY % symbols-core
+      PUBLIC "-//Apache Forrest//ENTITIES Symbols Core v1.0//EN"
+      "symbols-core-v10.ent">
+  %symbols-core;
+
+<!-- =============================================================== -->
 <!-- End of DTD -->
 <!-- =============================================================== -->

Added: forrest/trunk/main/webapp/resources/schema/entity/symbols-core-v10.ent
URL: http://svn.apache.org/viewcvs/forrest/trunk/main/webapp/resources/schema/entity/symbols-core-v10.ent?rev=230528&view=auto
==============================================================================
--- forrest/trunk/main/webapp/resources/schema/entity/symbols-core-v10.ent (added)
+++ forrest/trunk/main/webapp/resources/schema/entity/symbols-core-v10.ent Fri Aug  5 23:31:16
2005
@@ -0,0 +1,8 @@
+<!-- Typical invocation:
+  <!ENTITY % symbols-core
+      PUBLIC "-//Apache Forrest//ENTITIES Symbols Core v1.0//EN"
+      "symbols-core-v10.ent">
+  %symbols-core;
+-->
+<!ENTITY for "Apache Forrest">
+<!ENTITY for-s "<strong>Apache Forrest</strong>">

Propchange: forrest/trunk/main/webapp/resources/schema/entity/symbols-core-v10.ent
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: forrest/trunk/site-author/content/xdocs/docs_0_80/faq.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/site-author/content/xdocs/docs_0_80/faq.xml?rev=230528&r1=230527&r2=230528&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs_0_80/faq.xml (original)
+++ forrest/trunk/site-author/content/xdocs/docs_0_80/faq.xml Fri Aug  5 23:31:16 2005
@@ -367,6 +367,20 @@
             resources</link>. </p>
       </answer>
     </faq>
+    <faq id="xml-entities">
+      <question>How to use XML entities, for example string
+        replacement?</question>
+      <answer>
+        <p>
+          A set of symbols is available. See the demonstration
+          in a fresh 'forrest seed' site (at samples/xml-entities.html).
+          For example, use "<code>&amp;myp-t;</code>" to represent the
+          project name together with trademark symbol
+          "My Project Name&trade;".
+          Avoid lengthy typing and potential spelling errors.
+        </p>
+      </answer>
+    </faq>
     <faq id="cleanSite">
       <question> How can I make Forrest properly clean up the build/site-directory?
</question>
       <answer>

Modified: forrest/trunk/site-author/status.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/site-author/status.xml?rev=230528&r1=230527&r2=230528&view=diff
==============================================================================
--- forrest/trunk/site-author/status.xml (original)
+++ forrest/trunk/site-author/status.xml Fri Aug  5 23:31:16 2005
@@ -131,6 +131,15 @@
         <link href="site:v0.80//upgrading_08">upgrading to v0.8</link>
       </action>
 
+      <action context="code" type="add" dev="DC">
+        Use sets of symbols as xml entities for character replacement.
+        There is a core set and each project can define a set.
+        For example, use "<code>&amp;myp-t;</code>" to represent the
+        project name together with trademark symbol
+        "My Project Name&trade;".
+        See <a href="faq.html#xml-entities">FAQ</a>.
+      </action>
+
       <action context="code" type="add" dev="RDG">
         Plugins can now define their own *.xconf file to add configuration 
         information to cocoon.xconf. Simply place your *.xconf file in 
@@ -142,7 +151,7 @@
         "forrest seedBusiness". The later will ask a number of questions about the site
         being seeded (business name, description etc.) and will create a very simple site
         designed for business. To quickly see the results, i.e. avoid
-        answeriung the questions, do "forrest seedTestBusiness". More seed sites will be
added
+        answering the questions, do "forrest seedTestBusiness". More seed sites will be added
         in the future.
       </action>
        



Mime
View raw message