[docs] docs - heins modified iccontent.html
docs@icdevgroup.org
docs@icdevgroup.org
Tue Sep 17 20:56:01 2002
User: heins
Date: 2002-09-18 00:55:08 GMT
Added: . iccontent.html
Log:
* Add beginning of content-editor docs. I will attempt to incorporate
them into online help.
Revision Changes Path
1.1 docs/iccontent.html
rev 1.1, prev_rev 1.0
Index: iccontent.html
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
<!doctype html public "-//W30//DTD W3 HTML 2.0//EN">
<HTML>
<!-- This file was generated using SDF 2.001 by
Ian Clatworthy (ianc@mincom.com). SDF is freely
available from http://www.mincom.com/mtr/sdf. -->
<HEAD>
<TITLE>Content Editor Reference</TITLE>
</HEAD>
<BODY BGCOLOR=3D"ffffff" LINK=3D"993333">
<DIV CLASS=3D"header">
<DIV CLASS=3D"navigate">
<P ALIGN=3D"Center"><A HREF=3D"index.html" TARGET=3D"_top">Catalog</A></P>
</DIV>
</DIV>
<DIV CLASS=3D"title">
<P><IMG SRC=3D"rh-ic-logo.gif" ALIGN=3D"Right"></P>
<H1 CLASS=3D"doc-title">Content Editor Reference</H1>
<ADDRESS CLASS=3D"doc-author"></ADDRESS>
<BR CLEAR=3D"All">
</DIV>
<DIV CLASS=3D"contents">
<HR>
<H2>Table of Contents</H2>
<UL>
<A HREF=3D"#Interchange UI -- Content Editor">1. Interchange UI -- Content =
Editor</A><UL>
<A HREF=3D"#Content management concept">1.1. Content management concept</A>
<BR>
<A HREF=3D"#A typical page">1.2. A typical page</A></UL></UL>
</DIV>
<DIV CLASS=3D"main">
<HR>
<H1><A NAME=3D"Interchange UI -- Content Editor">1. Interchange UI -- Conte=
nt Editor</A></H1>
<P>Interchange is a web presentation framework which has powerful database =
and content manipulation features. The Interchange Content Editor provides =
a framework for manipulating pages and components within pages.</P>
<H2><A NAME=3D"Content management concept">1.1. Content management concept<=
/A></H2>
<P>Interchange assumes that the <I>page</I> is the basic level of content. =
Each page is typically a file on the filesystem, though it is possible to m=
aintain them in a database instead.</P>
<P>Each page is assumed to be based on a <TT>template</TT>, which is the la=
yout for that page. Each template can contain <I>slots</I> for <I>component=
s</I>.</P>
<P>Components are interchangeable items that can be inserted in template sl=
ots so that pages based on a common template can vary without having to cre=
ate a separate template.</P>
<P>A <I>page</I> may actually be a metacontent template in effect. Examples=
of this are the <A HREF=3D"icconfig.html#On-the-fly Catalog Pages">flypage=
</A> for building a product page, and the results page that displays search=
lists.</P>
<H2><A NAME=3D"A typical page">1.2. A typical page</A></H2>
<P>Here is how the file for a page looks:</P>
<PRE>
[comment]
ui_name: typical.html
ui_page_template: leftonly
[/comment]
[set page_title] A typical page [/set]
[set members_only]0[/set]
[control reset=3D1]
[control-set]
[parameter1]setting1[/parameter1]
[parameter2]setting2[/parameter2]
[/control-set]
[control-set]
[parameter1]setting1[/parameter1]
[parameter2]setting2[/parameter2]
[/control-set]
[control reset=3D1]
@_LEFTONLY_TOP__@
<!-- BEGIN CONTENT -->
The content of a typical page.
<!-- END CONTENT -->
@_LEFTONLY_BOTTOM__@
</PRE>
<P>You can see other examples in the standard Interchange <A HREF=3D"icfoun=
dation.html">foundation</A> demo.</P>
<P>We will tour the page, adding the PREAMBLE and POSTAMBLE sections.</P>
<P><B>Editor information</B></P>
<P>The comment at the top of the page is only used by the editor to derive =
things it may need to know. If it were to be removed, the page would displa=
y the same; it just may not read and publish the same when edited.</P>
<PRE>
[comment]
ui_template_name: leftonly
ui_static: 0
[/comment]
</PRE>
<P>In the case above, the template is specified with <TT>ui_template_name</=
TT> and the page will not be published statically (i.e. <TT>ui_static</TT>:=
0).</P>
<P><B>PREAMBLE</B></P>
<P>The PREAMBLE is a section which allows page initialization prior to the =
header portion of the template, and prior to the setting of the page contro=
ls.</P>
<PRE>
<!-- BEGIN PREAMBLE -->
[perl]
&custom_init();
[/perl]
<!-- END PREAMBLE -->
</PRE>
<P><B>Page controls</B></P>
<P>Page controls are specified in the template definition, and the user can=
set them from the <I>page control</I> menu when editing the page.</P>
<PRE>
[set page_title] A typical page [/set]
[set members_only]0[/set]
</PRE>
<P>The above sets two page controls, one used in the header to set the HTML=
title for the page, and the other used to determine if the customer must b=
e logged in (a member) to access the page.</P>
<P><B>Component controls</B></P>
<P>As was said before, a page template can contain multiple components. Eac=
h component can have an unlimited number of settings which can be used to s=
pecify its behavior. These settings are manipulated in the <I>component con=
trol</I> sections of the content editor, one for each component slot.</P>
<PRE>
[control reset=3D1]
[control-set]
[parameter1]setting1[/parameter1]
[parameter2]setting2[/parameter2]
[/control-set]
[control-set]
[parameter1]setting1[/parameter1]
[parameter2]setting2[/parameter2]
[/control-set]
[control reset=3D1]
</PRE>
<P><B>Template header section</B></P>
<P>This is the <A HREF=3D"icconfig.html#Variable">Variable</A> used to cont=
ain the top portion of the template, which may use various <I>page control<=
/I> settings and have multiple slots for components.</P>
<PRE>
@_LEFTONLY_TOP__@
</PRE>
<P><B>CONTENT section</B></P>
<P>This is the actual content of the page. It can be edited in a TEXTAREA i=
n the content editor.</P>
<PRE>
<!-- BEGIN CONTENT -->
The content of a typical page.
<!-- END CONTENT -->
</PRE>
<P><B>Template footer section</B></P>
<P>This is the <A HREF=3D"icconfig.html#Variable">Variable</A> used to cont=
ain the bottom portion of the template, which may use various <I>page contr=
ol</I> settings and have multiple slots for components.</P>
<PRE>
@_LEFTONLY_BOTTOM__@
</PRE>
<P><B>POSTAMBLE</B></P>
<P>The POSTAMBLE section can contain cleanup code for the page. It will rar=
ely be used.</P>
<PRE>
<!-- BEGIN POSTAMBLE -->
[perl]
&custom_cleanup();
[/perl]
<!-- END POSTAMBLE -->
</PRE>
<P>Copyright 2001-2002 Red Hat, Inc. Freely redistributable under terms of =
the GNU General Public License.</P>
</DIV>
<DIV CLASS=3D"footer">
<DIV CLASS=3D"navigate">
<P ALIGN=3D"Center"><A HREF=3D"index.html" TARGET=3D"_top">Catalog</A></P>
</DIV>
<HR>
<ADDRESS><SPAN CLASS=3D"doc-id">iccontent-1.72</SPAN> <SPAN CLASS=3D"doc-st=
atus">(Draft)</SPAN></ADDRESS>
<ADDRESS CLASS=3D"doc-modified">17 September 2002</ADDRESS>
<ADDRESS CLASS=3D"copyright">Copyright © 1996-2001 Red Hat, Inc. <=
<A HREF=3D"mailto:interchange@redhat.com">interchange@redhat.com</A>></A=
DDRESS>
</DIV>
</BODY>
</HTML>