Changeset 8112
- Timestamp:
- 02/14/08 15:39:00 (2 years ago)
- svm:headrev:
c624a6cb-57d4-0310-9736-a25a8df6d016:12830- svk:copy_cache_prev:
- 8095
- Location:
- mirror/edenwall/nulog2/trunk/doc
- Files:
-
- 1 removed
- 4 modified
-
Makefile (modified) (2 diffs)
-
intro.rst (modified) (3 diffs)
-
pages.rst (modified) (5 diffs)
-
sessions.rst (modified) (3 diffs)
-
vocabulary.rst (deleted)
Legend:
- Unmodified
- Added
- Removed
-
mirror/edenwall/nulog2/trunk/doc/Makefile
r8039 r8112 1 2 TXT_FILES = intro.rst pages.rst tables.rst sessions.rst vocabulary.rst gettext.rst ajax.rst nucentral.rst 3 HTML_FILES = $(TXT_FILES:.rst=.html) 1 RST_FILES = $(wildcard *.rst) 2 HTML_FILES = $(RST_FILES:.rst=.html) 4 3 5 4 all: $(HTML_FILES) … … 7 6 8 7 %.html: %.rst 9 rst2html < $< >$@8 rst2html $< $@ 10 9 11 10 clean: -
mirror/edenwall/nulog2/trunk/doc/intro.rst
r6513 r8112 3 3 ************ 4 4 5 I. Presentation 6 =============== 5 .. section-numbering:: 7 6 8 Nulog 2 works with Nevow+Twisted framework. 7 Presentation 8 ============ 9 10 Nulog 2 works with `Nevow`_ + `Twisted`_ framework. 9 11 10 12 There are three components: 11 13 12 1.Nulog-core13 ---------- ---14 Nulog-core 15 ---------- 14 16 15 17 This is the backend of Nulog2. All operations will be do here. 16 18 17 2.Nulog-web18 --------- ---19 Nulog-web 20 --------- 19 21 20 22 Nulog2's frontend, it uses Nevow framework to create webpages, listen … … 22 24 create HTML render. 23 25 24 3.NuCentral25 --------- ---26 NuCentral 27 --------- 26 28 27 29 Nulog2 is designed to be a part of NuCentral. … … 34 36 doesn't care about. Call will be cloaking. 35 37 36 To have more informations about NuCentral, see itsdocumentation.38 To have more informations about NuCentral, see `NuCentral`_ documentation. 37 39 38 40 If you don't want to use NuCentral, you can launch the wrapper, nulog.tac. 39 41 40 42 It simulates NuCentral work but will only work in local mode. 43 44 45 Documentations list 46 =================== 47 48 * `Ajax`_ 49 * `Create a new page`_ 50 * `Gettext`_ 51 * `NuCentral`_ 52 * `Sessions`_ 53 * `Tables`_ 54 55 56 Vocabulary (HTML names) 57 ======================= 58 59 * **Page**: The name of the page. This is the main HTML document. 60 * **Content**: This is the content of the page, between left menu, search bar and title bar. 61 * **Fragment**: This is a part of page. 62 * **function**: Function name of a fragment table. 63 64 .. _Ajax: ajax.html 65 .. _Gettext: gettext.html 66 .. _Create a new page: pages.html 67 .. _Sessions: sessions.html 68 .. _NuCentral documentation: nucentral.html 69 .. _Tables: tables.html 70 71 .. _Nevow: http://divmod.org/trac/wiki/DivmodNevow 72 .. _Twisted: http://twistedmatrix.com/ 73 -
mirror/edenwall/nulog2/trunk/doc/pages.rst
r6513 r8112 1 ***** 2 Pages 3 ***** 1 ************************** 2 Create a new page in NuLog 3 ************************** 4 4 5 I. Introduction 6 =============== 5 .. contents:: 6 .. section-numbering:: 7 8 Introduction 9 ============ 7 10 8 11 Add a page on Nulog-web is really easy. … … 15 18 When you'll read this documentation, I think Nulog2 will have already this page. 16 19 17 II.XML Creation18 ============ ====20 XML Creation 21 ============ 19 22 20 23 First, you can create the .xml file like this:: … … 50 53 python functions. 51 54 52 III.UserInfo Object53 =============== =====55 UserInfo Object 56 =============== 54 57 55 58 You can move in **nulog-web/**, open **infopage.py** and go to … … 124 127 multitable=True, switch=False, pie=True)] 125 128 126 III.BackEnd127 ======= =====129 BackEnd 130 ======= 128 131 129 132 Some details must be changed in backend. … … 142 145 None]}) 143 146 144 IV.Conclusion145 ========== ====147 Conclusion 148 ========== 146 149 147 150 You have made a page for nulog. It was really easy, no? -
mirror/edenwall/nulog2/trunk/doc/sessions.rst
r6513 r8112 1 ******** 2 Sessions 3 ******** 1 ************** 2 NuLog sessions 3 ************** 4 5 .. section-numbering:: 4 6 5 7 This file will describe how NuLog2 store user parameters into persistant sessions. 6 8 7 I.Architecture8 ============ ===9 Architecture 10 ============ 9 11 10 12 Because we save datas into files, we must formalize them with some key/value lines. … … 23 25 An object 24 26 25 1.Pages26 ----- ---27 Pages 28 ----- 27 29 28 30 Each page we want to store paramters will have a tuple in this syntax:: … … 32 34 A page have an uniq ID which is his name in nulog-web. 33 35 34 2.Fragments35 --------- ---36 Fragments 37 --------- 36 38 37 39 A fragment jave an uniq ID which is in this form::
