zenweb 2.18.1 → 3.0.0.b1

data/docs/Customizing

@@ -1,76 +0,0 @@
-# 'title' = 'Customizing'
-# 'subtitle' = 'Tweaking your site'
-# "description" = "Describes how to really customize ZenWeb to your liking."
-
-** Starting Questions
-
-This document will attempt to show you how renderers work and how to
-create your own to make a website render the way you want it to.
-
-The first step is to decide that you really need to write code to do
-what you want to do. There is a chance that the software already does
-what you want. Take a look at what #{TextToHTML} options exist for
-you. If it is a style issue, it might be addressed by a variable
-listed there.
-
-If however, this is a structural issue (eg, you don't like the navbars
-provided by HtmlTemplateRenderer) then you'll probably have to write
-some code. If you think that your extension is generally useful,
-please email #{support} and tell me about it. I might be willing to
-write it for you if I get the chance to extend the capabilities of the
-system. That way everyone wins. But, if this is something specific to
-your site, and not terribly reusable, read on...
-
-The second step, assuming you get this far, is to decide if your
-change requires an extension to an existing renderer (eg, modify the
-navbar supplied by HtmlTemplateRenderer), or if it requires an
-entirely new renderer (eg, something like XsltRenderer).
-
-** Extending an Existing Renderer
-
-Lets say you hate the navbar supplied by
-HtmlTemplateRenderer. Customizing it is pretty easy and involves these
-steps:
-
-+ Copy XXXRenderer to MyHtmlTemplateRenderer.
-+ Globally replace "XXX" with "MyHtmlTemplate".
-+ Change the require statement from 'ZenWeb/GenericRenderer' to 'ZenWeb/HtmlTemplateRenderer'.
-+ Change the superclass from 'GenericRenderer' to 'HtmlTemplateRenderer'.
-+ Instead of defining 'render', change it to 'navbar'.
-+ Write the code to return the type of navbar you want.
-+ Fill in remaining "YYY" sections (mostly doco) w/ appropriate verbage.
-
-** Writing a New Renderer
-
-Lets say you want to write XsltRenderer, not that I have a clue about
-XSLT... Creating a new renderer is fairly easy:
-
-
-+ Copy XXXRenderer to XsltRenderer.
-+ Globally replace "XXX" with "Xslt".
-+ Define render. In this example, it might be difficult, but some of the renderers are dirt simple and small... Check them out for examples and help.
-+ Fill in remaining "YYY" sections (mostly doco) w/ appropriate verbage.
-
-** Renderer Requirements
-
-A renderer is dirt simple. It simply needs to define the method
-render, which takes an array of input, and returns an array of
-output. Other than that, you are free to do whatever you want.
-
-** GenericRenderer Utilities
-
-GenericRenderer has a few utility methods. First, GenericRenderer
-instantiates an instance variable called @result. You need not use it
-at all, but the utility methods do. GenericRenderer also provides the
-following methods:
-
-+ push(obj) - appends obj to @result. If obj is an array, it recursively calls push on each item in obj. If it is not an array, it calls to_s on it and pushes onto @result.
-+ unshift(obj) - like push, but prepends.
-
-** Other Notes:
-
-Other things to remember:
-
-+ @document is the instance of the ZenDocument that you are rendering. url and subpages are useful methods of this class.
-+ @sitemap  is the instance of the ZenSiteMap for this site. documents or doc_order might be useful to you.
-+ @website  is the instance of the ZenWebsite for this site. Not too much useful here, that I've used anyway... It's mainly a manager class...

data/docs/FAQ

@@ -1,12 +0,0 @@
-# 'title' = 'Frequently Asked Questions'
-# "description" = "FAQ for ZenWeb"
-# "keywords" = "ZenWeb, FAQ"
-
-** Dump it quick, organize later
-
-%- Q: I don't want to use ZenWeb for a whole domain, just a small portion of the website, but it keeps making absolute URLs that don't work well for this design. How can I use ZenWeb?
-%= A: Add RelativeRenderer to your list of renderers in your top level metadata.txt file. If you used ZenWebsite.rb to create your website, the entry should be there, otherwise add "'renderers' = [ 'StandardRenderer', 'RelativeRenderer' ]".
-
-%- Q: XXX
-%= A: YYY
-

data/docs/Features

@@ -1,128 +0,0 @@
-# 'title' = 'Features'
-# 'subtitle' = 'Markup and Variables'
-# "description" = "Demonstrates the various text-to-HTML embellishments in ZenWeb."
-
-This document will attempt to show you how many of the html markup features work. 
-
-** Markup:
-
-The only Head 1 is the title.
-
-  ** Head 2
-  
-  *** Head 3
-  
-  **** Head 4
-  
-  ***** Head 5
-  
-  ****** Head 6
-
-creates:
-
-** Head 2
-
-*** Head 3
-
-**** Head 4
-
-***** Head 5
-
-****** Head 6
-
-  + Lists (should have two items).
-  + Continuted Lists.
-
-creates:
-
-+ Lists (should have two items).
-+ Continuted Lists.
-
-  + Another List (should have a sub list).
-  	+ With a sub-list
-  	+ http\://www.ZenSpider.com/ and mailto\:support@ZenSpider.com.
-  + A glossary entry to #{Your Own Website} and #{support} (see metadata.txt for a hint).
-
-creates:
-
-+ Another List (should have a sub list).
-	+ With a sub-list
-	+ http://www.ZenSpider.com/ and mailto:support@ZenSpider.com.
-+ A glossary entry to #{Your Own Website} and #{support} (see metadata.txt for a hint).
-
-  Paragraphs can contain http://www.ZenSpider.com/ and mailto:support@ZenSpider.com and they will automatically be converted. Rules are automatically converted as well...
-
-creates:
-
-Paragraphs can contain http://www.ZenSpider.com/ and mailto:support@ZenSpider.com and they will automatically be converted. Rules are automatically converted as well...
-
-  Likewise, two lines side by side
-  are considered one paragraph.
-
-creates:
-
-Likewise, two lines side by side
-are considered one paragraph.
-
-  More Paragraphs with \<I\>Embedded HTML\</I\>.
-  Same as More Paragraphs.
-
-creates:
-
-More Paragraphs with <I>Embedded HTML</I>.
-Same as More Paragraphs.
-
-  ---
-
-creates:
-
----
-
-  ===
-
-creates:
-
-===
-
-** Metadata Variables:
-
-Metadata variables can be defined in the page itself, or in any
-metadata.txt file in the directory tree. Scoping is from top down, so
-the lowest definition wins.
-
-Here is a list of the variables in use by HtmlTemplateRenderer:
-
-%- author
-%= added as a META tag if it exists, I suggest NOT putting your email in here.
-%- banner
-%= graphic at the top of the page, usually a logo
-%- bgcolor
-%= defaults to not being defined
-%- copyright
-%= added as a META tag if it exists.
-%- description
-%= added as a META tag if it exists
-%- dtd
-%= Doctype declaration of the document. (default: 'DTD HTML 4.0 Transitional')
-%- email
-%= used in a mailto in metadata
-%- keywords
-%= added as a META tag for search engines.
-%- rating
-%= added as a meta tag for filter services (default: 'general')
-%- stylesheet
-%= CSS stylesheet URL.
-%- style
-%= CSS code applied directly to the page. style and stylesheet are not mutually exclusive.
-%- subtitle
-%= Subtitle of document.
-%- title
-%= Title of document. (default: 'Unknown Title')
-%- charset
-%= Character encoding for the page.
-%- force
-%= Set to true (no quotes necessary) to force page to render every time.
-
-Additionally, HeaderRenderer and FooterRenderer use entries called
-'header' and 'footer' respectively.
-

data/docs/Presentation

@@ -1,88 +0,0 @@
-# "title" = "Presentation"
-# "subtitle" = "For Talks on ZenWeb"
-# "keywords" = "ZenWeb, Presentation"
-
-** Philosophy:
-
-The primary focus of ZenWeb is to improve the signal-to-noise ratio so
-that you can get work done and published quickly and easily. This
-means when I want to make a new mostly empty webpage, I should be able
-to do so and have it out on the web in about 30 seconds. Putting
-actual content out there shouldn't be much harder than typing in your
-favorite text editor and saving.
-
-A secondary focus of ZenWeb is that everything revolves around the
-sitemap. The sitemap determines the structure of the entire website
-and is used to determine what pages to render.
-
-** Class Heirarchy:
-
-[see heirarchy.png]
-
-The class hierarchy is as simple as possible, with only 5 top level
-classes and 10 concrete renderers.
-
-** Basic Design:
-
-[see heirarchy.png]
-
-Simple run:
-
-  Website#new
-    ZenSitemap#new
-      parse sitemap
-      foreach page listed
-        ZenDocument#new
-    foreach document in sitemap
-      parent = doc.parenturl
-      parent.addSubpage(doc)
-  Website#renderSite
-    foreach document in sitemap
-      doc.render
-
-** Metadata scoping:
-
-A Metadata instance is essentially just a multi-directory file-based
-hash. Child directories can have additional metadata that can override
-parent directory entries. In addition, files in a website can also
-define their own metadata. 
-
-Metadata is used for a number of purposes from defining simple urls to
-make the text cleaner, to defining what renderers get triggered for a
-given page or sub-directory.
-
-** Renderers:
-
-Renderers are basic filters, much like unix pipes. Each one should do
-one simple task taking an array of strings and returning an array of
-strings. Supplied renderers include:
-
-+ GenericRenderer
-	+ CompositeRenderer
-		+ StandardRenderer
-	+ SitemapRenderer
-	+ HtmlRenderer
-		+ HtmlTemplateRenderer
-		+ TextToHtmlRenderer
-	+ SubpageRenderer
-	+ MetadataRenderer
-	+ HeaderRenderer
-	+ FooterRenderer
-	+ RubyCodeRenderer
-
-Future renderers could be much more powerful and do things like render
-themes based on the user prefs, render PDF instead of HTML,
-or... whatever... 
-
-** Iterative Builds:
-
-Last but not least, with large websites it becomes increasingly
-important not to waste time rendering pages that don't change. ZenWeb
-has basic 'make' like functionality and will not render pages that
-don't need it.
-
-Right now it's an incredibly simple mechanism. It doesn't understand
-the relationships between pages. It currently only renders pages who's
-source pages have changed, but not pages that link that page. This
-isn't very important as it only really has impact if the title or
-subtitle changes.

data/docs/QuickStart

@@ -1,32 +0,0 @@
-# "title" = "Installation Quickstart"
-# "subtitle" = "Quick guide to setting up ZenWeb"
-# "keywords" = "ZenWeb, instructions, Quick Start"
-
-** Requirements:
-
-+ ruby 1.6.x, may work w/ previous versions.
-+ Test::Unit ruby package installed. Get from #{raa}.
-+ Minimal understanding of Ruby:
-	+ You are _expected_ to understand Ruby minimally to build a site (installation and basic use). It isn't hard to install on either UNIX or the macintosh, I've never used it on windoze but I've been told it is fairly easy there as well.
-	+ You are expected to understand Ruby programming only if you want to customize site/page layout. This includes, navigation, headers and footers, and general page layout. The basic setup will look like http://www.zenspider.com/ otherwise.
-
-** Instructions:
-
-+ Unpack the package. You've probably already done this.
-+ Test your ruby installation. Run 'irb':
-	+ At the prompt type "1+1" and make sure it outputs "2".
-	+ That states that, yes, you installed ruby correctly.
-+ Run 'make test'. 
-	+ If all is well, you should have zero errors listed after running all of the tests. 
-	+ If not, email #{support}. I respond quickly to problems.
-+ Run 'make docs'.
-	+ A new directory docshtml should now exist.
-+ View docshtml in your browser.
-	+ If you have apache you can quickly serve these pages (on unix):
-		+ Run 'make apache'
-		+ a private httpd will fire up running on port 8080.
-	+ Otherwise, open the file directly in your browser
-	+ Read all the pages, but start with #{Your Own Website}.
-
-Any questions, flames, requests, whatever should be sent to
-#{support}. Thank you.

data/docs/Renderers

@@ -1,85 +0,0 @@
-# 'title' = 'Renderers'
-# 'subtitle' = 'Standard Filters for ZenWeb'
-
-** FooterRenderer
-
-FooterRenderer inserts the contents of the metadata variable 'footer'
-at the end of the document OR in front of a close-HTML tag, whichever
-comes first.
-
-** HeaderRenderer
-
-HeaderRenderer inserts the contents of the metadata variable 'header'
-at the end of the document OR following an open-HTML tag.
-
-** HtmlTableRenderer
-
-An add-on that converts blocks delimited with \<tabs\>\</tabs\> and separated with tabs into an html table. Example:
-
-  \<tabs\>
-  a  b                  c
-  d  bigger table cell  f
-  \</tabs\>
-
-becomes:
-
-<tabs>
-a	b			c
-d	bigger table cell	f
-</tabs>
-
-** HtmlTemplateRenderer
-
-Is responsible for the overall structure of a page. It has a standard
-HTML header and footer (ie, html, head, and body tags), as well as
-some extra structure to the page like presenting the title and
-subtitle as an H1 and creating a top and bottom navbar. There are a
-lot of metadata variables available for customizing this renderer, see
-<!--hack-->#{Features} for more details.
-
-** MetadataRenderer
-
-Expands metadata variable references of the form #\{varname} into the
-value associated to varname.
-
-** RelativeRenderer
-
-Converts HREF urls to relative urls. Nice if you are not renderering
-the entire site.
-
-** RubyCodeRenderer
-
-Evaluates blocks that are preceded with "!" characters and shows the
-code and the result together. NOTE: this feature is really weak and
-will require an overhaul to irb (read: not my code) to work properly.
-
-** SitemapRenderer
-
-Renders sitemaps into lists of links.
-
-** StandardRenderer
-
-A composite of a bunch of renderers. Provides a fairly standard
-feature-set.
-
-** SubpageRenderer
-
-Adds links to sub-pages (pages below the current page in the site-map
-heirarchy).
-
-** TextToHtmlRenderer
-
-Does a bizillion conversions from plain text to HTML. See
-<!--hack-->#{TextToHTML} for a full description.
-
-** TocRenderer
-
-Generates and inserts a table-of-contents at the beginning of the
-documents. It is generated from the plain-text header (eg "**")
-entries.
-
-** Abstract Renderers
-
-There are three other renderers not listed here, CompositeRenderer,
-GenericRenderer, and HtmlRenderer. These are abstract classes and are
-only of interest to you if you are #{customizing} ZenWeb.

data/docs/SiteMap

@@ -1,13 +0,0 @@
-# 'description' = 'This is the demo sitemap.'
-# 'keywords' = 'map, website, ZenWeb'
-# 'renderers' = ['SitemapRenderer', 'StandardRenderer' ]
-
-/index.html
-/SiteMap.html
-/QuickStart.html
-/YourOwnWebsite.html
-/Features.html
-/Renderers.html
-/Customizing.html
-/Presentation.html
-/FAQ.html

data/docs/YourOwnWebsite

@@ -1,32 +0,0 @@
-# "title" = "Your Own Website"
-# "subtitle" = "How to use ZenWeb"
-# "description" = "Quick guide to converting an existing website or creating a new one."
-# "keywords" = "ZenWeb, instructions, website creation"
-
-ZenWeb is supposed to be rather easy to use. This documentation site
-is intended to be a demonstration that it is easy. If this takes me
-more than 10 minutes to do (including typing these pages), then I have
-failed my job.
-
-** How to make a site from scratch:
-
-+ Run the following commands:
-	+ <CODE>ZenWebsite.rb mysite</CODE>
-	+ <CODE>cd mysite</CODE>
-	+ <CODE>ZenWebsite.rb data/second</CODE>
-	+ Edit data/SiteMap and put "/second.html" where you'd like it
-	+ <CODE>make</CODE>
-+ Edit as you see fit.
-+ See the #{TextToHTML} page for markup hints and tips.
-
-** How to add a page to your site:
-
-+ Modify mysite/SiteMap and add the url to the page, including .html, excluding the domain of the url (ex: "/blah.html").
-+ Run the following commands:
-	+ <CODE>ZenWebpage.rb data/blah.html</CODE>
-	+ <CODE>make</CODE>
-
-** How to convert an old site:
-
-+ Do the same as the new site instructions, except:
-	+ For each file, remove your HTML header and footer code.