[Zope3-checkins] SVN: Zope3/trunk/src/zope/app/styleguide/ Added different subfolders for topics

Roger Ineichen roger at projekt01.ch
Sun Feb 27 18:51:38 EST 2005


Log message for revision 29333:
  Added different subfolders for topics
  Register subtopics for Style Guide

Changed:
  U   Zope3/trunk/src/zope/app/styleguide/configure.zcml
  A   Zope3/trunk/src/zope/app/styleguide/css/
  U   Zope3/trunk/src/zope/app/styleguide/form/README.txt
  U   Zope3/trunk/src/zope/app/styleguide/form/configure.zcml
  U   Zope3/trunk/src/zope/app/styleguide/form/pagetemplate.txt
  A   Zope3/trunk/src/zope/app/styleguide/form/widget.txt
  A   Zope3/trunk/src/zope/app/styleguide/skin/
  A   Zope3/trunk/src/zope/app/styleguide/skin/README.txt
  A   Zope3/trunk/src/zope/app/styleguide/skin/__init__.py
  A   Zope3/trunk/src/zope/app/styleguide/skin/configure.zcml
  A   Zope3/trunk/src/zope/app/styleguide/skin/doctype.txt
  A   Zope3/trunk/src/zope/app/styleguide/widget/
  A   Zope3/trunk/src/zope/app/styleguide/widget/README.txt
  A   Zope3/trunk/src/zope/app/styleguide/widget/__init__.py
  A   Zope3/trunk/src/zope/app/styleguide/widget/configure.zcml
  A   Zope3/trunk/src/zope/app/styleguide/zpt/
  A   Zope3/trunk/src/zope/app/styleguide/zpt/README.txt
  A   Zope3/trunk/src/zope/app/styleguide/zpt/__init__.py
  A   Zope3/trunk/src/zope/app/styleguide/zpt/configure.zcml

-=-
Modified: Zope3/trunk/src/zope/app/styleguide/configure.zcml
===================================================================
--- Zope3/trunk/src/zope/app/styleguide/configure.zcml	2005-02-27 23:50:22 UTC (rev 29332)
+++ Zope3/trunk/src/zope/app/styleguide/configure.zcml	2005-02-27 23:51:38 UTC (rev 29333)
@@ -2,21 +2,30 @@
     xmlns="http://namespaces.zope.org/zope"
     xmlns:browser="http://namespaces.zope.org/browser"
     xmlns:help="http://namespaces.zope.org/help"
+    xmlns:zcml="http://namespaces.zope.org/zcml"
     i18n_domain="zope">
 
-  <browser:resource 
-      name="styleguide.css" 
-      file="styleguide.css"
-      />
+  <!-- requires the package zope.app.onlinehelp -->
+  <configure zcml:condition="have onlinehelp">
 
-  <help:register
-      id="styleguide"
-      title="Style Guides"
-      doc_path="README.txt"
-      class="zope.app.onlinehelp.onlinehelptopic.RESTOnlineHelpTopic"
-      />
+    <browser:resource 
+        name="styleguide.css" 
+        file="styleguide.css"
+        />
 
-  <include package=".form" />
-  <include package=".i18n" />
+    <help:register
+        id="styleguide"
+        title="Style Guides"
+        doc_path="README.txt"
+        class="zope.app.onlinehelp.onlinehelptopic.RESTOnlineHelpTopic"
+        />
+  
+    <include package=".css" />
+    <include package=".i18n" />
+    <include package=".skin" />
+    <include package=".widget" />
+    <include package=".zpt" />
 
+  </configure>
+
 </configure>

Modified: Zope3/trunk/src/zope/app/styleguide/form/README.txt
===================================================================
--- Zope3/trunk/src/zope/app/styleguide/form/README.txt	2005-02-27 23:50:22 UTC (rev 29332)
+++ Zope3/trunk/src/zope/app/styleguide/form/README.txt	2005-02-27 23:51:38 UTC (rev 29333)
@@ -1,5 +1,5 @@
-========================
-Views, Forms and Widgets
-========================
+=====
+Forms
+=====
 
-Explains how we write views and which tags should be used ...
+Explains how we write forms ...

Modified: Zope3/trunk/src/zope/app/styleguide/form/configure.zcml
===================================================================
--- Zope3/trunk/src/zope/app/styleguide/form/configure.zcml	2005-02-27 23:50:22 UTC (rev 29332)
+++ Zope3/trunk/src/zope/app/styleguide/form/configure.zcml	2005-02-27 23:51:38 UTC (rev 29333)
@@ -4,36 +4,4 @@
     xmlns:help="http://namespaces.zope.org/help"
     i18n_domain="zope">
 
-  <help:register
-      id="form"
-      parent="styleguide"
-      title="Views, Forms and Widgets"
-      doc_path="README.txt"
-      class="zope.app.onlinehelp.onlinehelptopic.RESTOnlineHelpTopic"
-      />
-
-  <help:register
-      id="css"
-      parent="styleguide/form"
-      title="CSS"
-      doc_path="index.html"
-      class="zope.app.onlinehelp.onlinehelptopic.ZPTOnlineHelpTopic"
-      />
-
-  <help:register
-      id="doctype"
-      parent="styleguide/form"
-      title="Doctype"
-      doc_path="doctype.txt"
-      class="zope.app.onlinehelp.onlinehelptopic.RESTOnlineHelpTopic"
-      />
-
-  <help:register
-      id="pagetemplate"
-      parent="styleguide/from"
-      title="Page template"
-      doc_path="pagetemplate.txt"
-      class="zope.app.onlinehelp.onlinehelptopic.RESTOnlineHelpTopic"
-      />
-
 </configure>

Modified: Zope3/trunk/src/zope/app/styleguide/form/pagetemplate.txt
===================================================================
--- Zope3/trunk/src/zope/app/styleguide/form/pagetemplate.txt	2005-02-27 23:50:22 UTC (rev 29332)
+++ Zope3/trunk/src/zope/app/styleguide/form/pagetemplate.txt	2005-02-27 23:51:38 UTC (rev 29333)
@@ -14,19 +14,19 @@
 
 Example::
 
-<label for="firstName">First name:
-  <input type="text" name="firstname" id="firstName"/>
-</label>
+  <label for="firstName">First name:
+    <input type="text" name="firstname" id="firstName"/>
+  </label>
 
 cf. "Labeling form controls"
 http://www.w3.org/TR/WCAG10-HTML-TECHS/#forms-labels
 
-
 Element ID
 ----------
 
 Use the "id" attribute to provide relative location URL instead of the old 
 <a name="xxx"/> markup. This is needed to do the transition to XHTML1.1.
+
 Example::
 
     <p>
@@ -42,16 +42,16 @@
 ----------------------------------------------
 To create paragraphs do not use <br/><br/>.
 
-  Example::
+Example::
 
-    <p>
-      Blablah
-    </p>
-    <p>
-      Blablah
-    </p>
-    <p>
-      <input type="checkbox" name="item1" id="item1" value="xxx"/><label for="item1">Item1</label><br/>
-      <input type="checkbox" name="item2" id="item2" value="yyy"/><label for="item2">Item2</label><br/>
-      <input type="checkbox" name="item3" id="item3" value="zzz"/><label for="item3">Item3</label><br/>
-    </p>
+  <p>
+    Blablah
+  </p>
+  <p>
+    Blablah
+  </p>
+  <p>
+    <input type="checkbox" name="item1" id="item1" value="xxx"/><label for="item1">Item1</label><br/>
+    <input type="checkbox" name="item2" id="item2" value="yyy"/><label for="item2">Item2</label><br/>
+    <input type="checkbox" name="item3" id="item3" value="zzz"/><label for="item3">Item3</label><br/>
+  </p>

Added: Zope3/trunk/src/zope/app/styleguide/form/widget.txt
===================================================================
--- Zope3/trunk/src/zope/app/styleguide/form/widget.txt	2005-02-27 23:50:22 UTC (rev 29332)
+++ Zope3/trunk/src/zope/app/styleguide/form/widget.txt	2005-02-27 23:51:38 UTC (rev 29333)
@@ -0,0 +1,5 @@
+=======
+Widgets
+=======
+
+Include the package zope.app.demo.widget and you will see some widget samples.


Property changes on: Zope3/trunk/src/zope/app/styleguide/form/widget.txt
___________________________________________________________________
Name: svn:eol-style
   + native

Added: Zope3/trunk/src/zope/app/styleguide/skin/README.txt
===================================================================
--- Zope3/trunk/src/zope/app/styleguide/skin/README.txt	2005-02-27 23:50:22 UTC (rev 29332)
+++ Zope3/trunk/src/zope/app/styleguide/skin/README.txt	2005-02-27 23:51:38 UTC (rev 29333)
@@ -0,0 +1,5 @@
+====
+Skin
+====
+
+Explains how we write skins ...


Property changes on: Zope3/trunk/src/zope/app/styleguide/skin/README.txt
___________________________________________________________________
Name: svn:eol-style
   + native

Added: Zope3/trunk/src/zope/app/styleguide/skin/__init__.py
===================================================================
--- Zope3/trunk/src/zope/app/styleguide/skin/__init__.py	2005-02-27 23:50:22 UTC (rev 29332)
+++ Zope3/trunk/src/zope/app/styleguide/skin/__init__.py	2005-02-27 23:51:38 UTC (rev 29333)
@@ -0,0 +1,17 @@
+##############################################################################
+#
+# Copyright (c) 2002 - 2005 Zope Corporation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Zope3 skin styleguide
+
+$Id$
+"""


Property changes on: Zope3/trunk/src/zope/app/styleguide/skin/__init__.py
___________________________________________________________________
Name: svn:eol-style
   + native

Added: Zope3/trunk/src/zope/app/styleguide/skin/configure.zcml
===================================================================
--- Zope3/trunk/src/zope/app/styleguide/skin/configure.zcml	2005-02-27 23:50:22 UTC (rev 29332)
+++ Zope3/trunk/src/zope/app/styleguide/skin/configure.zcml	2005-02-27 23:51:38 UTC (rev 29333)
@@ -0,0 +1,23 @@
+<configure
+    xmlns="http://namespaces.zope.org/zope"
+    xmlns:browser="http://namespaces.zope.org/browser"
+    xmlns:help="http://namespaces.zope.org/help"
+    i18n_domain="zope">
+
+  <help:register
+      id="skin"
+      parent="styleguide"
+      title="Skin"
+      doc_path="README.txt"
+      class="zope.app.onlinehelp.onlinehelptopic.RESTOnlineHelpTopic"
+      />
+
+  <help:register
+      id="doctype"
+      parent="styleguide/skin"
+      title="Doctype"
+      doc_path="doctype.txt"
+      class="zope.app.onlinehelp.onlinehelptopic.RESTOnlineHelpTopic"
+      />
+
+</configure>


Property changes on: Zope3/trunk/src/zope/app/styleguide/skin/configure.zcml
___________________________________________________________________
Name: svn:eol-style
   + native

Added: Zope3/trunk/src/zope/app/styleguide/skin/doctype.txt
===================================================================
--- Zope3/trunk/src/zope/app/styleguide/skin/doctype.txt	2005-02-27 23:50:22 UTC (rev 29332)
+++ Zope3/trunk/src/zope/app/styleguide/skin/doctype.txt	2005-02-27 23:51:38 UTC (rev 29333)
@@ -0,0 +1,22 @@
+=======
+Doctype
+=======
+
+The Zope3 default skin follows the XHTML 1.0 Transitional DTD
+
+::
+
+  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+But Zope3 is already almost XHTML Strict
+
+::
+
+  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+
+So developers and web designers should code as if pages follows already XHTML 
+Strict.
+
+The doctype has to be at the first line of the page template. Without any 
+other tag. Don't use encoding tags in front of a doctype.


Property changes on: Zope3/trunk/src/zope/app/styleguide/skin/doctype.txt
___________________________________________________________________
Name: svn:eol-style
   + native

Added: Zope3/trunk/src/zope/app/styleguide/widget/README.txt
===================================================================
--- Zope3/trunk/src/zope/app/styleguide/widget/README.txt	2005-02-27 23:50:22 UTC (rev 29332)
+++ Zope3/trunk/src/zope/app/styleguide/widget/README.txt	2005-02-27 23:51:38 UTC (rev 29333)
@@ -0,0 +1,8 @@
+=======
+Widgets
+=======
+
+Explains how we write widgets ...
+
+Include the package zope.app.demo.widget and you will see some widget samples
+in the onlinehelp  topic 'Samples/Widgets'.


Property changes on: Zope3/trunk/src/zope/app/styleguide/widget/README.txt
___________________________________________________________________
Name: svn:eol-style
   + native

Added: Zope3/trunk/src/zope/app/styleguide/widget/__init__.py
===================================================================
--- Zope3/trunk/src/zope/app/styleguide/widget/__init__.py	2005-02-27 23:50:22 UTC (rev 29332)
+++ Zope3/trunk/src/zope/app/styleguide/widget/__init__.py	2005-02-27 23:51:38 UTC (rev 29333)
@@ -0,0 +1,17 @@
+##############################################################################
+#
+# Copyright (c) 2002 - 2005 Zope Corporation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Zope3 widget styleguide
+
+$Id$
+"""


Property changes on: Zope3/trunk/src/zope/app/styleguide/widget/__init__.py
___________________________________________________________________
Name: svn:eol-style
   + native

Added: Zope3/trunk/src/zope/app/styleguide/widget/configure.zcml
===================================================================
--- Zope3/trunk/src/zope/app/styleguide/widget/configure.zcml	2005-02-27 23:50:22 UTC (rev 29332)
+++ Zope3/trunk/src/zope/app/styleguide/widget/configure.zcml	2005-02-27 23:51:38 UTC (rev 29333)
@@ -0,0 +1,15 @@
+<configure
+    xmlns="http://namespaces.zope.org/zope"
+    xmlns:browser="http://namespaces.zope.org/browser"
+    xmlns:help="http://namespaces.zope.org/help"
+    i18n_domain="zope">
+
+  <help:register
+      id="widget"
+      parent="styleguide"
+      title="Widgets"
+      doc_path="README.txt"
+      class="zope.app.onlinehelp.onlinehelptopic.RESTOnlineHelpTopic"
+      />
+
+</configure>


Property changes on: Zope3/trunk/src/zope/app/styleguide/widget/configure.zcml
___________________________________________________________________
Name: svn:eol-style
   + native

Added: Zope3/trunk/src/zope/app/styleguide/zpt/README.txt
===================================================================
--- Zope3/trunk/src/zope/app/styleguide/zpt/README.txt	2005-02-27 23:50:22 UTC (rev 29332)
+++ Zope3/trunk/src/zope/app/styleguide/zpt/README.txt	2005-02-27 23:51:38 UTC (rev 29333)
@@ -0,0 +1,57 @@
+=============
+Page template
+=============
+
+Associate labels explicitly with their controls
+-----------------------------------------------
+
+In other words it means: use <label> along with your <input type="text"/>,
+your <input type="checkbox"/> and your <input type="radio"/> elements.
+Using labels makes it possible to use the pointer on the label
+(clicking on the label) to active the input, so that it is easier to select a
+text input, a check box or a radio box, just like it is in heavy client
+applications such as Firefox.
+
+Example::
+
+  <label for="firstName">First name:
+    <input type="text" name="firstname" id="firstName"/>
+  </label>
+
+cf. "Labeling form controls"
+http://www.w3.org/TR/WCAG10-HTML-TECHS/#forms-labels
+
+Element ID
+----------
+
+Use the "id" attribute to provide relative location URL instead of the old 
+<a name="xxx"/> markup. This is needed to do the transition to XHTML1.1.
+
+Example::
+
+    <p>
+      Check the <a href="#subject">subject headings</a>.
+    </p>
+
+    <h3 id="subject">Subject</h3>
+    <p>
+      Blah blah.
+    </p>
+
+Structure your text into paragraphs using <p>.
+----------------------------------------------
+To create paragraphs do not use <br/><br/>.
+
+Example::
+
+  <p>
+    Blablah
+  </p>
+  <p>
+    Blablah
+  </p>
+  <p>
+    <input type="checkbox" name="item1" id="item1" value="xxx"/><label for="item1">Item1</label><br/>
+    <input type="checkbox" name="item2" id="item2" value="yyy"/><label for="item2">Item2</label><br/>
+    <input type="checkbox" name="item3" id="item3" value="zzz"/><label for="item3">Item3</label><br/>
+  </p>


Property changes on: Zope3/trunk/src/zope/app/styleguide/zpt/README.txt
___________________________________________________________________
Name: svn:eol-style
   + native

Added: Zope3/trunk/src/zope/app/styleguide/zpt/__init__.py
===================================================================
--- Zope3/trunk/src/zope/app/styleguide/zpt/__init__.py	2005-02-27 23:50:22 UTC (rev 29332)
+++ Zope3/trunk/src/zope/app/styleguide/zpt/__init__.py	2005-02-27 23:51:38 UTC (rev 29333)
@@ -0,0 +1,17 @@
+##############################################################################
+#
+# Copyright (c) 2002 - 2005 Zope Corporation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Zope3 views, forms and widgets styleguide
+
+$Id$
+"""


Property changes on: Zope3/trunk/src/zope/app/styleguide/zpt/__init__.py
___________________________________________________________________
Name: svn:eol-style
   + native

Added: Zope3/trunk/src/zope/app/styleguide/zpt/configure.zcml
===================================================================
--- Zope3/trunk/src/zope/app/styleguide/zpt/configure.zcml	2005-02-27 23:50:22 UTC (rev 29332)
+++ Zope3/trunk/src/zope/app/styleguide/zpt/configure.zcml	2005-02-27 23:51:38 UTC (rev 29333)
@@ -0,0 +1,14 @@
+<configure
+    xmlns="http://namespaces.zope.org/zope"
+    xmlns:help="http://namespaces.zope.org/help"
+    i18n_domain="zope">
+
+  <help:register
+      id="pagetemplate"
+      parent="styleguide"
+      title="Page template"
+      doc_path="README.txt"
+      class="zope.app.onlinehelp.onlinehelptopic.RESTOnlineHelpTopic"
+      />
+
+</configure>


Property changes on: Zope3/trunk/src/zope/app/styleguide/zpt/configure.zcml
___________________________________________________________________
Name: svn:eol-style
   + native



More information about the Zope3-Checkins mailing list