public
Rubygem
Description: A lightweight and flexible website management system.
Homepage: http://webby.rubyforge.org/
Clone URL: git://github.com/TwP/webby.git
updating documentation
TwP (author)
Sat Mar 08 21:33:35 -0800 2008
commit  31f674bfceb5a845668929250ad5e88f350c4f9c
tree    ed2530e9475b10eabb659f82276921fb582232f9
parent  434cbf64fc0e82f8a7b987e2b9874d43e2112e9f
...
25
26
27
 
28
29
30
...
25
26
27
28
29
30
31
0
@@ -25,6 +25,7 @@ PROJ.rdoc_exclude << %w(^data ^examples)
0
 PROJ.svn = true
0
 PROJ.spec_opts << '--color'
0
 
0
+PROJ.ann_email[:to] << 'webby-forum@googlegroups.com'
0
 PROJ.ann_email[:server] = 'smtp.gmail.com'
0
 PROJ.ann_email[:port] = 587
0
 
...
133
134
135
 
 
 
 
 
 
 
136
137
138
...
133
134
135
136
137
138
139
140
141
142
143
144
145
0
@@ -133,6 +133,13 @@ ul
0
   ul
0
     :margin-bottom 0
0
 
0
+table.reference
0
+ :width 100%
0
+ td
0
+ :padding 2px 5px
0
+ ul
0
+ :margin-bottom 0
0
+
0
 span.heading-num
0
   :margin-right 10px
0
 
...
13
14
15
16
 
17
18
19
20
21
22
23
 
 
 
 
24
25
26
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
27
28
29
...
13
14
15
 
16
17
18
19
 
 
 
 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
0
@@ -13,17 +13,41 @@ p(title). Table of Contents
0
 <toc />
0
 </div>
0
 
0
-h3{clear:none}. Resources
0
+h3. Resources
0
 
0
 Resources are the files that are found in the _content_ and _layouts_ folders of a webby site. They come in the following four flavors:
0
 
0
-* Files
0
-* Pages
0
-* Partials
0
-* Layouts
0
+* *Pages* -- contain meta-data at the top of the file, are found in the content folder, and are processed by the Webby filter engine
0
+* *Files* -- are found in the content folder and copied "as is" to the output folder
0
+* *Partials* -- contain snippets of text that can be used in multiple locations; partial filenames begin with an underscore are are _not_ copied to the output folder
0
+* *Layouts* -- are found in the layout folder and provide the basic framework of the webpage - the header, the footer, the navigation
0
 
0
 h3. Attributes
0
 
0
+Attributes are defined in the meta-data section of pages and layouts.
0
+
0
+table(reference).
0
+| *destination* | Defines the path in the output directory where the rendered page should be stored. |
0
+| *dirty* | The dirty flag is used to determine whether the page should rendered or not. Normally this is automatically determined by the filter engine, but it can be overridden by setting this attribute. If the dirty flag is set to _true_ then the page will always be rendered. If the dirty flag is set to _false_ then the page will never be rendered. |
0
+| *extension* | Defines the extension that will be appended to the filename of the rendered page in the output folder. The extension is determined by looking at the following:
0
+* the meta-data of the current page for an @extension@ attribute
0
+* the meta-data of layout file of the current page for an @extension@ attribute
0
+* the extension of this page file in the _content_ folder |
0
+| *filter* | Defines the list of filters that will be applied to the contents of this page. If left blank, then the default filter will be applied to the page contents. |
0
+| *layout* | Defines the layout that the page contents will be rendered into. The default layout will be used if this attribute is not defined. The value of @nil@ should be specified if the page should not be rendered into any layout. |
0
+
0
+The following attributes are defined for each page in the content folder. These attributes cannot be changed in the page's meta-data section. However, they are available to the ERB filter when rendering the contents of a page.
0
+
0
+table(reference).
0
+| *path* | The full path to the file in the _content_ folder |
0
+| *dir* | The relative directory in the output folder where the page will be rendered |
0
+| *filename* | The name of the file in the _content_ folder excluding any path information |
0
+| *ext* | The extension of the file in the _content_ folder |
0
+| *mtime* | The modification time of the file in the _content_ folder |
0
+| *number* | Reserved variable used for multi-page content |
0
+| *url* | A URL suitable for creating a link to the page |
0
+| *render* | Returns the contents of the page as rendered by the Webby filter engine |
0
+
0
 h3. Filters
0
 
0
 h3. ERB Variables & Methods
...
17
18
19
20
21
22
23
24
25
26
...
17
18
19
 
 
 
 
20
21
22
0
@@ -17,10 +17,6 @@ Logging::Appender.stdout.layout = Logging::Layouts::Pattern.new(
0
     :date_pattern => "%H:%M:%S" # date == HH:MM:SS
0
 )
0
 
0
-# TODO: send rendered page text to a temporary location?
0
-# this might be useful for parsing through all the rendered pages
0
-# looking for links to other pages
0
-
0
 module Webby
0
 
0
   # :stopdoc:

Comments

    No one has commented yet.