[mirrorbrain-commits] r8147 - /trunk/docs/configuration.rst

Author: poeml
Date: Sun Sep 19 19:55:19 2010
New Revision: 8147

URL: http://svn.mirrorbrain.org/viewvc/mirrorbrain?rev=8147&view=rev
Log:
docs/configuration:
- add instructions for styling of mirrorlist pages

Modified:
    trunk/docs/configuration.rst

Modified: trunk/docs/configuration.rst
URL: http://svn.mirrorbrain.org/viewvc/mirrorbrain/trunk/docs/configuration.rst?rev=8147&r1=8146&r2=8147&view=diff
==============================================================================
--- trunk/docs/configuration.rst (original)
+++ trunk/docs/configuration.rst Sun Sep 19 19:55:19 2010
_at_@ -211,6 +211,37 @@
   required to be Base32-encoded. Base32 encoding could be added in the future,
   of course.  Contributions welcome!
 
+
+.. _styling_details_pages:
+
+Styling the mirrorlist / details pages
+--------------------------------------
+
+MirrorBrain generates per-file pages with all known metadata and a list of
+mirrors. This is triggered by appending ``.mirrorlist`` or ``?mirrorlist`` to a
+request. The pages are delivered with character set UTF-8 in the Content-type
+header.
+
+The content of these pages are wrapped into a XHTML/HTML ``DIV`` container with
+``id="mirrorbrain-details"``. This gives a means for styling in conjunction
+with a stylesheet linked in via the ``MirrorBrainMirrorlistStyleSheet``
+Apache config directive. ``MirrorBrainMirrorlistStyleSheet`` goes into
+virtualhost context and takes an URL, which can be relative or absolute.
+Either of the following would work::
+
+    MirrorBrainMirrorlistStyleSheet "http://www.poeml.de/~poeml/mirrorbrain.css"
+    MirrorBrainMirrorlistStyleSheet "/mirrorbrain.css"
+
+Further, arbitrary design can be achieved by specifying the XHTML/HTML
+header and footer which are placed around the page body instead of the built-in
+XHTML. This is configured with the following two Apache configuration
+directives, which go into virtualhost context::
+
+    # Absolute path to header to be included at the top
+    MirrorBrainMirrorlistHeader /srv/www/htdocs/mb-header.html
+
+    # Absolute path to footer to be appended
+    MirrorBrainMirrorlistFooter /srv/www/htdocs/mb-footer.html
 
 
 Using mod_mirrorbrain without GeoIP




_______________________________________________
mirrorbrain-commits mailing list
Archive: http://mirrorbrain.org/archive/mirrorbrain-commits/

Note: To remove yourself from this list, send a mail with the content
 	unsubscribe
to the address mirrorbrain-commits-request_at_mirrorbrain.org