You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by pp...@apache.org on 2005/12/09 12:16:03 UTC

svn commit: r355449 - in /incubator/jackrabbit/trunk/jackrabbit/src/site/xdoc: doc/firststeps.xml doc/index.xml doc/nodetype/cnd.xml doc/nodetype/index.xml navigation.xml

Author: ppiegaze
Date: Fri Dec  9 03:15:48 2005
New Revision: 355449

URL: http://svn.apache.org/viewcvs?rev=355449&view=rev
Log:
fixed minor formatting; first steps--> first hops :-) ; cnd noataion page errors fixed. added 'Home'to navigation, 'About' moved to bottom of nav.

Modified:
    incubator/jackrabbit/trunk/jackrabbit/src/site/xdoc/doc/firststeps.xml
    incubator/jackrabbit/trunk/jackrabbit/src/site/xdoc/doc/index.xml
    incubator/jackrabbit/trunk/jackrabbit/src/site/xdoc/doc/nodetype/cnd.xml
    incubator/jackrabbit/trunk/jackrabbit/src/site/xdoc/doc/nodetype/index.xml
    incubator/jackrabbit/trunk/jackrabbit/src/site/xdoc/navigation.xml

Modified: incubator/jackrabbit/trunk/jackrabbit/src/site/xdoc/doc/firststeps.xml
URL: http://svn.apache.org/viewcvs/incubator/jackrabbit/trunk/jackrabbit/src/site/xdoc/doc/firststeps.xml?rev=355449&r1=355448&r2=355449&view=diff
==============================================================================
--- incubator/jackrabbit/trunk/jackrabbit/src/site/xdoc/doc/firststeps.xml (original)
+++ incubator/jackrabbit/trunk/jackrabbit/src/site/xdoc/doc/firststeps.xml Fri Dec  9 03:15:48 2005
@@ -17,11 +17,11 @@
   -->
 <document>
  <properties>
-  <title>First Steps</title>
+  <title>First Hops</title>
  </properties>
 
  <body>
-  <section name="First Steps">
+  <section name="First Hops">
    <p>
      This is a short hands-on introduction to Jackrabbit and the features
      of the JCR API. See the rest of the Jackrabbit web site and the JCR

Modified: incubator/jackrabbit/trunk/jackrabbit/src/site/xdoc/doc/index.xml
URL: http://svn.apache.org/viewcvs/incubator/jackrabbit/trunk/jackrabbit/src/site/xdoc/doc/index.xml?rev=355449&r1=355448&r2=355449&view=diff
==============================================================================
--- incubator/jackrabbit/trunk/jackrabbit/src/site/xdoc/doc/index.xml (original)
+++ incubator/jackrabbit/trunk/jackrabbit/src/site/xdoc/doc/index.xml Fri Dec  9 03:15:48 2005
@@ -23,11 +23,10 @@
 
 <section name="Getting Started">
 <p>
-Since Jackrabbit is currently not yet released the quickest way to get 
-your hands on a running Jackrabbit instance are found in the 
+Since Jackrabbit is not yet released, in order to get your hands on a running Jackrabbit instance
+you have to download and build it yourself. Directions for doing so can be found in the 
 <a href="building.html">Building Jackrabbit</a> section.
-Once Jackrabbit is up and running you may try your 
-<a href="firststeps.html">first Steps</a> with JCR.
+Once Jackrabbit is up and running, you can take your <a href="firststeps.html">first hops</a>.
 </p>
 </section>
 <section name="Content Repository for Java Technology API (JCR)">

Modified: incubator/jackrabbit/trunk/jackrabbit/src/site/xdoc/doc/nodetype/cnd.xml
URL: http://svn.apache.org/viewcvs/incubator/jackrabbit/trunk/jackrabbit/src/site/xdoc/doc/nodetype/cnd.xml?rev=355449&r1=355448&r2=355449&view=diff
==============================================================================
--- incubator/jackrabbit/trunk/jackrabbit/src/site/xdoc/doc/nodetype/cnd.xml (original)
+++ incubator/jackrabbit/trunk/jackrabbit/src/site/xdoc/doc/nodetype/cnd.xml Fri Dec  9 03:15:48 2005
@@ -48,7 +48,7 @@
 // This is a mixin node type
 mixin
 
-// A property called 'ex:property' of type STRING
+// Nodes of this node type have a property called 'ex:property' of type STRING
 - ex:property (string)
 
 // The default values for this
@@ -70,17 +70,17 @@
 // The constraint settings are...
 < 'constraint1', 'constraint2'
 
-// A child node called ns:node which must be of
+// Nodes of this node type have a child node called ns:node which must be of
 // at least the node types ns:reqType1 and ns:reqType2
 + ns:node (ns:reqType1, ns:reqType2)
 
-// with default primary node type is...
+// and the default primary node type of the child node is...
 = ns:defaultType
 
-// This node is...
+// This child node is...
 mandatory autocreated protected
 
-// supports same name siblings
+// and supports same name siblings
 multiple
 
 // and has an on-parent-version setting of ...
@@ -93,7 +93,7 @@
 [ns:NodeType] > ns:ParentType1, ns:ParentType2
   orderable mixin
   - ex:property (string)
-= 'default1', 'default2'
+  = 'default1', 'default2'
     primary mandatory autocreated protected multiple
     version
     < 'constraint1', 'constraint2'
@@ -112,7 +112,7 @@
         </section>
         <section name="Grammar">
             <p>
-                The following grammar defines the CND notation. Terminal symbols are bold and in double quotes.
+                The following grammar defines the CND notation. Terminal symbols are in double quotes.
             </p>
 <source><![CDATA[cnd ::= {ns_mapping | node_type_def}
 
@@ -195,8 +195,8 @@
 <source><![CDATA[cnd ::= {ns_mapping | node_type_def}]]></source>    
         <p>        
             A CND consists of zero or more blocks, each of which is either namespace declaration or 
-            a node type definition. Namespace prefixes referenced in a node type definition block must 
-            be declared in a preceding namespace declaration block.
+            a node type definition. Namespace prefixes referenced in a node type definition block 
+            must be declared in a preceding namespace declaration block.
         </p>
         <subsection name="Namespace Declaration">
 <source><![CDATA[ns_mapping ::= "<" prefix "=" uri ">"
@@ -299,10 +299,12 @@
         </subsection>
         <subsection name="Default Values">
 <source><![CDATA[default_values ::= "=" string_list]]></source>
-        The default value or values, in the case of a multi-value property, are indicated 
-        by an equal sign followed by either a single value in string form or a comma-delimited 
-        list of values. The values may be single-quoted. If the default value definition is 
-        missing then no default value is set.
+            <p>
+                The default value or values, in the case of a multi-value property, are indicated 
+                by an equal sign followed by either a single value in string form or a comma-delimited 
+                list of values. The values may be single-quoted. If the default value definition is 
+                missing then no default value is set.
+            </p>
         </subsection>
         <subsection name="Attributes">
 <source><![CDATA[attributes ::= "primary" | "pri" | "!" |
@@ -389,18 +391,18 @@
                "IGNORE" | "Ignore" | "ignore" |
                "ABORT" | "Abort" | "abort"]]></source>
             <p>
-                The attribute indicators describe the characteristics of the property. 
+                The attribute indicators describe the characteristics of the child node. 
                 The presence of an attribute keyword indicates that the corresponding 
-                characteristic applies to this property. It's absence indicates that 
+                characteristic applies to this child node. It's absence indicates that 
                 the corresponding characteristic does not apply.
             </p>
             <p>
-                The primary keyword indicates that this node is the primary item. It 
+                The primary keyword indicates that this child node is the primary item. It 
                 may appear on a maximum of one property or child node definition within 
                 a node type definition.
             </p>
             <p>
-                The multiple keyword indicates that this node may have same-name siblings.
+                The multiple keyword indicates that this child node may have same-name siblings.
             </p>
             <p>
                 A maximum of one on-version indicator may be present. If none is present 
@@ -455,7 +457,7 @@
             <p>
                 Additionally, though spaces are required around the keywords 
                 (<code>orderable</code>, <code>mixin</code>, <code>date</code>, 
-                <code>mandatory</code>, etc..), short forms for keywords can be
+                <code>mandatory</code>, etc.), short forms for keywords can be
                  used. So, this:
             </p>
 <source><![CDATA[[x]>y,z o m-p(date)=a,b ! m a p * version <c,d]]></source>

Modified: incubator/jackrabbit/trunk/jackrabbit/src/site/xdoc/doc/nodetype/index.xml
URL: http://svn.apache.org/viewcvs/incubator/jackrabbit/trunk/jackrabbit/src/site/xdoc/doc/nodetype/index.xml?rev=355449&r1=355448&r2=355449&view=diff
==============================================================================
--- incubator/jackrabbit/trunk/jackrabbit/src/site/xdoc/doc/nodetype/index.xml (original)
+++ incubator/jackrabbit/trunk/jackrabbit/src/site/xdoc/doc/nodetype/index.xml Fri Dec  9 03:15:48 2005
@@ -76,7 +76,7 @@
                 </dd>
                 <dt><strong>Supertypes</strong></dt>
                 <dd>
-                    A primary node type (with the exception of nt:base) must extend another node type (and may extend
+                    A primary node type (with the exception of <code>nt:base</code>) must extend another node type (and may extend
                     more than one node type). A mixin node type may extend another node type.
                 </dd>
                 <dt><strong>Mixin Status</strong></dt>
@@ -256,13 +256,13 @@
 import java.util.Iterator
 
 public class CustomNodeTypeExample {
-    public static void RegisterCustomNodeTypes(Workspace ws){
+    public static void RegisterCustomNodeTypes(Workspace ws, String cndFileName){
 
         // Read in the CND file
-        FileReader fileReader = new FileReader(fileName);
+        FileReader fileReader = new FileReader(cndFileName);
 
         // Create a CompactNodeTypeDefReader
-        CompactNodeTypeDefReader cndReader = new CompactNodeTypeDefReader(fileReader, fileName);
+        CompactNodeTypeDefReader cndReader = new CompactNodeTypeDefReader(fileReader, cndFileName);
 
         // Get the List of NodeTypeDef objects
         List ntdList = cndReader.getNodeTypeDefs;
@@ -275,7 +275,7 @@
         // Acquire the NodeTypeRegistry
         NodeTypeRegistry ntreg = ntmgr.getNodeTypeRegistry();
 
-        // Loop through the prepared NodeTYpeDefs
+        // Loop through the prepared NodeTypeDefs
         for (Iterator i = ntdList.iterator(); i.hasNext();) {
 
             // Get the NodeTypeDef...

Modified: incubator/jackrabbit/trunk/jackrabbit/src/site/xdoc/navigation.xml
URL: http://svn.apache.org/viewcvs/incubator/jackrabbit/trunk/jackrabbit/src/site/xdoc/navigation.xml?rev=355449&r1=355448&r2=355449&view=diff
==============================================================================
--- incubator/jackrabbit/trunk/jackrabbit/src/site/xdoc/navigation.xml (original)
+++ incubator/jackrabbit/trunk/jackrabbit/src/site/xdoc/navigation.xml Fri Dec  9 03:15:48 2005
@@ -19,14 +19,14 @@
  <title>Jackrabbit</title>
  <body>
   <menu name="Apache Jackrabbit">
-    <item name="About"                                   href="/about.html" />
+    <item name="Home"                                    href="/index.html" />
     <item name="Documentation"                           href="/doc/index.html"  collapse="true">
       <item name="Building Jackrabbit"                   href="/doc/building.html" />
-      <item name="First&#xA0;Steps"                      href="/doc/firststeps.html" />
-      <item name="JCR&#xA0;&amp;&#xA0;API"               href="/doc/arch/overview/jcrlevels.html"/>
-      <item name="Jackrabbit&#xA0;Architecture"          href="/doc/arch/overview.html" collapse="true">
-        <item name="How&#xA0;Jackrabbit&#xA0;works"      href="/doc/arch/operate/index.html"/>
-        <item name="Start-up,&#xA0;Initialize"           href="/doc/arch/operate/startup.html"/>
+      <item name="First Hops"                           href="/doc/firststeps.html" />
+      <item name="JCR &amp; API"                         href="/doc/arch/overview/jcrlevels.html"/>
+      <item name="Jackrabbit Architecture"               href="/doc/arch/overview.html" collapse="true">
+        <item name="How Jackrabbit works"                href="/doc/arch/operate/index.html"/>
+        <item name="Start-up, Initialize"                href="/doc/arch/operate/startup.html"/>
         <item name="QueryManager"                        href="/doc/arch/operate/query.html"/>
       </item>
       <item name="Deployment&#xA0;Models"                href="/doc/deploy.html" collapse="true">
@@ -40,9 +40,10 @@
           <item name="Node Type Notation"                href="/doc/nodetype/cnd.html" />
       </item>
     </item>
-    <item name="Layout"                 href="/layout.html"/>
-    <item name="Downloads"              href="/downloads.html"/>
-    <item name="FAQ"                    href="/faq.html"/>
+    <item name="Layout"                                  href="/layout.html"/>
+    <item name="Downloads"                               href="/downloads.html"/>
+    <item name="FAQ"                                     href="/faq.html"/>
+    <item name="About"                                   href="/about.html" />
   </menu>
  </body>
 </project>