[Checkins] SVN: zf.zscp/trunk/src/zf/zscp/doc/ lots of beautifiing,
added rest2html view for the latest version out of
ProcessAndRepository.txt
Daniel Meier
daniel.meier at perse.ch
Tue Apr 11 10:15:26 EDT 2006
Log message for revision 66851:
lots of beautifiing, added rest2html view for the latest version out of ProcessAndRepository.txt
Changed:
U zf.zscp/trunk/src/zf/zscp/doc/configure.zcml
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_page04.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/repository_page03.pt
U zf.zscp/trunk/src/zf/zscp/doc/repository_page04.pt
A zf.zscp/trunk/src/zf/zscp/doc/rest2html.pt
A zf.zscp/trunk/src/zf/zscp/doc/views.py
-=-
Modified: zf.zscp/trunk/src/zf/zscp/doc/configure.zcml
===================================================================
--- zf.zscp/trunk/src/zf/zscp/doc/configure.zcml 2006-04-11 11:41:35 UTC (rev 66850)
+++ zf.zscp/trunk/src/zf/zscp/doc/configure.zcml 2006-04-11 14:15:25 UTC (rev 66851)
@@ -61,6 +61,15 @@
<browser:page
for="*"
+ name="ProcessAndRepository.html"
+ permission="zope.Public"
+ template="rest2html.pt"
+ class=".views.ReSt2HTMLView"
+ layer="zf.zscp.skin.IZSCPLayer"
+ />
+
+ <browser:page
+ for="*"
name="regulations.html"
permission="zope.Public"
template="regulations.pt"
Modified: zf.zscp/trunk/src/zf/zscp/doc/regulations_page02.pt
===================================================================
--- zf.zscp/trunk/src/zf/zscp/doc/regulations_page02.pt 2006-04-11 11:41:35 UTC (rev 66850)
+++ zf.zscp/trunk/src/zf/zscp/doc/regulations_page02.pt 2006-04-11 14:15:25 UTC (rev 66851)
@@ -19,11 +19,12 @@
about the non-existent organization of Zope's third party products.
Everybody can upload their product to zope.org, without any evaluation of
quality, version compatibility or documentation. The goal of the ZSCP and
- its Web site is to provide a measurement of quality (see section 2.4.)
+ its Web site is to provide a measurement of quality
+ (<a href="@@regulations_page04.html">see section 4</a>)
measured as much as possible by automated tools and by minimal developer
verification. Also, packages listed in the ZSCP <em>must</em> provide a
- set of meta-data that links the user to various online resources. (See
- section 2.5.)</p>
+ set of meta-data that links the user to various online resources.
+ (<a href="@@regulations_page05.html">see section 5</a>)</p>
<p>The message to the decision maker varies slightly based on his/her
familiarity with Open Source and Zope in particular. To the uninitiated
decision maker the ZSCP should send a message of technical and economic
Modified: zf.zscp/trunk/src/zf/zscp/doc/regulations_page03.pt
===================================================================
--- zf.zscp/trunk/src/zf/zscp/doc/regulations_page03.pt 2006-04-11 11:41:35 UTC (rev 66850)
+++ zf.zscp/trunk/src/zf/zscp/doc/regulations_page03.pt 2006-04-11 14:15:25 UTC (rev 66851)
@@ -3,52 +3,40 @@
<div metal:fill-slot="body" tal:define="global pageversion string: 0.8">
<div id="documentFirstHeading">Regulations for the Zope Software
- Certification Program (3 of 9)
- <b class="itemNavLeftArrow" align="right" ><a href="@@regulations_page02.html"></a></b>
- <b class="itemNavRightArrow" align="right" ><a href="@@regulations_page04.html"></a></b>
- </div>
+ Certification Program (3 of 9) <b class="itemNavLeftArrow"
+ align="right"><a href="@@regulations_page02.html"></a></b> <b
+ class="itemNavRightArrow" align="right"><a
+ href="@@regulations_page04.html"></a></b> </div>
<h3 class="itemThree itemHeading">Certification Levels</h3>
- <h4><a id="certification-levels" name="certification-levels">2.3.
- Certification Levels</a></h4>
<p>There are 4 distinct levels for certification. They are defined in the list
below. The specific list of quality requirements for each level is provided
- in section 2.4.</p>
+ in <a href="@@regulations_page04.html">section 4</a>.</p>
<ul>
<li>
- <p class="first">ZSCP Listed</p>
+ <h4>ZSCP Listed</h4>
<p>Getting a package listed in the ZSCP system is the first step to
obtain certification. Packages listed on the ZSCP Web site must
adhere to the common package layout[1] and are subject to the
automated testing as well as the quality assurance process.
Listed packages must provide a full set of meta-data (as
- applicable) as defined in section 2.5.</p>
+ applicable) as defined in <a
+ href="@@regulations_page05.html">section 5</a>.</p>
<p>Packages at this level will fulfill roughly the same purpose as
packages in the CMF/Plone Collective. It is one way to make a
package publicly available and give it some exposure. At this
level, the developer will not have to comply with many of the
- quality metrics. See section 2.4.</p>
- <table class="docutils footnote" frame="void" id="id1"
- rules="none">
- <colgroup>
- <col class="label"/>
- <col/>
- </colgroup>
- <tbody valign="top">
- <tr>
- <td class="label"><a name="id1">[1]</a>
- </td>
- <td>
- <p class="first last">The common package layout
- is defined in section 3.2.</p>
- </td>
- </tr>
- </tbody>
- </table>
+ quality metrics. See <a href="@@regulations_page04.html">
+ section 4</a>.</p>
+
+ <p>[1] The common package layout is defined in <a
+ href="@@repository_page02.html"> section 2</a> of the
+ Repository Layout.</p>
+
</li>
<li>
- <p class="first">ZSCP Level 1 Certified</p>
+ <h4>ZSCP Level 1 Certified</h4>
<p>To be level 1 certified, the package must fulfill the requirements
of listed packages. Additionally, it has to provide
documentation, tests (in doctest format), conform to the package
@@ -61,7 +49,7 @@
Certified" in informal or promotional material.</p>
</li>
<li>
- <p class="first">ZSCP Level 2 Certified</p>
+ <h4>ZSCP Level 2 Certified</h4>
<p>To be level 2 certified, the package must fulfill the requirements
of level 1 certified packages. Additionally, it has to be
demonstrated that the package integrates well into the Zope
@@ -73,7 +61,7 @@
Certified" in informal or promotional material.</p>
</li>
<li>
- <p class="first">ZSCP Level 3 Certified</p>
+ <h4>ZSCP Level 3 Certified</h4>
<p>To be level 3 certified, the package must fulfill the requirements
of level 2 certified packages. Additionally, it has to be
demonstrated that the package has been successfully released
@@ -84,10 +72,14 @@
Certified" in informal or promotional material.</p>
</li>
</ul>
-
- <div class="itemNavLeftArrow"><a href="@@regulations_page02.html">Previous Page: Audience</a></div>
- <div class="itemNavRightArrow"><a href="@@regulations_page04.html">Next Page: Quality Metrics</a></div>
+ <div class="itemNavLeftArrow"><a href="@@regulations_page02.html">
+ Previous Page: Audience</a>
+ </div>
+ <div class="itemNavRightArrow"><a href="@@regulations_page04.html">
+ Next Page: Quality Metrics</a>
+ </div>
+
</div>
</body>
</html>
\ No newline at end of file
Modified: zf.zscp/trunk/src/zf/zscp/doc/regulations_page04.pt
===================================================================
--- zf.zscp/trunk/src/zf/zscp/doc/regulations_page04.pt 2006-04-11 11:41:35 UTC (rev 66850)
+++ zf.zscp/trunk/src/zf/zscp/doc/regulations_page04.pt 2006-04-11 14:15:25 UTC (rev 66851)
@@ -312,8 +312,8 @@
</tbody>
</table>
- <h5><a id="package-meta-information" name="package-meta-information">
- 2.4.1. Package Meta-Information</a></h5>
+ <h4><a id="package-meta-information" name="package-meta-information">
+ 4.1. Package Meta-Information</a></h4>
<p>The package must at least provide the required fields of the
package-meta-information as specified in section 2.5. The package may
also provide any of the optional fields and even fields that do not belong to
@@ -321,24 +321,24 @@
fields.</p>
<p>Since this <em>must</em> be an automated task, the data <em>must</em>
conform to the repositories package meta-information format.</p>
- <h5><a id="test-coverage" name="test-coverage">2.4.2. Test Coverage</a>
- </h5>
+ <h4><a id="test-coverage" name="test-coverage">4.2. Test Coverage</a>
+ </h4>
<p>Test coverage tools track the lines of the code that have been accessed during
a test run. The percentage of test coverage specified for each
certification level, represents the amount of tracked lines with respect
to the total amount of lines written.</p>
- <h5><a id="automated-test-verification"
- name="automated-test-verification">2.4.3. Automated Test
- Verification</a></h5>
+ <h4><a id="automated-test-verification"
+ name="automated-test-verification">4.3. Automated Test
+ Verification</a></h4>
<p>Tests <em>must</em> be runnable via a standard test runner. The repository
of the package <em>must</em> provide a method to run the tests after some
change and report it to the author.</p>
- <h5><a id="documentation-based-testing"
- name="documentation-based-testing">2.4.4. Documentation-based
- Testing</a></h5>
+ <h4><a id="documentation-based-testing"
+ name="documentation-based-testing">4.4. Documentation-based
+ Testing</a></h4>
<p>All tests <em>must</em> be written in form of documentation. The tool to
implement the tests is not specified, but the tests must be part of the
- automated test verification (see section 2.4.4). In some cases it is not
+ automated test verification (see section 4.4). In some cases it is not
possible or practical to write documentation-based tests; in those cases
developers <em>may</em> choose any testing framework as long as
integrates in the automated test verification. The developer
@@ -346,62 +346,62 @@
Acceptable reasons include legacy code/tests and tests that do not verify
code.</p>
- <h5><a id="platform-test-verification"
- name="platform-test-verification">2.4.5. Platform Test
- Verification</a></h5>
+ <h4><a id="platform-test-verification"
+ name="platform-test-verification">4.5. Platform Test
+ Verification</a></h4>
<p>All tests for a package <em>must</em> pass for all platforms the package
supports. The list of supported platform is part of the package
meta-information (see section 2.5.9). If <cite>All</cite> (meaning all
platforms) has been specified, the tests must be verified on Windows, MacOS
X, and Unix/Linux.</p>
- <h5><a id="minimal-documentation" name="minimal-documentation"> 2.4.6.
- Minimal Documentation</a></h5>
+ <h4><a id="minimal-documentation" name="minimal-documentation"> 4.6.
+ Minimal Documentation</a></h4>
<p>The package <em>must</em> provide a basic overview of the package's API in a
<tt class="docutils literal">
<span class="pre">README.txt</span></tt>. It is <em>not</em> required
to cover all edge cases. The documentation <em>must</em> be a set of
documentation tests.</p>
- <h5><a id="complete-documentation" name="complete-documentation">
- 2.4.7. Complete Documentation</a></h5>
+ <h4><a id="complete-documentation" name="complete-documentation">
+ 4.7. Complete Documentation</a></h4>
<p>The documentation <em>must</em> cover all of the API, including edge cases.
The documentation <em>may</em> be distributed over several documents.
The documentation <em>must</em> be a set of documentation tests.</p>
- <h5><a id="extensive-documentation" name="extensive-documentation">
- 2.4.8. Extensive Documentation</a></h5>
+ <h4><a id="extensive-documentation" name="extensive-documentation">
+ 4.8. Extensive Documentation</a></h4>
<p>Documentation at this level might come from many different sources, such as
Web sites, mailing list archives, documentation tests, and code. All
functional documentation <em>must</em> be a set of documentation
tests.</p>
- <h5><a id="documentation-available-online"
- name="documentation-available-online">2.4.9. Documentation
- available online</a></h5>
+ <h4><a id="documentation-available-online"
+ name="documentation-available-online">4.9. Documentation
+ available online</a></h4>
<p>The documentation for the package <em>must</em> be provided through a Web
site, which can be in the form of a home page or automatically generated
project page. For small packages it is sufficient to make the documentation
available via a Web site of the repository.</p>
- <h5><a id="apidoc-integrated-documentation"
- name="apidoc-integrated-documentation">2.4.10.
- APIDOC-integrated Documentation</a></h5>
+ <h4><a id="apidoc-integrated-documentation"
+ name="apidoc-integrated-documentation">4.10.
+ APIDOC-integrated Documentation</a></h4>
<p>All the documentation that is distributed with the package <em>must</em> be
available in the APIDOC documentation modules. This includes the
following items: * Package is registered with the source browser. *
Documentation tests are compiled as part of the APIDOC
"book" module.</p>
- <h5><a id="common-package-structure" name="common-package-structure">
- 2.4.11. Common package structure</a></h5>
+ <h4><a id="common-package-structure" name="common-package-structure">
+ 4.11. Common package structure</a></h4>
<p>The package <em>muat</em> follow the package structure layout required by
the repository. Inside the package code itself, Zope's coding styles of a
package layout <em>must</em> be followed.</p>
- <h5><a id="zope-coding-style-guide-compliance"
- name="zope-coding-style-guide-compliance">2.4.12. Zope Coding
- Style Guide compliance</a></h5>
+ <h4><a id="zope-coding-style-guide-compliance"
+ name="zope-coding-style-guide-compliance">4.12. Zope Coding
+ Style Guide compliance</a></h4>
<p>The Zope coding style guide <em>must</em> be followed. It can be found
at:</p>
<p><a class="reference" href="http://dev.zope.org/Zope3/CodingStyle">
@@ -409,71 +409,71 @@
<p>Additional conventions <em>may</em> be applicable, but are communicated
to the package author(s).</p>
- <h5><a id="conform-to-user-interface-guidelines"
- name="conform-to-user-interface-guidelines">2.4.13. Conform to
- user interface guidelines</a></h5>
+ <h4><a id="conform-to-user-interface-guidelines"
+ name="conform-to-user-interface-guidelines">4.13. Conform to
+ user interface guidelines</a></h4>
<p>If the package provides user interface components that are developed as part
of a larger framework, the user interface code <em>must</em> conform to any
user interface guidelines provided by this framework.</p>
- <h5><a id="complete-dependency-list" name="complete-dependency-list">
- 2.4.14. Complete dependency list</a></h5>
+ <h4><a id="complete-dependency-list" name="complete-dependency-list">
+ 4.14. Complete dependency list</a></h4>
<p>The package <em>must</em> provide a list of all other Python-package
dependencies. Often packaging software requires a list of dependencies;
this list is be sufficient, if it fulfills the repository layout and Zope
coding style guidelines.</p>
- <h5><a id="standard-installation-method"
- name="standard-installation-method">2.4.15. Standard
- installation method</a></h5>
+ <h4><a id="standard-installation-method"
+ name="standard-installation-method">4.15. Standard
+ installation method</a></h4>
<p>The package <em>must</em> be installable via the standard installation
method accepted by Zope. It is part of the package release cycle to conform to
the latest installation method.</p>
- <h5><a id="release-s-with-version-number"
- name="release-s-with-version-number">2.4.16. Release(s) with
- version number</a></h5>
+ <h4><a id="release-s-with-version-number"
+ name="release-s-with-version-number">4.16. Release(s) with
+ version number</a></h4>
<p>The package <em>must</em> be released regaularly and have version numbers
associated with each release.</p>
- <h5><a id="up-to-date-homepage" name="up-to-date-homepage">2.4.17.
- Up-to-date homepage</a></h5>
+ <h4><a id="up-to-date-homepage" name="up-to-date-homepage">4.17.
+ Up-to-date homepage</a></h4>
<p>The package <em>must</em> have an up-to-date homepage targetted at
developers. Other audiences <em>may</em> also be addressed. If a package
is very small, an auto-generated or even the repository Web site
<em>may</em> be sufficient.</p>
- <h5><a id="active-support-mailing-list"
- name="active-support-mailing-list">2.4.18. Active support
- mailing list</a></h5>
+ <h4><a id="active-support-mailing-list"
+ name="active-support-mailing-list">4.18. Active support
+ mailing list</a></h4>
<p>The package <em>must</em> provide a mailing list for developers using the
package. Activeness will be measured by response time and quality to
questions. For small packages it*may* be sufficient to use one of the
general Zope mailing lists.</p>
- <h5><a id="released-for-3-zope-release-cycles"
- name="released-for-3-zope-release-cycles">2.4.19. Released for
- 3+ Zope release cycles</a></h5>
+ <h4><a id="released-for-3-zope-release-cycles"
+ name="released-for-3-zope-release-cycles">4.19. Released for
+ 3+ Zope release cycles</a></h4>
<p>The package <em>must</em> be released for at least 3 Zope release cycles.
While strongly encouraged, it is <em>not</em> required that the package
must have the same release cycle as Zope.</p>
- <h5><a id="releases-state-required-zope-version"
- name="releases-state-required-zope-version">2.4.20. Releases
- state required Zope version</a></h5>
+ <h4><a id="releases-state-required-zope-version"
+ name="releases-state-required-zope-version">4.20. Releases
+ state required Zope version</a></h4>
<p>The release of the package <em>must</em> specify the required Zope version.
See section 2.7 for details on release meta-data, including dependency
specifications.</p>
- <h5><a id="multiple-3-active-maintainers"
- name="multiple-3-active-maintainers">2.4.21. Multiple (3)
- Active Maintainers</a></h5>
+ <h4><a id="multiple-3-active-maintainers"
+ name="multiple-3-active-maintainers">4.21. Multiple (3)
+ Active Maintainers</a></h4>
<p>The package <em>must</em> have at least three active maintainers. At least
one active maintainer <em>must</em> always be reachable by certification
managers.</p>
- <h5><a id="data-migration-claimed" name="data-migration-claimed">
- 2.4.22. Data migration claimed</a></h5>
+ <h4><a id="data-migration-claimed" name="data-migration-claimed">
+ 4.22. Data migration claimed</a></h4>
<p>If the package manages any data, it <em>must</em> provide an automated data
migration mechanism. If no automated software can be produced, the package
author(s) <em>must</em> provide clear instructions about migrating the
@@ -481,24 +481,24 @@
<em>may</em> be accepted. Migration scripts <em>must not</em> be
provided, if no data migration is necessary.</p>
- <h5><a id="data-migration-auto-tested"
- name="data-migration-auto-tested">2.4.23. Data migration
- auto-tested</a></h5>
- <p>Additionally to the requirements in section 2.4.22, the data migration
+ <h4><a id="data-migration-auto-tested"
+ name="data-migration-auto-tested">4.23. Data migration
+ auto-tested</a></h4>
+ <p>Additionally to the requirements in section 4.22, the data migration
scripts <em>must</em> be tested using the standard test runner. If the
migration script tests take an uncommonly long time to run, they
<em>may</em> be moved to test level 2.</p>
- <h5><a id="data-migration-verified" name="data-migration-verified">
- 2.4.24. Data migration verified</a></h5>
- <p>The requirements of section 2.4.23 <em>must</em> be fulfilled. In
+ <h4><a id="data-migration-verified" name="data-migration-verified">
+ 4.24. Data migration verified</a></h4>
+ <p>The requirements of section 4.23 <em>must</em> be fulfilled. In
addition, with the help of the package author(s), the migration manager
verified that the data migration is complete and functional.</p>
- <h5><a id="data-migration-well-tested"
- name="data-migration-well-tested">2.4.25. Data migration
- well-tested</a></h5>
- <p>In addition to the fulfillment of the requirements listed in 2.4.24, the data
+ <h4><a id="data-migration-well-tested"
+ name="data-migration-well-tested">4.25. Data migration
+ well-tested</a></h4>
+ <p>In addition to the fulfillment of the requirements listed in 4.24, the data
migration scripts <em>must</em> be tested against production-grade data
of at least 2 projects using the package.</p>
Modified: zf.zscp/trunk/src/zf/zscp/doc/regulations_page05.pt
===================================================================
--- zf.zscp/trunk/src/zf/zscp/doc/regulations_page05.pt 2006-04-11 11:41:35 UTC (rev 66850)
+++ zf.zscp/trunk/src/zf/zscp/doc/regulations_page05.pt 2006-04-11 14:15:25 UTC (rev 66851)
@@ -22,25 +22,24 @@
<p>The following data description is known as the <em>Package Meta-Data
Version 1.0</em>.</p>
- <h5><a id="package-name" name="package-name">2.5.1. Package-name</a>
- </h5>
+ <h4><a id="package-name" name="package-name">5.1. Package-name</a>
+ </h4>
<p>(Bytes Line, single, required)</p>
<p>The dotted Python path of the package.</p>
- <p>Example: <tt class="docutils literal">
- <span class="pre">zope.sample</span></tt></p>
+ <p>Example: <tt>zope.sample</tt></p>
- <h5><a id="name" name="name">2.5.2. Name</a></h5>
+ <h4><a id="name" name="name">5.2. Name</a></h4>
<p>(Text Line, single, required)</p>
<p>The commonly used name of the package.</p>
<p>Example: Sample</p>
- <h5><a id="summary" name="summary">2.5.3. Summary</a></h5>
+ <h4><a id="summary" name="summary">5.3. Summary</a></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>
- <h5><a id="description" name="description">2.5.4. Description</a> </h5>
+ <h4><a id="description" name="description">5.4. Description</a> </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
@@ -52,22 +51,22 @@
does so by providing ...</dd>
</dl>
- <h5><a id="home-page" name="home-page">2.5.5. Home-page</a></h5>
+ <h4><a id="home-page" name="home-page">5.5. Home-page</a></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>
- <h5><a id="author" name="author">2.5.6. Author</a></h5>
+ <h4><a id="author" name="author">5.6. Author</a></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>
- <h5><a id="author-email" name="author-email">2.5.7. Author-email</a>
- </h5>
+ <h4><a id="author-email" name="author-email">5.7. Author-email</a>
+ </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
@@ -76,13 +75,13 @@
<p>Example: <a class="reference" href="mailto:john@doe.com">
john@doe.com</a></p>
- <h5><a id="license" name="license">2.5.8. License</a></h5>
+ <h4><a id="license" name="license">5.8. License</a></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>
- <h5><a id="platform" name="platform">2.5.9. Platform</a></h5>
+ <h4><a id="platform" name="platform">5.9. Platform</a></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">
@@ -91,7 +90,7 @@
Python code.</p>
<p>Example: Unix</p>
- <h5><a id="classifier" name="classifier">2.5.10. Classifier</a> </h5>
+ <h4><a id="classifier" name="classifier">5.10. Classifier</a> </h4>
<p>(Classifier Text Line, multiple, optional)</p>
<p>A classification entry identifying the package. This field can be specified
multiple times.</p>
@@ -102,23 +101,23 @@
Modules</dd>
</dl>
- <h5><a id="developers-mailinglist" name="developers-mailinglist">
- 2.5.11. Developers-mailinglist</a></h5>
+ <h4><a id="developers-mailinglist" name="developers-mailinglist">
+ 5.11. Developers-mailinglist</a></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>
- <h5><a id="users-mailinglist" name="users-mailinglist">2.5.12.
- Users-mailinglist</a></h5>
+ <h4><a id="users-mailinglist" name="users-mailinglist">5.12.
+ Users-mailinglist</a></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>
- <h5><a id="issue-tracker" name="issue-tracker">2.5.13.
- Issue-tracker</a></h5>
+ <h4><a id="issue-tracker" name="issue-tracker">5.13.
+ Issue-tracker</a></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>
@@ -126,37 +125,37 @@
href="http://www.zope.org/trackers/sample/">
http://www.zope.org/trackers/sample/</a></p>
- <h5><a id="repository-location" name="repository-location">2.5.14.
- Repository-location</a></h5>
+ <h4><a id="repository-location" name="repository-location">5.14.
+ Repository-location</a></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>
- <h5><a id="repository-web-location" name="repository-web-location">
- 2.5.15. Repository-web-location</a></h5>
+ <h4><a id="repository-web-location" name="repository-web-location">
+ 5.15. Repository-web-location</a></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>
- <h5><a id="certification-level" name="certification-level">2.5.16.
- Certification-level</a></h5>
+ <h4><a id="certification-level" name="certification-level">5.16.
+ Certification-level</a></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>
- <h5><a id="certification-date" name="certification-date">2.5.17.
- Certification-date</a></h5>
+ <h4><a id="certification-date" name="certification-date">5.17.
+ Certification-date</a></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>
- <h5><a id="metadata-version" name="metadata-version">2.5.18.
- Metadata-Version</a></h5>
+ <h4><a id="metadata-version" name="metadata-version">5.18.
+ Metadata-Version</a></h4>
<p>(Text Line, single, required)</p>
<p>This is the version number of this package meta-data.</p>
<p>Example: 1.1</p>
Modified: zf.zscp/trunk/src/zf/zscp/doc/regulations_page06.pt
===================================================================
--- zf.zscp/trunk/src/zf/zscp/doc/regulations_page06.pt 2006-04-11 11:41:35 UTC (rev 66850)
+++ zf.zscp/trunk/src/zf/zscp/doc/regulations_page06.pt 2006-04-11 14:15:25 UTC (rev 66851)
@@ -22,7 +22,7 @@
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">
- <h5><a id="action" name="action">2.6.1. Action</a></h5>
+ <h4><a id="action" name="action">6.1. Action</a></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
@@ -30,8 +30,8 @@
<p>Allowed Values: grant, revoke, warn Example: granted</p>
</div>
<div class="section">
- <h5><a id="source-level" name="source-level">2.6.2.
- Source-level</a></h5>
+ <h4><a id="source-level" name="source-level">6.2.
+ Source-level</a></h4>
<p>(Choice, single, required)</p>
<p>This field describes the original certification level before this
certification action was executed.</p>
@@ -39,8 +39,8 @@
listed</p>
</div>
<div class="section">
- <h5><a id="target-level" name="target-level">2.6.3.
- Target-level</a></h5>
+ <h4><a id="target-level" name="target-level">6.3.
+ Target-level</a></h4>
<p>(Choice, single, required)</p>
<p>This field describes the final certification level after this
certification action was executed.</p>
@@ -48,7 +48,7 @@
level1</p>
</div>
<div class="section">
- <h5><a id="date" name="date">2.6.4. Date</a></h5>
+ <h4><a id="date" name="date">6.4. Date</a></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">
@@ -56,8 +56,8 @@
<p>Example: 2006-02-11</p>
</div>
<div class="section">
- <h5><a id="certification-manager" name="certification-manager">
- 2.6.5. Certification-manager</a></h5>
+ <h4><a id="certification-manager" name="certification-manager">
+ 6.5. Certification-manager</a></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>
@@ -66,7 +66,7 @@
></p>
</div>
<div class="section">
- <h5><a id="comments" name="comments">2.6.6. Comments</a></h5>
+ <h4><a id="comments" name="comments">6.6. Comments</a></h4>
<p>(Text, single, optional)</p>
<p>This field can contain arbitrary comments about the certification
action.</p>
Modified: zf.zscp/trunk/src/zf/zscp/doc/regulations_page07.pt
===================================================================
--- zf.zscp/trunk/src/zf/zscp/doc/regulations_page07.pt 2006-04-11 11:41:35 UTC (rev 66850)
+++ zf.zscp/trunk/src/zf/zscp/doc/regulations_page07.pt 2006-04-11 14:15:25 UTC (rev 66851)
@@ -16,7 +16,7 @@
<p>The following data description is known as the <em>Package Release Data
Version 1.0</em>.</p>
<div class="section">
- <h5><a id="id4" name="id4">2.7.1. Name</a></h5>
+ <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
@@ -24,19 +24,19 @@
<p>Example: Sample Package</p>
</div>
<div class="section">
- <h5><a id="version" name="version">2.7.2. Version</a></h5>
+ <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>
<div class="section">
- <h5><a id="codename" name="codename">2.7.3. Codename</a></h5>
+ <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">
- <h5><a id="id5" name="id5">2.7.4. Date</a></h5>
+ <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">
@@ -44,29 +44,29 @@
<p>Example: 2006-02-01</p>
</div>
<div class="section">
- <h5><a id="certification" name="certification">2.7.5.
- Certification</a></h5>
+ <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">
- <h5><a id="package" name="package">2.7.6. Package</a></h5>
+ <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>2.7.7. Source +++++++++++++x</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">
- <h5><a id="dependency" name="dependency">2.7.8. Dependency</a></h5>
+ <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
@@ -74,8 +74,8 @@
<p>Example: Zope 3.3</p>
</div>
<div class="section">
- <h5><a id="announcement" name="announcement">2.7.9.
- Announcement</a></h5>
+ <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"
@@ -84,8 +84,8 @@
</p>
</div>
<div class="section">
- <h5><a id="release-manager" name="release-manager">2.7.10.
- Release-manager</a></h5>
+ <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>
@@ -94,8 +94,8 @@
></p>
</div>
<div class="section">
- <h5><a id="press-contact" name="press-contact">2.7.11.
- Press-contact</a></h5>
+ <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>
Modified: zf.zscp/trunk/src/zf/zscp/doc/repository_page03.pt
===================================================================
--- zf.zscp/trunk/src/zf/zscp/doc/repository_page03.pt 2006-04-11 11:41:35 UTC (rev 66850)
+++ zf.zscp/trunk/src/zf/zscp/doc/repository_page03.pt 2006-04-11 14:15:25 UTC (rev 66851)
@@ -14,9 +14,9 @@
ZSCP is contained in three data files. The format of each file is described
below.</p>
- <h5><a id="the-publication-data-file"
+ <h4><a id="the-publication-data-file"
name="the-publication-data-file">3.1. The Publication Data
- File</a></h5>
+ File</a></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
@@ -28,9 +28,9 @@
<p>The publication data file is commonly named <tt class="docutils literal">
<span class="pre">PUBLICATION.cfg</span></tt>.</p>
- <h5><a id="the-certification-data-file"
+ <h4><a id="the-certification-data-file"
name="the-certification-data-file">3.2. The Certification
- Data File</a></h5>
+ 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
@@ -70,8 +70,8 @@
</certifications>
</pre>
- <h5><a id="the-release-data-file" name="the-release-data-file"> 3.3.
- The Release Data File</a></h5>
+ <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
Modified: zf.zscp/trunk/src/zf/zscp/doc/repository_page04.pt
===================================================================
--- zf.zscp/trunk/src/zf/zscp/doc/repository_page04.pt 2006-04-11 11:41:35 UTC (rev 66850)
+++ zf.zscp/trunk/src/zf/zscp/doc/repository_page04.pt 2006-04-11 14:15:25 UTC (rev 66851)
@@ -14,8 +14,8 @@
sub-section lists such tools. The full development of those tools is
expected to be a long-term process.</p>
- <h5><a id="automated-test-runner" name="automated-test-runner"> 4.1.
- Automated Test Runner</a></h5>
+ <h4><a id="automated-test-runner" name="automated-test-runner"> 4.1.
+ Automated Test Runner</a></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.
@@ -31,8 +31,8 @@
Unexpected indentation.</div>
<blockquote> the package environment to run the tests.</blockquote>
- <h5><a id="test-coverage-reports" name="test-coverage-reports"> 4.2.
- Test Coverage Reports</a></h5>
+ <h4><a id="test-coverage-reports" name="test-coverage-reports"> 4.2.
+ Test Coverage Reports</a></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,9 +51,9 @@
reports to an HTML page exists. - The better coverage implementation of
SchoolTool needs to be ported.</p>
- <h5><a id="publication-data-verification"
+ <h4><a id="publication-data-verification"
name="publication-data-verification">4.3. Publication Data
- Verification</a></h5>
+ Verification</a></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>
@@ -66,8 +66,8 @@
<blockquote> writer for the publication data must be developed for the ZSCP Web
site anyways.</blockquote>
- <h5><a id="dependency-checker" name="dependency-checker">4.4.
- Dependency Checker</a></h5>
+ <h4><a id="dependency-checker" name="dependency-checker">4.4.
+ Dependency Checker</a></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
@@ -83,8 +83,8 @@
<blockquote> available. Its code could be used to implement this
tool.</blockquote>
- <h5><a id="nightly-tar-ball-testing" name="nightly-tar-ball-testing">
- 4.5. Nightly TAR-ball Testing</a></h5>
+ <h4><a id="nightly-tar-ball-testing" name="nightly-tar-ball-testing">
+ 4.5. Nightly TAR-ball Testing</a></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>
@@ -97,9 +97,9 @@
<blockquote> environment in which the package could be properly
run.</blockquote>
- <h5><a id="coding-style-verification"
+ <h4><a id="coding-style-verification"
name="coding-style-verification">4.6. Coding Style
- Verification</a></h5>
+ Verification</a></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 +115,8 @@
</ul>
<p>Status: - Such a tool is not implemented yet.</p>
- <h5><a id="migration-script-testing" name="migration-script-testing">
- 4.7. Migration Script Testing</a></h5>
+ <h4><a id="migration-script-testing" name="migration-script-testing">
+ 4.7. Migration Script Testing</a></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
Added: zf.zscp/trunk/src/zf/zscp/doc/rest2html.pt
===================================================================
--- zf.zscp/trunk/src/zf/zscp/doc/rest2html.pt 2006-04-11 11:41:35 UTC (rev 66850)
+++ zf.zscp/trunk/src/zf/zscp/doc/rest2html.pt 2006-04-11 14:15:25 UTC (rev 66851)
@@ -0,0 +1,9 @@
+<html metal:use-macro="context/@@standard_macros/view"
+ i18n:domain="zf.zscp">
+ <body>
+ <div metal:fill-slot="body" tal:define="global pageversion string: 0.8">
+ <div tal:replace="structure view/getRest2HTML" />
+ </div>
+ </body>
+
+</html>
\ No newline at end of file
Property changes on: zf.zscp/trunk/src/zf/zscp/doc/rest2html.pt
___________________________________________________________________
Name: svn:keywords
+ Id
Name: svn:eol-style
+ native
Added: zf.zscp/trunk/src/zf/zscp/doc/views.py
===================================================================
--- zf.zscp/trunk/src/zf/zscp/doc/views.py 2006-04-11 11:41:35 UTC (rev 66850)
+++ zf.zscp/trunk/src/zf/zscp/doc/views.py 2006-04-11 14:15:25 UTC (rev 66851)
@@ -0,0 +1,46 @@
+
+##############################################################################
+#
+# Copyright (c) 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.
+#
+##############################################################################
+"""Certification
+
+$Id$
+"""
+__docformat__ = "reStructuredText"
+
+
+import os.path
+
+from zope.app.renderer.rest import ReStructuredTextToHTMLRenderer
+from zope.interface import implements
+from zope.publisher.interfaces.browser import IBrowserPublisher
+
+
+class ReSt2HTMLView(object):
+ """view implementation for SeleniumRegistry ."""
+
+ implements(IBrowserPublisher)
+
+ def __init__(self, context, request):
+
+ self.context = context
+ self.request = request
+
+ def getRest2HTML(self):
+
+ filename = unicode(os.path.join(os.path.dirname(__file__), '..', 'ProcessAndRepository.txt'))
+ source = unicode(open(filename , 'rb').read())
+ return ReStructuredTextToHTMLRenderer(source, self.request).render().strip()
+
+
+
Property changes on: zf.zscp/trunk/src/zf/zscp/doc/views.py
___________________________________________________________________
Name: svn:keywords
+ Id
Name: svn:eol-style
+ native
More information about the Checkins
mailing list