← Back to branch summary

~crc-x/+junk/old-forthlets

« back to all changes in this revision

Viewing changes to rxweb/README.rst

  • Committer: Charles Childers
  • Date: 2010-01-15 05:00:22 UTC
  • Revision ID: git-v1:b06537131be8245b64ea534415ed85aae04ca1ef
rxweb merged into this repo

Show diffs side-by-side

added added

removed removed

Lines of Context:
rxweb/README.rst
 
1
Overview
 
2
--------
 
3
RxWeb is an attempt to develop a framework for building small websites and applications using Retro.
 
4
 
 
5
Requirements
 
6
------------
 
7
 
 
8
- Linux, BSD, or MacOS X
 
9
 
 
10
- Perl (to run the www-server)
 
11
 
 
12
- Make (for building)
 
13
 
 
14
- Retro (console implementation)
 
15
 
 
16
 
 
17
Features
 
18
--------
 
19
 
 
20
- Pages are stored in the image
 
21
 
 
22
- Syntax is clean
 
23
 
 
24
- Use any Retro words or constructs
 
25
 
 
26
- Word names = page names
 
27
 
 
28
 
 
29
Todo
 
30
----
 
31
Want to help? Here's some stuff that needs to be done:
 
32
 
 
33
- Better support for embedding stylesheets, scripts
 
34
 
 
35
- Optionally escape output automatically:
 
36
 
 
37
- Testing
 
38
 
 
39
Example
 
40
-------
 
41
 
 
42
::
 
43
 
 
44
   : /
 
45
    ( html
 
46
      ( head ( title ." Demo Page" ) )
 
47
      ( body
 
48
        ( h1 ." Welcome to Retro" )
 
49
        ( p ." This is a test of the WWW package." )
 
50
      )
 
51
    )
 
52
   ;
 
53
 
 
54
 
 
55
The syntax is lispy, and is derived from Stefan's old retroweb system.
 
56
 
 
57
Links
 
58
-----
 
59
 
 
60
::
 
61
 
 
62
   attr: href='url' ( a .... )
 
63
 
 
64
Properties
 
65
----------
 
66
 
 
67
::
 
68
 
 
69
   id: name
 
70
   ( element ..... )
 
71
 
 
72
   class: name
 
73
   ( element ..... )
 
74
 
 
75
   attr: ....
 
76
   ( element ..... )
 
77
 
 
78
When using properties, you can not have spaces in the line.
 
79
 
 
80
CSS
 
81
---
 
82
 
 
83
::
 
84
 
 
85
   css: URL
 
86
 
 
87
Scripts
 
88
-------
 
89
 
 
90
::
 
91
 
 
92
   script: URL