[Checkins] SVN: zf.zscp/trunk/src/zf/zscp/doc/re clean up html code
Daniel Meier
daniel.meier at perse.ch
Wed Apr 12 08:15:10 EDT 2006
Log message for revision 66884:
clean up html code
Changed:
U zf.zscp/trunk/src/zf/zscp/doc/regulations.pt
U zf.zscp/trunk/src/zf/zscp/doc/regulations_page02.pt
U zf.zscp/trunk/src/zf/zscp/doc/regulations_page03.pt
U zf.zscp/trunk/src/zf/zscp/doc/regulations_page05.pt
U zf.zscp/trunk/src/zf/zscp/doc/regulations_page06.pt
U zf.zscp/trunk/src/zf/zscp/doc/regulations_page07.pt
U zf.zscp/trunk/src/zf/zscp/doc/regulations_page08.pt
U zf.zscp/trunk/src/zf/zscp/doc/regulations_page09.pt
U zf.zscp/trunk/src/zf/zscp/doc/repository.pt
U zf.zscp/trunk/src/zf/zscp/doc/repository_page02.pt
U zf.zscp/trunk/src/zf/zscp/doc/repository_page03.pt
U zf.zscp/trunk/src/zf/zscp/doc/repository_page04.pt
U zf.zscp/trunk/src/zf/zscp/doc/repository_page05.pt
U zf.zscp/trunk/src/zf/zscp/doc/repository_page06.pt
U zf.zscp/trunk/src/zf/zscp/doc/repository_page07.pt
U zf.zscp/trunk/src/zf/zscp/doc/repository_page08.pt
U zf.zscp/trunk/src/zf/zscp/doc/repository_page09.pt
-=-
Modified: zf.zscp/trunk/src/zf/zscp/doc/regulations.pt
===================================================================
--- zf.zscp/trunk/src/zf/zscp/doc/regulations.pt 2006-04-12 12:07:12 UTC (rev 66883)
+++ zf.zscp/trunk/src/zf/zscp/doc/regulations.pt 2006-04-12 12:15:09 UTC (rev 66884)
@@ -34,7 +34,7 @@
of software quality using a metric system and (b) to communicate this
information to our users, customers, and prospective customers.</p>
- <div class="itemNavRightArrow"><a href="@@regulations_page02.html">Next Page: Audience</a></div>
+ <div class="itemNavRightArrow"><a href="@@regulations_page02.html">Audience</a></div>
</div>
</body>
Modified: zf.zscp/trunk/src/zf/zscp/doc/regulations_page02.pt
===================================================================
--- zf.zscp/trunk/src/zf/zscp/doc/regulations_page02.pt 2006-04-12 12:07:12 UTC (rev 66883)
+++ zf.zscp/trunk/src/zf/zscp/doc/regulations_page02.pt 2006-04-12 12:15:09 UTC (rev 66884)
@@ -42,8 +42,8 @@
quality. Again, the support of the Zope Foundation is reassuring to him that
the program is legitimate.</p>
- <div class="itemNavLeftArrow"><a href="@@regulations.html">Previous Page: Zope Community Process</a></div>
- <div class="itemNavRightArrow"><a href="@@regulations_page03.html">Next Page: Certification Levels</a></div>
+ <div class="itemNavLeftArrow"><a href="@@regulations.html">Zope Community Process</a></div>
+ <div class="itemNavRightArrow"><a href="@@regulations_page03.html">Certification Levels</a></div>
</div>
</body>
Modified: zf.zscp/trunk/src/zf/zscp/doc/regulations_page03.pt
===================================================================
--- zf.zscp/trunk/src/zf/zscp/doc/regulations_page03.pt 2006-04-12 12:07:12 UTC (rev 66883)
+++ zf.zscp/trunk/src/zf/zscp/doc/regulations_page03.pt 2006-04-12 12:15:09 UTC (rev 66884)
@@ -74,10 +74,10 @@
</ul>
<div class="itemNavLeftArrow"><a href="@@regulations_page02.html">
- Previous Page: Audience</a>
+ Audience</a>
</div>
<div class="itemNavRightArrow"><a href="@@regulations_page04.html">
- Next Page: Quality Metrics</a>
+ Quality Metrics</a>
</div>
</div>
Modified: zf.zscp/trunk/src/zf/zscp/doc/regulations_page05.pt
===================================================================
--- zf.zscp/trunk/src/zf/zscp/doc/regulations_page05.pt 2006-04-12 12:07:12 UTC (rev 66883)
+++ zf.zscp/trunk/src/zf/zscp/doc/regulations_page05.pt 2006-04-12 12:15:09 UTC (rev 66884)
@@ -18,150 +18,129 @@
<p>(Data Type, Multiplicity, Necessity)</p>
<p>Field Description</p>
- <p>Example: example value</p>
+ <p>Example: <tt>example value</tt></p>
<p>The following data description is known as the <em>Package Meta-Data
Version 1.0</em>.</p>
- <h4><a id="package-name" name="package-name">5.1. Package-name</a>
- </h4>
+ <h4>5.1. Package-name</h4>
<p>(Bytes Line, single, required)</p>
<p>The dotted Python path of the package.</p>
<p>Example: <tt>zope.sample</tt></p>
- <h4><a id="name" name="name">5.2. Name</a></h4>
+ <h4>5.2. Name</h4>
<p>(Text Line, single, required)</p>
<p>The commonly used name of the package.</p>
- <p>Example: Sample</p>
+ <p>Example: <tt>Sample</tt></p>
- <h4><a id="summary" name="summary">5.3. Summary</a></h4>
+ <h4>5.3. Summary</h4>
<p>(Text Line, single, required)</p>
<p>A short description or summary of the package. It is also often interpreted as
the title.</p>
- <p>Example: The Zope Sample Package</p>
+ <p>Example: <tt>The Zope Sample Package</tt></p>
- <h4><a id="description" name="description">5.4. Description</a> </h4>
+ <h4>5.4. Description</h4>
<p>(Text, single, optional)</p>
<p>A detailed description of the package's functionality. While it should
contain some detail, it should not duplicate the documentation of the
README.txt file.</p>
<dl class="docutils">
- <dt>Example: The sample package for Zope does provide some sample features
- that</dt>
- <dd>can be useful for developers to learn about sample data development. It
- does so by providing ...</dd>
+ <dt>Example: <tt>The sample package for Zope does provide some sample features
+ that can be useful for developers to learn about sample data development. It
+ does so by providing ...</tt></dt>
</dl>
- <h4><a id="home-page" name="home-page">5.5. Home-page</a></h4>
+ <h4>5.5. Home-page</h4>
<p>(URL, single, optional)</p>
<p>A URL to the homepage of the package.</p>
- <p>Example: <a class="reference"
- href="http://www.zope.org/Products/sample">
- http://www.zope.org/Products/sample</a></p>
+ <p>Example: <tt>http://www.zope.org/Products/sample</tt></p>
- <h4><a id="author" name="author">5.6. Author</a></h4>
+ <h4>5.6. Author</h4>
<p>(Text Line, multiple, required)</p>
<p>The name of the author of the package. The value should <em>not</em> contain
the author's E-mail address. This field can be specified multiple
times.</p>
- <p>Example: John Doe</p>
+ <p>Example: <tt>John Doe</tt></p>
- <h4><a id="author-email" name="author-email">5.7. Author-email</a>
- </h4>
+ <h4>5.7. Author-email</h4>
<p>(E-mail Address, multiple, required)</p>
<p>The E-mail of the author of the package. This field can be specified multiple
times. Any entry X of the author field is matched with entry X of the author
email field. If this field is specified the length of the author field list
must match the length of the author email field list.</p>
- <p>Example: <a class="reference" href="mailto:john@doe.com">
- john@doe.com</a></p>
+ <p>Example: <tt>john@doe.com</tt></p>
- <h4><a id="license" name="license">5.8. License</a></h4>
+ <h4>5.8. License</h4>
<p>(Text Line, multiple, required)</p>
<p>The software license of the package. This field can specified multiple
times, to support dual-licensing.</p>
- <p>Example: ZPL 2.1</p>
+ <p>Example: <tt>ZPL 2.1</tt></p>
- <h4><a id="platform" name="platform">5.9. Platform</a></h4>
+ <h4>5.9. Platform</h4>
<p>(Text Line, multiple, required)</p>
<p>The operating system/platform the package is known to run on. This field can
be specified multiple times. <tt class="docutils literal">
<span class="pre">All</span></tt> may be used, if the package is
available on all platforms Python is running on, i.e. the package is pure
Python code.</p>
- <p>Example: Unix</p>
+ <p>Example: <tt>Unix</tt></p>
- <h4><a id="classifier" name="classifier">5.10. Classifier</a> </h4>
+ <h4>5.10. Classifier</h4>
<p>(Classifier Text Line, multiple, optional)</p>
<p>A classification entry identifying the package. This field can be specified
multiple times.</p>
<dl class="docutils">
- <dt>Example: Programming Language :: Python</dt>
- <dd>Topic :: Internet :: WWW/HTTP Topic :: Internet :: WWW/HTTP :: Dynamic
- Content Topic :: Software Development :: Libraries :: Python
- Modules</dd>
+ <dt>Example: <tt>Programming Language :: Python :: Topic :: Internet ::
+ WWW/HTTP Topic :: Internet :: WWW/HTTP :: Dynamic :: Content Topic ::
+ Software Development :: Libraries :: Python Modules</tt></dt>
</dl>
- <h4><a id="developers-mailinglist" name="developers-mailinglist">
- 5.11. Developers-mailinglist</a></h4>
+ <h4>5.11. Developers-mailinglist</h4>
<p>(E-mail Address, single, optional)</p>
<p>The E-mail address of the developer mailing list.</p>
- <p>Example: <a class="reference" href="mailto:sample-dev@doe.com">
- sample-dev@doe.com</a></p>
+ <p>Example: <tt>sample-dev@doe.com</tt></p>
- <h4><a id="users-mailinglist" name="users-mailinglist">5.12.
- Users-mailinglist</a></h4>
+ <h4>5.12. Users-mailinglist</h4>
<p>(E-mail Address, single, optional)</p>
<p>The E-mail address of the users mailing list.</p>
- <p>Example: <a class="reference"
- href="mailto:sample-users@doe.com">
- sample-users@doe.com</a></p>
+ <p>Example: <tt>sample-users@doe.com</tt></p>
- <h4><a id="issue-tracker" name="issue-tracker">5.13.
- Issue-tracker</a></h4>
+ <h4>5.13. Issue-tracker</h4>
<p>(URL, single, optional)</p>
<p>A URL to the issue tracker of the package, where new issues/bugs/requests can
be reported.</p>
- <p>Example: <a class="reference"
- href="http://www.zope.org/trackers/sample/">
- http://www.zope.org/trackers/sample/</a></p>
+ <p>Example: <tt>http://www.zope.org/trackers/sample/</tt></p>
- <h4><a id="repository-location" name="repository-location">5.14.
- Repository-location</a></h4>
+ <h4>5.14. Repository-location</h4>
<p>(URL, single, optional)</p>
<p>The URL to the repository. The URL should be usable to actually check out the
package.</p>
- <p>Example: svn://svn.zope.org/repos/main/sample</p>
+ <p>Example: <tt>svn://svn.zope.org/repos/main/sample</tt></p>
- <h4><a id="repository-web-location" name="repository-web-location">
- 5.15. Repository-web-location</a></h4>
+ <h4>5.15. Repository-web-location</h4>
<p>(URL, single, optional)</p>
<p>The URL to the repository's browsable HTML UI.</p>
- <p>Example: <a class="reference" href="http://svn.zope.org/sample">
- http://svn.zope.org/sample</a></p>
+ <p>Example: <tt>http://svn.zope.org/sample</tt></p>
- <h4><a id="certification-level" name="certification-level">5.16.
- Certification-level</a></h4>
+ <h4>5.16. Certification-level</h4>
<p>(Choice, single, optional)</p>
<p>Describes the certification level of the package. The value can be one of the
following five: None, listed, level1, level2, level3</p>
- <p>Example: level1</p>
+ <p>Example: <tt>level1</tt></p>
- <h4><a id="certification-date" name="certification-date">5.17.
- Certification-date</a></h4>
+ <h4>5.17. Certification-date</h4>
<p>(Date, single, optional)</p>
<p>The date at which the certification was received. The date should be in the
format <tt class="docutils literal">
<span class="pre">yyyy-mm-dd</span></tt>.</p>
- <p>Example: 2006-02-28</p>
+ <p>Example: <tt>2006-02-28</tt></p>
- <h4><a id="metadata-version" name="metadata-version">5.18.
- Metadata-Version</a></h4>
+ <h4>5.18. Metadata-Version</h4>
<p>(Text Line, single, required)</p>
<p>This is the version number of this package meta-data.</p>
- <p>Example: 1.1</p>
+ <p>Example: <tt>1.1</tt></p>
- <div class="itemNavLeftArrow"><a href="@@regulations_page04.html">Previous Page: Quality Metrics</a></div>
- <div class="itemNavRightArrow"><a href="@@regulations_page06.html">Next Page: Package Certification Data</a></div>
+ <div class="itemNavLeftArrow"><a href="@@regulations_page04.html">Quality Metrics</a></div>
+ <div class="itemNavRightArrow"><a href="@@regulations_page06.html">Package Certification Data</a></div>
</div>
</body>
Modified: zf.zscp/trunk/src/zf/zscp/doc/regulations_page06.pt
===================================================================
--- zf.zscp/trunk/src/zf/zscp/doc/regulations_page06.pt 2006-04-12 12:07:12 UTC (rev 66883)
+++ zf.zscp/trunk/src/zf/zscp/doc/regulations_page06.pt 2006-04-12 12:15:09 UTC (rev 66884)
@@ -22,64 +22,60 @@
certification action the following pieces of information must be
recorded. The same sub-section layout as in section 2.5. applies.</p>
<div class="section">
- <h4><a id="action" name="action">6.1. Action</a></h4>
+ <h4>6.1. Action</h4>
<p>(Choice, single, required)</p>
<p>The action describes whether a certification was granted or revoked.
Upon violations (as defined in section 2.8), a certification manager
can also issue a warning.</p>
- <p>Allowed Values: grant, revoke, warn Example: granted</p>
+ <p>Allowed Values: grant, revoke, warn</p>
+ <p>Example: <tt>granted</tt></p>
</div>
<div class="section">
- <h4><a id="source-level" name="source-level">6.2.
- Source-level</a></h4>
+ <h4>6.2. Source-level</h4>
<p>(Choice, single, required)</p>
<p>This field describes the original certification level before this
certification action was executed.</p>
- <p>Allowed Values: none, listed, level1, level2, level3 Example:
- listed</p>
+ <p>Allowed Values: none, listed, level1, level2, level3</p>
+ <p>Example: <tt>listed</tt></p>
</div>
<div class="section">
- <h4><a id="target-level" name="target-level">6.3.
- Target-level</a></h4>
+ <h4>6.3. Target-level</h4>
<p>(Choice, single, required)</p>
<p>This field describes the final certification level after this
certification action was executed.</p>
- <p>Allowed Values: none, listed, level1, level2, level3 Example:
- level1</p>
+ <p>Allowed Values: none, listed, level1, level2, level3</p>
+ <p>Example: <tt>level1</tt></p>
</div>
<div class="section">
- <h4><a id="date" name="date">6.4. Date</a></h4>
+ <h4>6.4. Date</h4>
<p>(Date, single, required)</p>
<p>The date on which the certification action was executed. The field
should be of the format <tt class="docutils literal">
<span class="pre">yyyy-mm-dd</span></tt>.</p>
- <p>Example: 2006-02-11</p>
+ <p>Example: <tt>2006-02-11</tt></p>
</div>
<div class="section">
- <h4><a id="certification-manager" name="certification-manager">
- 6.5. Certification-manager</a></h4>
+ <h4>6.5. Certification-manager</h4>
<p>(Text Line, single, required)</p>
<p>This field lists the person that executed the certification action. It
is the full name and E-mail address of the person.</p>
- <p>Example: John Doe <<a class="reference"
- href="mailto:john@doe.com">john@doe.com</a>
- ></p>
+ <p>Example: <tt>John Doe <john@doe.com></tt></p>
</div>
<div class="section">
- <h4><a id="comments" name="comments">6.6. Comments</a></h4>
+ <h4>6.6. Comments</h4>
<p>(Text, single, optional)</p>
<p>This field can contain arbitrary comments about the certification
action.</p>
<dl class="docutils">
- <dt>Example: The authors of the Sample package have cooperated well by
- swiftly</dt>
- <dd>providing all necessary information required for the
- certification to be granted.</dd>
+ <dt>Example: <tt>The authors of the Sample package have cooperated well by
+ swiftly providing all necessary information required for the
+ certification to be granted.</tt>
+ </dt>
</dl>
</div>
- <div class="itemNavLeftArrow"><a href="@@regulations_page05.html">Previous Page: Package Meta-Information</a></div>
- <div class="itemNavRightArrow"><a href="@@regulations_page07.html">Next Page: Package Release Data</a></div>
+ <div class="itemNavLeftArrow"><a href="@@regulations_page05.html">Package Meta-Information</a></div>
+ <div class="itemNavRightArrow"><a href="@@regulations_page07.html">Package Release Data</a></div>
</div>
</body>
Modified: zf.zscp/trunk/src/zf/zscp/doc/regulations_page07.pt
===================================================================
--- zf.zscp/trunk/src/zf/zscp/doc/regulations_page07.pt 2006-04-12 12:07:12 UTC (rev 66883)
+++ zf.zscp/trunk/src/zf/zscp/doc/regulations_page07.pt 2006-04-12 12:15:09 UTC (rev 66884)
@@ -4,109 +4,89 @@
<div metal:fill-slot="body" tal:define="global pageversion string: 0.8">
<div id="documentFirstHeading">Regulations for the Zope Software
- Certification Program (7 of 9)
- <b class="itemNavLeftArrow" align="right" ><a href="@@regulations_page06.html"></a></b>
- <b class="itemNavRightArrow" align="right" ><a href="@@regulations_page08.html"></a></b>
- </div>
+ Certification Program (7 of 9) <b class="itemNavLeftArrow"
+ align="right"><a href="@@regulations_page06.html"></a></b> <b
+ class="itemNavRightArrow" align="right"><a
+ href="@@regulations_page08.html"></a></b> </div>
<h3 class="itemSeven itemHeading">Package Release Data</h3>
<p>Finally, all the releases of certified packages <em>must</em> be tracked.
This section describes the data that must be recorded for each release. The
- same sub-section layout as in section 2.5. applies.</p>
+ same sub-section layout as in section 5. applies.</p>
<p>The following data description is known as the <em>Package Release Data
Version 1.0</em>.</p>
- <div class="section">
- <h4><a id="id4" name="id4">7.1. Name</a></h4>
- <p>(Text Line, single, required)</p>
- <p>The name under which the package will be known for this release. This
- field <em>may</em> be equivalent to the name field described in
- section 2.5.1.</p>
- <p>Example: Sample Package</p>
+
+ <h4>7.1. Name</h4>
+ <p>(Text Line, single, required)</p>
+ <p>The name under which the package will be known for this release. This field
+ <em>may</em> be equivalent to the name field described in section 5.1.</p>
+ <p>Example: <tt>Sample Package</tt></p>
+
+ <h4>7.2. Version</h4>
+ <p>(Text Line, single, required)</p>
+ <p>This field describes the version number of the release.</p>
+ <p>Example: <tt>0.9.0b2</tt></p>
+
+ <h4>7.3. Codename</h4>
+ <p>(Text Line, single, optional)</p>
+ <p>The code name of the release.</p>
+ <p>Example: <tt>CoolName</tt></p>
+
+ <h4>7.4. Date</h4>
+ <p>(Date, single, required)</p>
+ <p>The date on which the release was made. The date should be in the form <tt
+ class="docutils literal">
+ <span class="pre">yyyy-mm-dd</span></tt>.</p>
+ <p>Example: <tt>2006-02-01</tt></p>
+
+ <h4>7.5. Certification</h4>
+ <p>(Choice, single, required)</p>
+ <p>The certification level of the package at the date of the release.</p>
+ <p>Allowed Values: none, listed, level1, level2, level3</p>
+ <p>Example: <tt>level1</tt></p>
+
+ <h4>7.6. Package</h4>
+ <p>(URL, single, required)</p>
+ <p>The URL to the installation package file.</p>
+ <p>Example: <tt>http://www.zope.org/Products/SamplePackage/SamplePackage-0.9.0.tgz</tt></p>
+
+ <h4>7.7. Source +++++++++++++x</h4>
+ <p>(URL, single, optional)</p>
+ <p>The URL to the repository location. It should be possible to use this URL to
+ make a checkout.</p>
+ <p>Example: <tt>svn://svn.zope.org/zf.sample/tags/0.9.0b2</tt></p>
+
+ <h4>7.8. Dependency</h4>
+ <p>(Text Line, multiple, required)</p>
+ <p>A dependency to another package. The dependency must contain the full name of
+ the package and the version number. One entry of this field <em>must</em> be
+ specified for each dependency.</p>
+ <p>Example: <tt>Zope 3.3</tt></p>
+
+ <h4>7.9. Announcement</h4>
+ <p>(URL, single, optional)</p>
+ <p>A link to the announcement of the release.</p>
+ <p>Example: <tt>http://www.zope.org/Products/SamplePackage090Released</tt></p>
+
+ <h4>7.10. Release-manager</h4>
+ <p>(Text Line, single, required)</p>
+ <p>The full name and E-mail address of the release manager. Both sub-fields
+ should be separately be available.</p>
+ <p>Example: <tt>John Doe <john@doe.com></tt></p>
+
+ <h4>7.11. Press-contact</h4>
+ <p>(Text Line, single, required)</p>
+ <p>The full name and E-mail address of the press contact. Both sub-fields should
+ be separately be available.</p>
+ <p>Example: <tt>John Doe <john@doe.com></tt></p>
+
+ <div class="itemNavLeftArrow"><a href="@@regulations_page06.html">
+ Package Certification Data</a>
</div>
- <div class="section">
- <h4><a id="version" name="version">7.2. Version</a></h4>
- <p>(Text Line, single, required)</p>
- <p>This field describes the version number of the release.</p>
- <p>Example: 0.9.0b2</p>
+ <div class="itemNavRightArrow"><a href="@@regulations_page08.html">The
+ Process</a>
</div>
- <div class="section">
- <h4><a id="codename" name="codename">7.3. Codename</a></h4>
- <p>(Text Line, single, optional)</p>
- <p>The code name of the release.</p>
- <p>Example: CoolName</p>
- </div>
- <div class="section">
- <h4><a id="id5" name="id5">7.4. Date</a></h4>
- <p>(Date, single, required)</p>
- <p>The date on which the release was made. The date should be in the form <tt
- class="docutils literal">
- <span class="pre">yyyy-mm-dd</span></tt>.</p>
- <p>Example: 2006-02-01</p>
- </div>
- <div class="section">
- <h4><a id="certification" name="certification">7.5.
- Certification</a></h4>
- <p>(Choice, single, required)</p>
- <p>The certification level of the package at the date of the release.</p>
- <p>Allowed Values: none, listed, level1, level2, level3 Example:
- level1</p>
- </div>
- <div class="section">
- <h4><a id="package" name="package">7.6. Package</a></h4>
- <p>(URL, single, required)</p>
- <p>The URL to the installation package file.</p>
- <p>Example: <a class="reference"
- href="http://www.zope.org/Products/SamplePackage/SamplePackage-0.9.0.tgz">
- http://www.zope.org/Products/SamplePackage/SamplePackage-0.9.0.tgz</a>
- </p>
- <p>7.7. Source +++++++++++++x</p>
- <p>(URL, single, optional)</p>
- <p>The URL to the repository location. It should be possible to use this URL
- to make a checkout.</p>
- <p>Example: svn://svn.zope.org/zf.sample/tags/0.9.0b2</p>
- </div>
- <div class="section">
- <h4><a id="dependency" name="dependency">7.8. Dependency</a></h4>
- <p>(Text Line, multiple, required)</p>
- <p>A dependency to another package. The dependency must contain the full
- name of the package and the version number. One entry of this field
- <em>must</em> be specified for each dependency.</p>
- <p>Example: Zope 3.3</p>
- </div>
- <div class="section">
- <h4><a id="announcement" name="announcement">7.9.
- Announcement</a></h4>
- <p>(URL, single, optional)</p>
- <p>A link to the announcement of the release.</p>
- <p>Example: <a class="reference"
- href="http://www.zope.org/Products/SamplePackage090Released">
- http://www.zope.org/Products/SamplePackage090Released</a>
- </p>
- </div>
- <div class="section">
- <h4><a id="release-manager" name="release-manager">7.10.
- Release-manager</a></h4>
- <p>(Text Line, single, required)</p>
- <p>The full name and E-mail address of the release manager. Both sub-fields
- should be separately be available.</p>
- <p>Example: John Doe <<a class="reference"
- href="mailto:john@doe.com">john@doe.com</a>
- ></p>
- </div>
- <div class="section">
- <h4><a id="press-contact" name="press-contact">7.11.
- Press-contact</a></h4>
- <p>(Text Line, single, required)</p>
- <p>The full name and E-mail address of the press contact. Both sub-fields
- should be separately be available.</p>
- <p>Example: John Doe <<a class="reference"
- href="mailto:john@doe.com">john@doe.com</a>
- ></p>
- </div>
- <div class="itemNavLeftArrow"><a href="@@regulations_page06.html">Previous Page: Package Certification Data</a></div>
- <div class="itemNavRightArrow"><a href="@@regulations_page08.html">Next Page: The Process</a></div>
-
</div>
</body>
</html>
\ No newline at end of file
Modified: zf.zscp/trunk/src/zf/zscp/doc/regulations_page08.pt
===================================================================
--- zf.zscp/trunk/src/zf/zscp/doc/regulations_page08.pt 2006-04-12 12:07:12 UTC (rev 66883)
+++ zf.zscp/trunk/src/zf/zscp/doc/regulations_page08.pt 2006-04-12 12:15:09 UTC (rev 66884)
@@ -73,8 +73,8 @@
"thank you". And for the community it is overall better to have as
many certified packages as possible.</p>
- <div class="itemNavLeftArrow"><a href="@@regulations_page07.html">Previous Page: Package Release Data</a></div>
- <div class="itemNavRightArrow"><a href="@@regulations_page09.html">Next Page: Questions and Answers</a></div>
+ <div class="itemNavLeftArrow"><a href="@@regulations_page07.html">Package Release Data</a></div>
+ <div class="itemNavRightArrow"><a href="@@regulations_page09.html">Questions and Answers</a></div>
</div>
</body>
Modified: zf.zscp/trunk/src/zf/zscp/doc/regulations_page09.pt
===================================================================
--- zf.zscp/trunk/src/zf/zscp/doc/regulations_page09.pt 2006-04-12 12:07:12 UTC (rev 66883)
+++ zf.zscp/trunk/src/zf/zscp/doc/regulations_page09.pt 2006-04-12 12:15:09 UTC (rev 66884)
@@ -67,7 +67,7 @@
having them certified separately makes it easier to amrket their
certification.</p>
- <div class="itemNavRightArrow"><a href="@@regulations_page08.html">Previous Page: The Process</a></div>
+ <div class="itemNavLeftArrow"><a href="@@regulations_page08.html">The Process</a></div>
</div>
</body>
Modified: zf.zscp/trunk/src/zf/zscp/doc/repository.pt
===================================================================
--- zf.zscp/trunk/src/zf/zscp/doc/repository.pt 2006-04-12 12:07:12 UTC (rev 66883)
+++ zf.zscp/trunk/src/zf/zscp/doc/repository.pt 2006-04-12 12:15:09 UTC (rev 66884)
@@ -21,7 +21,7 @@
<p>The existing <tt class="docutils literal">
<span class="pre">svn://svn.zope.org/repos/main</span></tt> will serve
as the Common Repository. Every package in the common repository <em>must</em>
- conform at least to the layout as described in section 3.2. If a package wishes to
+ conform at least to the layout as described in <a href="@@repository_page02.html">section 2</a>. If a package wishes to
participate in the ZSCP, then it must also conform to the program's process. The
implementation details of the ZSCP process are provided in the sections
below.</p>
@@ -33,7 +33,7 @@
with every new Zope release. This, on the other hand, will greatly simplify the
dependency tree for Common Repository based packages.</p>
- <div class="itemNavRightArrow"><a href="@@repository_page02.html">Next Page: Layout</a></div>
+ <div class="itemNavRightArrow"><a href="@@repository_page02.html">Layout</a></div>
</div>
</body>
Modified: zf.zscp/trunk/src/zf/zscp/doc/repository_page02.pt
===================================================================
--- zf.zscp/trunk/src/zf/zscp/doc/repository_page02.pt 2006-04-12 12:07:12 UTC (rev 66883)
+++ zf.zscp/trunk/src/zf/zscp/doc/repository_page02.pt 2006-04-12 12:15:09 UTC (rev 66884)
@@ -12,7 +12,7 @@
<p>Packages in the Common Repository <em>must</em> have the following
layout:</p>
- <blockquote>
+ <tt>
<dl>
<dt>repos/main/<NAMESPACE>.<PACKAGE></dt>
<dd>branches/</dd>
@@ -41,7 +41,7 @@
</dl>
</dd>
</dl>
- </blockquote>
+ </tt>
<p>This layout, with exception of the <tt class="docutils literal">
<span class="pre">zscp/</span></tt> directory, follows the common
layout guidelines of SVN and Python. The optional <tt
@@ -53,19 +53,21 @@
other files containing the necessary data.</p>
<p>The format of the <tt class="docutils literal">
<span class="pre">ZSCP.cfg</span></tt> file is as follows:</p>
- <pre class="literal-block">
- publication <PATH-OR-URL-TO-PUBLICATION-FILE>
- certifications <PATH-OR-URL-TO-CERTIFICATIONS-FILE>
+ <blockquote>
+ <tt>
+ publication <PATH-OR-URL-TO-PUBLICATION-FILE><br />
+ certifications <PATH-OR-URL-TO-CERTIFICATIONS-FILE><br />
releases <PATH-OR-URL-TO-RELEASES-FILE>
- </pre>
+ </tt>
+ </blockquote>
<p>The value for each field, <tt class="docutils literal">
<span class="pre">publication</span></tt>, <tt
class="docutils literal">
<span class="pre">certifications</span></tt>, and <tt
class="docutils literal">
<span class="pre">releases</span></tt> is a relative path or URL to the
- corresponding file. The formats for those files is defined in section
- 3.3.</p>
+ corresponding file. The formats for those files is
+ defined in <a href="@@repository_page03.html">section 3</a>.</p>
<p>The <tt class="docutils literal">
<span class="pre">zscp/</span></tt> directory and the <tt
class="docutils literal">
@@ -108,7 +110,7 @@
high-quality packages that are supported by the Zope development
team.</p>
<p>Code in the Common Repository <em>must</em> also use the license stated in
- section 3.5 and developers <em>must</em> sign the contributor agreement.
+ <a href="@@repository_page05.html">section 5</a> and developers <em>must</em> sign the contributor agreement.
The agreement is necessary to ensure that contributions originated from
the contributing developer.</p>
<p>A final goal of the Common Repository is to ease the upstream movement of
@@ -118,8 +120,8 @@
signed contributor agreements, packages can be easily moved into the Zope 3
and Python core.</p>
- <div class="itemNavLeftArrow"><a href="@@repository.html">Previous Page: Definition</a></div>
- <div class="itemNavRightArrow"><a href="@@repository_page03.html">Next Page: Package Publication, Certification, and Release Data</a></div>
+ <div class="itemNavLeftArrow"><a href="@@repository.html">Definition</a></div>
+ <div class="itemNavRightArrow"><a href="@@repository_page03.html">Package Publication, Certification, and Release Data</a></div>
</div>
</body>
Modified: zf.zscp/trunk/src/zf/zscp/doc/repository_page03.pt
===================================================================
--- zf.zscp/trunk/src/zf/zscp/doc/repository_page03.pt 2006-04-12 12:07:12 UTC (rev 66883)
+++ zf.zscp/trunk/src/zf/zscp/doc/repository_page03.pt 2006-04-12 12:15:09 UTC (rev 66884)
@@ -3,49 +3,43 @@
<div metal:fill-slot="body" tal:define="global pageversion string: 0.8">
<div id="documentFirstHeading">The Common Repository Layout (3 of 9)
- <b class="itemNavLeftArrow" align="right" ><a href="@@repository_page02.html"></a></b>
- <b class="itemNavRightArrow" align="right" ><a href="@@repository_page04.html"></a></b>
- </div>
+ <b class="itemNavLeftArrow" align="right"><a
+ href="@@repository_page02.html"></a></b> <b
+ class="itemNavRightArrow" align="right"><a
+ href="@@repository_page04.html"></a></b> </div>
- <h3 class="itemThree itemHeading">Package Publication,
- Certification, and Release Data</h3>
+ <h3 class="itemThree itemHeading">Package Publication, Certification,
+ and Release Data</h3>
<p>The package data that must be available for all packages participating in the
ZSCP is contained in three data files. The format of each file is described
below.</p>
- <h4><a id="the-publication-data-file"
- name="the-publication-data-file">3.1. The Publication Data
- File</a></h4>
+ <h4>3.1. The Publication Data File</h4>
<p>The publication file is a simple meta-data file in the Internet Message
Format (RFC 2822). This format allows simple key-value pair assignments
that can occur multiple times. It is also the format used for HTTP
headers.</p>
<p>The keys in the publication files must correspond to the names of the
- sub-sections in section 2.5.</p>
+ sub-sections in <a href="@@repository_page05.html">section 5</a>
+ .</p>
<p>Zope 3 has already successfully used this format to provide meta-data to the
Python Package Index (PyPI).</p>
- <p>The publication data file is commonly named <tt class="docutils literal">
+ <p>The publication data file is commonly named <tt>
<span class="pre">PUBLICATION.cfg</span></tt>.</p>
- <h4><a id="the-certification-data-file"
- name="the-certification-data-file">3.2. The Certification
- Data File</a></h4>
- <p>The certification data file is a simple XML file. The root element is <tt
- class="docutils literal">
- <span class="pre">certifications</span></tt> with <tt
- class="docutils literal">
+ <h4>3.2. The Certification Data File</h4>
+ <p>The certification data file is a simple XML file. The root element is <tt>
+ <span class="pre">certifications</span></tt> with <tt>
<span class="pre">certification</span></tt> sub-elements. Each field
- listed in section 2.6 is a sub-element of <tt class="docutils literal">
+ listed in <a href="@@repository_page06.html">section 6</a> is a
+ sub-element of <tt>
<span class="pre">certification</span></tt>.</p>
- <p>The certification data file is commonly named <tt
- class="docutils literal">
+ <p>The certification data file is commonly named <tt>
<span class="pre">CERTIFICATIONS.xml</span></tt>.</p>
<p>This file is auto-generated by the ZSCP Web site.</p>
- <p>Example:</p>
- <pre class="literal-block">
-
-
+ <p>Example:</p> <tt>
+ <pre>
<certifications>
<certification>
<action>grant</action>
@@ -69,25 +63,20 @@
</certification>
</certifications>
</pre>
-
- <h4><a id="the-release-data-file" name="the-release-data-file"> 3.3.
- The Release Data File</a></h4>
- <p>The release data file is a simple XML file. The root element is <tt
- class="docutils literal">
- <span class="pre"><releases></span></tt> with <tt
- class="docutils literal">
+ </tt>
+ <h4>3.3. The Release Data File</h4>
+ <p>The release data file is a simple XML file. The root element is <tt>
+ <span class="pre"><releases></span></tt> with <tt>
<span class="pre"><release></span></tt> sub-elements. Each
- field listed in section 2.7 is a sub-element of <tt
- class="docutils literal">
+ field listed in <a href="@@repository_page07.html">section 7</a> is a
+ sub-element of <tt>
<span class="pre"><release></span></tt>.</p>
- <p>The release data file is commonly named <tt class="docutils literal">
+ <p>The release data file is commonly named <tt>
<span class="pre">RELEASES.xml</span></tt>.</p>
<p>If the package is part of ZSCP, then entries will be added automatically for
automated releases at the end of a Zope release cycle.</p>
- <p>Example:</p>
- <pre class="literal-block">
-
-
+ <p>Example:</p> <tt>
+ <pre>
<releases>
<release>
<name>Sample Package</name>
@@ -113,11 +102,16 @@
</release>
...
</releases>
-</pre>
-
- <div class="itemNavLeftArrow"><a href="@@repository_page02.html">Previous Page: Layout</a></div>
- <div class="itemNavRightArrow"><a href="@@repository_page04.html">Next Page: Quality Assurance</a></div>
+ </pre>
+ </tt>
+ <div class="itemNavLeftArrow"><a href="@@repository_page02.html">
+ Layout</a>
+ </div>
+ <div class="itemNavRightArrow"><a href="@@repository_page04.html">
+ Quality Assurance</a>
+ </div>
+
</div>
</body>
</html>
\ No newline at end of file
Modified: zf.zscp/trunk/src/zf/zscp/doc/repository_page04.pt
===================================================================
--- zf.zscp/trunk/src/zf/zscp/doc/repository_page04.pt 2006-04-12 12:07:12 UTC (rev 66883)
+++ zf.zscp/trunk/src/zf/zscp/doc/repository_page04.pt 2006-04-12 12:15:09 UTC (rev 66884)
@@ -14,8 +14,7 @@
sub-section lists such tools. The full development of those tools is
expected to be a long-term process.</p>
- <h4><a id="automated-test-runner" name="automated-test-runner"> 4.1.
- Automated Test Runner</a></h4>
+ <h4>4.1. Automated Test Runner</h4>
<p>The trunks of the packages in the Common Repository are generally expected to
pass all tests. The zope.org buildbot setup will be used to verify all tests
of a package after each checkin. Any test failures will be reported.
@@ -24,15 +23,10 @@
shorter, until the first beta of the next Zope 3 release) will be granted to
remove any deprecation warnings, due to refactoring.</p>
<p>Status: - The buildbot setup is in place. - A buildout system needs to be
- developed to describe to buildbot how to build</p>
- <div class="system-message">
- <p class="system-message-title">System Message: ERROR/3 (<tt
- class="docutils"><string></tt>, line 1247)</p>
- Unexpected indentation.</div>
- <blockquote> the package environment to run the tests.</blockquote>
+ developed to describe to buildbot how to build
+ the package environment to run the tests.</p>
- <h4><a id="test-coverage-reports" name="test-coverage-reports"> 4.2.
- Test Coverage Reports</a></h4>
+ <h4>4.2. Test Coverage Reports</h4>
<p>The test runner provides a neat option "--coverage" that reports
the lines that were not executed during the testing period. The test
coverage will be run regularly, probably as part of the buildbot test runs.
@@ -51,23 +45,15 @@
reports to an HTML page exists. - The better coverage implementation of
SchoolTool needs to be ported.</p>
- <h4><a id="publication-data-verification"
- name="publication-data-verification">4.3. Publication Data
- Verification</a></h4>
+ <h4>4.3. Publication Data Verification</h4>
<p>Since the publication data is central to providing sufficient information
about a package, it will be necessary for a tool to regularly check the
completeness of the file and verify any external links.</p>
<p>Status: - This tool has to be written, but should not be too hard, since a parser
- and</p>
- <div class="system-message">
- <p class="system-message-title">System Message: ERROR/3 (<tt
- class="docutils"><string></tt>, line 1281)</p>
- Unexpected indentation.</div>
- <blockquote> writer for the publication data must be developed for the ZSCP Web
- site anyways.</blockquote>
+ and writer for the publication data must be developed for the ZSCP Web
+ site anyways.</p>
- <h4><a id="dependency-checker" name="dependency-checker">4.4.
- Dependency Checker</a></h4>
+ <h4>4.4. Dependency Checker</h4>
<p>A dependency checker will ensure that all used packages and modules are
listed in the <tt class="docutils literal">
<span class="pre">DEPENDENCIES.cfg</span></tt> file. While this is not
@@ -75,31 +61,17 @@
dependencies. If an unlisted dependency is found, a message to the mailing
list will be sent.</p>
<p>Status: - This tool does not exist yet, though a dependency detection tool is
- already</p>
- <div class="system-message">
- <p class="system-message-title">System Message: ERROR/3 (<tt
- class="docutils"><string></tt>, line 1294)</p>
- Unexpected indentation.</div>
- <blockquote> available. Its code could be used to implement this
- tool.</blockquote>
+ already available. Its code could be used to implement this tool.</p>
- <h4><a id="nightly-tar-ball-testing" name="nightly-tar-ball-testing">
- 4.5. Nightly TAR-ball Testing</a></h4>
+ <h4>4.5. Nightly TAR-ball Testing</h4>
<p>A nightly cron job could generate a TAR-ball of the package and check whether
it is functioning correctly.</p>
<p>SchoolTool has already deployed such a tool successfully.</p>
<p>Status: - While a "prototype" exists, it would be somewhat
- difficult to produce an</p>
- <div class="system-message">
- <p class="system-message-title">System Message: ERROR/3 (<tt
- class="docutils"><string></tt>, line 1306)</p>
- Unexpected indentation.</div>
- <blockquote> environment in which the package could be properly
- run.</blockquote>
+ difficult to produce an environment in which the package could be properly
+ run.</p>
- <h4><a id="coding-style-verification"
- name="coding-style-verification">4.6. Coding Style
- Verification</a></h4>
+ <h4>4.6. Coding Style Verification</h4>
<p>While coding style verification can never be fully tested, there are some
elements that can be checked:</p>
<ul class="simple">
@@ -115,8 +87,7 @@
</ul>
<p>Status: - Such a tool is not implemented yet.</p>
- <h4><a id="migration-script-testing" name="migration-script-testing">
- 4.7. Migration Script Testing</a></h4>
+ <h4>4.7. Migration Script Testing</h4>
<p>Often data migration scripts are written without fully testing them in an
involved test environment. The most effective way to test a migration
script is to actually store an old version of the database, apply the
@@ -126,8 +97,8 @@
<p>Status: - The documentation to writing those type of tests needs to be
written.</p>
- <div class="itemNavLeftArrow"><a href="@@repository_page03.html">Previous Page: Package Publication, Certification, and Release Data</a></div>
- <div class="itemNavRightArrow"><a href="@@repository_page05.html">Next Page: Coding Style Guidelines</a></div>
+ <div class="itemNavLeftArrow"><a href="@@repository_page03.html">Package Publication, Certification, and Release Data</a></div>
+ <div class="itemNavRightArrow"><a href="@@repository_page05.html">Coding Style Guidelines</a></div>
</div>
</body>
Modified: zf.zscp/trunk/src/zf/zscp/doc/repository_page05.pt
===================================================================
--- zf.zscp/trunk/src/zf/zscp/doc/repository_page05.pt 2006-04-12 12:07:12 UTC (rev 66883)
+++ zf.zscp/trunk/src/zf/zscp/doc/repository_page05.pt 2006-04-12 12:15:09 UTC (rev 66884)
@@ -69,8 +69,8 @@
dependency per line.</p>
</li>
- <div class="itemNavLeftArrow"><a href="@@repository_page04.html">Previous Page: Quality Assurance</a></div>
- <div class="itemNavRightArrow"><a href="@@repository_page06.html">Next Page: Releases</a></div>
+ <div class="itemNavLeftArrow"><a href="@@repository_page04.html">Quality Assurance</a></div>
+ <div class="itemNavRightArrow"><a href="@@repository_page06.html">Releases</a></div>
</div>
</body>
Modified: zf.zscp/trunk/src/zf/zscp/doc/repository_page06.pt
===================================================================
--- zf.zscp/trunk/src/zf/zscp/doc/repository_page06.pt 2006-04-12 12:07:12 UTC (rev 66883)
+++ zf.zscp/trunk/src/zf/zscp/doc/repository_page06.pt 2006-04-12 12:15:09 UTC (rev 66884)
@@ -19,8 +19,8 @@
<p>However, packages may also choose their own release schedule. In this case
dependencies must be carefully stated in the release data file.</p>
- <div class="itemNavLeftArrow"><a href="@@repository_page05.html">Previous Page: Coding Style Guidelines</a></div>
- <div class="itemNavRightArrow"><a href="@@repository_page07.html">Next Page: License</a></div>
+ <div class="itemNavLeftArrow"><a href="@@repository_page05.html">Coding Style Guidelines</a></div>
+ <div class="itemNavRightArrow"><a href="@@repository_page07.html">License</a></div>
</div>
</body>
Modified: zf.zscp/trunk/src/zf/zscp/doc/repository_page07.pt
===================================================================
--- zf.zscp/trunk/src/zf/zscp/doc/repository_page07.pt 2006-04-12 12:07:12 UTC (rev 66883)
+++ zf.zscp/trunk/src/zf/zscp/doc/repository_page07.pt 2006-04-12 12:15:09 UTC (rev 66884)
@@ -35,8 +35,8 @@
very demanding at first sight, it is simply a necessary measure to protect
the Zope community legally.</p>
- <div class="itemNavLeftArrow"><a href="@@repository_page06.html">Previous Page: Releases</a></div>
- <div class="itemNavRightArrow"><a href="@@repository_page08.html">Next Page: An Example</a></div>
+ <div class="itemNavLeftArrow"><a href="@@repository_page06.html">Releases</a></div>
+ <div class="itemNavRightArrow"><a href="@@repository_page08.html">An Example</a></div>
</div>
</body>
Modified: zf.zscp/trunk/src/zf/zscp/doc/repository_page08.pt
===================================================================
--- zf.zscp/trunk/src/zf/zscp/doc/repository_page08.pt 2006-04-12 12:07:12 UTC (rev 66883)
+++ zf.zscp/trunk/src/zf/zscp/doc/repository_page08.pt 2006-04-12 12:15:09 UTC (rev 66884)
@@ -37,8 +37,8 @@
may take a year or longer to complete, it ensures that the API of the search
package is truly useful and provides benefit to the intended audience.</p>
- <div class="itemNavLeftArrow"><a href="@@repository_page07.html">Previous Page: License</a></div>
- <div class="itemNavRightArrow"><a href="@@repository_page09.html">Next Page: Questions and Answers</a></div>
+ <div class="itemNavLeftArrow"><a href="@@repository_page07.html">License</a></div>
+ <div class="itemNavRightArrow"><a href="@@repository_page09.html">Questions and Answers</a></div>
</div>
</body>
Modified: zf.zscp/trunk/src/zf/zscp/doc/repository_page09.pt
===================================================================
--- zf.zscp/trunk/src/zf/zscp/doc/repository_page09.pt 2006-04-12 12:07:12 UTC (rev 66883)
+++ zf.zscp/trunk/src/zf/zscp/doc/repository_page09.pt 2006-04-12 12:15:09 UTC (rev 66884)
@@ -20,7 +20,7 @@
plone.org and the Tiks CMS by Projekt01 on tiks.org. However, those
applications may apply for certification.</p>
- <div class="itemNavLeftArrow"><a href="@@repository_page08.html">Previous Page: An Example</a></div>
+ <div class="itemNavLeftArrow"><a href="@@repository_page08.html">An Example</a></div>
</div>
</body>
More information about the Checkins
mailing list