Index: openacs-4/packages/acs-core-docs/www/tutorial-pages.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-pages.html,v diff -u -r1.45 -r1.46 --- openacs-4/packages/acs-core-docs/www/tutorial-pages.html 7 Aug 2017 23:47:53 -0000 1.45 +++ openacs-4/packages/acs-core-docs/www/tutorial-pages.html 8 Nov 2017 09:42:12 -0000 1.46 @@ -1,9 +1,29 @@ -Creating Web Pages

Creating Web Pages

by Joel Aufrecht

- OpenACS docs are written by the named authors, and may be edited - by OpenACS documentation staff. -

Install some API

As a workaround for missing content-repository functionality, copy a provided file into the directory for Tcl files:

-    cp /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/acs-core-docs/www/files/tutorial/note-procs.tcl /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/myfirstpackage/tcl/

To make this file take effect, go to the APM and choose "Reload changed" for "MyFirstPackage".

Page Map

Our package will have two visible pages. The first shows a list of all objects; the second shows a single object in view or edit mode, and can also be used to add an object. The index page will display the list, but since we might reuse the list later, we'll put it in a separate file and include it on the index page.

Figure 9.5. Page Map

Page Map

Build the "Index" page

Each user-visible page in your package has, typically, +Creating Web Pages

Creating Web Pages

+ + + <authorblurb> +

by Joel Aufrecht

+ </authorblurb>
+ +

Install some API

+ +

As a workaround for missing content-repository functionality, copy a provided file into the directory for Tcl files:

+
+    cp /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/acs-core-docs/www/files/tutorial/note-procs.tcl /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/myfirstpackage/tcl/
+

To make this file take effect, go to the APM and choose "Reload changed" for "MyFirstPackage".

+
+

Page Map

+ +

Our package will have two visible pages. The first shows a list of all objects; the second shows a single object in view or edit mode, and can also be used to add an object. The index page will display the list, but since we might reuse the list later, we'll put it in a separate file and include it on the index page.

+

Figure 9.5. Page Map

+ +
Page Map
+

+
+

Build the "Index" page

+ +

Each user-visible page in your package has, typically, three parts. The tcl file holds the procedural logic for the page, including Tcl and database-independent SQL code, and does things like @@ -13,8 +33,11 @@ and -oracle.xql files contains database-specific SQL. The default page in any directory is index, so we'll build that - first, starting with the Tcl file:

[$OPENACS_SERVICE_NAME postgresql]$ cd /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/myfirstpackages/www
-[$OPENACS_SERVICE_NAME www]$ emacs index.tcl

Paste this into the file.

ad_page_contract {
+      first, starting with the Tcl file:

+
[$OPENACS_SERVICE_NAME postgresql]$ cd /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/myfirstpackages/www
+[$OPENACS_SERVICE_NAME www]$ emacs index.tcl
+

Paste this into the file.

+
ad_page_contract {
     This is the main page for the package.  It displays all of the Notes and provides links to edit them and to create new Notes.
 
     @author Your Name (you@example.com)
@@ -28,12 +51,17 @@
 #    tcl-indent-level: 4
 #    indent-tabs-mode: nil
 # End:
-

Now index.adp:

<master>
+
+

Now index.adp:

+
<master>
   <property name="doc(title)">@page_title;literal@</property>
   <property name="context">@context;literal@</property>
-<include src="/packages/myfirstpackage/lib/note-list">

The index page includes the list page, which we put in /lib instead of /www to designate that it's available for reuse by other packages.

[$OPENACS_SERVICE_NAME www]$ mkdir /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/myfirstpackage/lib
-[$OPENACS_SERVICE_NAME www]$ cd /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/myfirstpackage/lib
-[$OPENACS_SERVICE_NAME lib]$ emacs note-list.tcl
template::list::create \
+<include src="/packages/myfirstpackage/lib/note-list">
+

The index page includes the list page, which we put in /lib instead of /www to designate that it's available for reuse by other packages.

+
[$OPENACS_SERVICE_NAME www]$ mkdir /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/myfirstpackage/lib
+[$OPENACS_SERVICE_NAME www]$ cd /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/myfirstpackage/lib
+[$OPENACS_SERVICE_NAME lib]$ emacs note-list.tcl
+
template::list::create \
     -name notes \
     -multirow notes \
     -actions { "Add a Note" note-edit} \
@@ -76,9 +104,15 @@
 #    tcl-indent-level: 4
 #    indent-tabs-mode: nil
 # End:
-
[$OPENACS_SERVICE_NAME lib]$ emacs note-list.adp
<listtemplate name="notes"></listtemplate>

You can test your work by viewing the page /myfirstpackage on your installation.

Create the add/edit page. If note_id is passed in, - it display that note, and can change to edit mode if appropriate. Otherwise, it presents a form for adding notes.

[$OPENACS_SERVICE_NAME lib]$ cd /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/myfirstpackage/www
-[$OPENACS_SERVICE_NAME www]$ emacs note-edit.tcl
ad_page_contract {
+
+
[$OPENACS_SERVICE_NAME lib]$ emacs note-list.adp
+
<listtemplate name="notes"></listtemplate>
+

You can test your work by viewing the page /myfirstpackage on your installation.

+

Create the add/edit page. If note_id is passed in, + it display that note, and can change to edit mode if appropriate. Otherwise, it presents a form for adding notes.

+
[$OPENACS_SERVICE_NAME lib]$ cd /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/myfirstpackage/www
+[$OPENACS_SERVICE_NAME www]$ emacs note-edit.tcl
+
ad_page_contract {
     This is the view-edit page for notes.
 
     @author Your Name (you@example.com)
@@ -124,13 +158,18 @@
 #    tcl-indent-level: 4
 #    indent-tabs-mode: nil
 # End:
-
[$OPENACS_SERVICE_NAME www]$ emacs note-edit.adp
<master>
+
+
[$OPENACS_SERVICE_NAME www]$ emacs note-edit.adp
+
<master>
   <property name="doc(title)">@page_title;literal@</property>
   <property name="context">@context;literal@</property>
   <property name="focus">note.title</property>
   
-<formtemplate id="note"></formtemplate>

And the delete page. Since it has no UI, there is only a - Tcl page, and no adp page.

[$OPENACS_SERVICE_NAME www]$ emacs note-delete.tcl
ad_page_contract {
+<formtemplate id="note"></formtemplate>
+

And the delete page. Since it has no UI, there is only a + Tcl page, and no adp page.

+
[$OPENACS_SERVICE_NAME www]$ emacs note-delete.tcl
+
ad_page_contract {
     This deletes a note
 
     @author Your Name (you@example.com)
@@ -154,4 +193,6 @@
 #    tcl-indent-level: 4
 #    indent-tabs-mode: nil
 # End:
-
+ +
+