[Checkins] SVN: z3c.securitytool/trunk/ Updated Documentation for restructuredText format

[Daniel Blackburn]

Log message for revision 84537:
  Updated Documentation for restructuredText format

Changed:
  U   z3c.securitytool/trunk/README.txt
  U   z3c.securitytool/trunk/setup.py
  U   z3c.securitytool/trunk/src/z3c/securitytool/README.txt

-=-
Modified: z3c.securitytool/trunk/README.txt
===================================================================
--- z3c.securitytool/trunk/README.txt	2008-03-07 18:09:32 UTC (rev 84536)
+++ z3c.securitytool/trunk/README.txt	2008-03-07 18:20:45 UTC (rev 84537)
@@ -1,11 +1,20 @@
+================
+z3c.securitytool
+================
 
-=====================================
-Zope3 SecurityTool (z3c.securitytool)
-=====================================
+z3c.securitytool is a Zope3 package aimed at providing component level
+security information to assist in analyzing security problems and to
+potentially expose weaknesses. The goal of the security tool is to
+provide a matrix of users and their effective permissions for all available
+views for any given component and context. We also provide two further
+levels of detail. You can view the details of how a user came to have
+the permission on a given view, by clicking on the permission in the matrix.
 
-  This package is used as a tool to view all the permissions for any
-  view in any context. These permissions are gathered from the roles
-  groups and of course directly provided permissions.
+.. image::
+  http://farm3.static.flickr.com/2085/2294946406_607a043fa1.jpg?v=0  
+  :height: 200
+  :width: 400
+  :target: http://flickr.com/photos/blackburnd/
 
 =================
 Demo Instructions
@@ -19,8 +28,6 @@
 - ``# ./bin/buildout``
 - ``# ./bin/demo fg``
 
-
-``Demo``
 Then access the demo site using:
 
 - http://localhost:8080/++skin++SecurityTool/securityMatrix.html
@@ -38,3 +45,21 @@
 
 ``(These settings are  added when the database is first opened``
    ``You can find these settings in demoSetup.py)``
+
+
+==============================================
+How to use the securityTool with your project:
+==============================================
+Remember this is a work in progress.
+
+1. Add the z3c.securitytool to your install_requires in your
+   setup.py. 
+2. Add the <include package="z3c.securitytool"/> to your site.zcml
+3. Use the skin `++skin++SecurityTool` to access securityTool pages
+4. Append @@securityMatrix.html view to any context to view the permission
+   matrix for that context using the security tool skin.
+
+  For example:
+  http://localhost:8080/++skin++SecurityTool/Folder1/@@securityMatrix.html
+
+

Modified: z3c.securitytool/trunk/setup.py
===================================================================
--- z3c.securitytool/trunk/setup.py	2008-03-07 18:09:32 UTC (rev 84536)
+++ z3c.securitytool/trunk/setup.py	2008-03-07 18:20:45 UTC (rev 84537)
@@ -33,9 +33,7 @@
     description = "A security audit tool and demo for Zope3 views",
     long_description=(
         read('README.txt')
-        + '\n\n' +
-        'Detailed Documentation\n'
-        '**********************\n'
+        + '\n\n'
         + '\n' + chapters
 
         + '\n\n' +

Modified: z3c.securitytool/trunk/src/z3c/securitytool/README.txt
===================================================================
--- z3c.securitytool/trunk/src/z3c/securitytool/README.txt	2008-03-07 18:09:32 UTC (rev 84536)
+++ z3c.securitytool/trunk/src/z3c/securitytool/README.txt	2008-03-07 18:20:45 UTC (rev 84537)
@@ -1,39 +1,7 @@
-================
-z3c.securitytool
-================
+======================
+Detailed Documentation
+======================
 
-z3c.securitytool is a Zope3 package aimed at providing component level
-security information to assist in analyzing security problems and to
-potentially expose weaknesses. The goal of the security tool is to
-provide a matrix of users and their effective permissions for all available
-views for any given component and context. We also provide two further
-levels of detail. You can view the details of how a user came to have
-the permission on a given view, by clicking on the permission in the matrix.
-
-.. image::
-  http://farm3.static.flickr.com/2085/2294946406_607a043fa1.jpg?v=0  
-  :height: 200
-  :width: 400
-  :target: http://flickr.com/photos/blackburnd/
-
-How to use the securityTool with your project:
-----------------------------------------------
-Remember this is a work in progress.
-
-1. Add the z3c.securitytool to your install_requires in your
-   setup.py. 
-2. Add the <include package="z3c.securitytool"/> to your site.zcml
-3. Use the skin `++skin++SecurityTool` to access securityTool pages
-4. Append @@securityMatrix.html view to any context to view the permission
-   matrix for that context using the security tool skin.
-
-  For exapmple:
-  http://localhost:8080/++skin++SecurityTool/Folder1/@@securityMatrix.html
-
-
-Desired Behavior
-----------------
-
 On the page you will be able to select the desired skin from all the
 available skins on the system.  On initial load of the securitytool
 you will only see permissions for IBrowserRequest and your current 
@@ -48,9 +16,6 @@
 When you click on a user-name all the permissions inherited from
 roles, groups or specifically assigned will be displayed.
 
-Detailed Documentation
-----------------------
-
     >>> import zope
     >>> from zope.app import zapi
     >>> from pprint import pprint