[Checkins] SVN: bluebream/website/docs/v1.0/manual/browserresource.rst bit cleanup

[Baiju M]

Log message for revision 108349:
  bit cleanup
  

Changed:
  U   bluebream/website/docs/v1.0/manual/browserresource.rst

-=-
Modified: bluebream/website/docs/v1.0/manual/browserresource.rst
===================================================================
--- bluebream/website/docs/v1.0/manual/browserresource.rst	2010-01-21 07:44:32 UTC (rev 108348)
+++ bluebream/website/docs/v1.0/manual/browserresource.rst	2010-01-21 08:17:53 UTC (rev 108349)
@@ -5,20 +5,20 @@
 -------------
 
 Certain presentation, like images and style sheets are not associated
-with any other component, so that one cannot create a view. To solve
+with any other component, so that one cannot create a view.  To solve
 this problem, resources were developed, which are presentation
-components that do not require any context. This mini-chapter will
+components that do not require any context.  This mini-chapter will
 demonstrate how resources are created and registered with Zope 3.
 
 The first goal is to register a simple plain-text file called
-resource.txt as a browser resource. The first step is to create this
-file anywhere you wish on the filesystem, and adding the following
-content::
+``resource.txt`` as a browser resource.  The first step is to create
+this file anywhere you wish on the filesystem, and adding the
+following content::
 
-  Hello, I am a Zope 3 Resource Component!
+  Hello, I am a BlueBream Resource Component!
 
 Now just register the resource in a ZCML configuration file using the
-browser resource directive:
+browser resource directive::
 
   <browser:resource
       name="resource.txt"
@@ -29,13 +29,13 @@
 Zope.
 
 Line 3: The file attribute specifies the path to the resource on the
-filessytem. The current working directory ('.') is always the
-directory the configuration file is located. So in the example above,
-the file resource.txt is located in the same folder as the
+filessytem.  The current working directory ('.') is always the
+directory the configuration file is located.  So in the example
+above, the file ``resource.txt`` is located in the same folder as the
 configuration file is.
 
 Line 4: The optional layer attribute specifies the layer the resource
-is added to. By default, the default layer is selected.
+is added to.  By default, the default layer is selected.
 
 Once you hook up the configuration file to the main configuration
 path and restart Zope 3, you should be able to access the resource
@@ -47,27 +47,27 @@
 --------------
 
 If you have an image resource, you might want to use different
-configuration. Create a simple image called img.png and register it
-as follows:
+configuration.  Create a simple image called ``img.png`` and register
+it as follows::
 
-<browser:resource
-    name="img.png"
-    image="img.png"
-    permission="zope.ManageContent" />
+  <browser:resource
+      name="img.png"
+      image="img.png"
+      permission="zope.ManageContent" />
 
 Line 3: As you can see, instead of the file attribute we use the
-image one. Internally this will create an Image object, which is able
-to detect the content type and returns it correctly. There is a third
-possible attribute named template. If specified, a Page Template that
-is executed when the resource is called. Note that only one of file,
-image, or template attributes can be specified inside a resource
-directive.
+image one.  Internally this will create an Image object, which is
+able to detect the content type and returns it correctly.  There is a
+third possible attribute named template.  If specified, a Page
+Template that is executed when the resource is called.  Note that
+only one of file, image, or template attributes can be specified
+inside a resource directive.
 
 Line 4: A final optional attribute is the "permission" one must have
-to view the resource. To demonstrate the security, I set the
+to view the resource.  To demonstrate the security, I set the
 permission required for viewing the image to zope.ManageContent, so
-that you must log in as an administrator/- manager to be able to view
-it. The default of the attribute is zope.Public so that everyone can
+that you must log in as an administrator/manager to be able to view
+it.  The default of the attribute is zope.Public so that everyone can
 see the resource.
 
 
@@ -90,10 +90,10 @@
 The image will then be publically available under the URL:
 http://localhost:8080/@@/resources/img.png
 
-The DirectoryResource object uses a simple resource type recognition.
-It looks at the filename extensions to discover the type.  For page
-templates, currently the extensions ''pt'', ''zpt'' and ''html'' are
-registered and for an image ''gif'', ''png'' and ''jpg''.  All other
-extensions are converted to file resources.  Note that it is not
-necessary to have a list of all image types, since only
-Browser-displayable images must be recognized.
+The directory resource object uses a simple resource type
+recognition.  It looks at the filename extensions to discover the
+type.  For page templates, currently the extensions ``pt``, ``zpt``
+and ``html`` are registered and for an image ``gif``, ``png`` and
+`jpg``.  All other extensions are converted to file resources.  Note
+that it is not necessary to have a list of all image types, since
+only Browser-displayable images must be recognized.