.\" Automatically generated by Pod::Man version 1.15
.\" Wed May  5 11:41:27 2004
.\"
.\" Standard preamble:
.\" ======================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R

.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used
.\" to do unbreakable dashes and therefore won't be available.  \*(C` and
.\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr
.\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
.\" index entries marked with X<> in POD.  Of course, you'll have to process
.\" the output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it
.\" makes way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.bd B 3
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ======================================================================
.\"
.IX Title "iccontent 8"
.TH iccontent 8 "Interchange 5.2.0" "2004-05-05" "Interchange"
.UC
.SH "NAME"
iccontent \- Content Editor Reference
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.SH "Interchange UI \*(-- Content Editor"
.IX Header "Interchange UI  Content Editor"
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.
.Sh "Content management concept"
.IX Subsection "Content management concept"
Interchange assumes that the \fIpage\fR is the basic level of content.
Each page is typically a file on the filesystem, though it is possible
to maintain them in a database instead.
.PP
Each page is assumed to be based on a template, which is the layout
for that page. Each template can contain \fIslots\fR for \fIcomponents\fR.
.PP
Components are interchangeable items that can be inserted in template
slots so that pages based on a common template can vary without having
to create a separate template.
.PP
A \fIpage\fR may actually be a metacontent template in effect. Examples
of this are the \fIflypage\fR for building a product page, and the
results page that displays search lists.
.Sh "A typical page"
.IX Subsection "A typical page"
Here is how the file for a page looks:
.PP
.Vb 4
\&        [comment]
\&        ui_name: typical.html
\&        ui_page_template: leftonly
\&        [/comment]
.Ve
.Vb 2
\&        [set page_title] A typical page [/set]
\&        [set members_only]0[/set]
.Ve
.Vb 10
\&        [control reset=1]
\&        [control-set]
\&                [parameter1]setting1[/parameter1]
\&                [parameter2]setting2[/parameter2]
\&        [/control-set]
\&        [control-set]
\&                [parameter1]setting1[/parameter1]
\&                [parameter2]setting2[/parameter2]
\&        [/control-set]
\&        [control reset=1]
.Ve
.Vb 1
\&        @_LEFTONLY_TOP__@
.Ve
.Vb 1
\&        <!-- BEGIN CONTENT -->
.Ve
.Vb 1
\&                The content of a typical page.
.Ve
.Vb 1
\&        <!-- END CONTENT -->
.Ve
.Vb 1
\&        @_LEFTONLY_BOTTOM__@
.Ve
You can see other examples in the standard Interchange \fIfoundation\fR
demo.
.PP
We will tour the page, adding the \s-1PREAMBLE\s0 and \s-1POSTAMBLE\s0 sections.
.Ip "Editor information" 4
.IX Item "Editor information"
.PP
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 display the same; it just may not read and publish the same when
edited.
.PP
.Vb 4
\&        [comment]
\&        ui_template_name: leftonly
\&        ui_static: 0
\&        [/comment]
.Ve
In the case above, the template is specified with ui_template_name
and the page will not be published statically (i.e. ui_static: 0).
.Ip "\s-1PREAMBLE\s0" 4
.IX Item "PREAMBLE"
.PP
The \s-1PREAMBLE\s0 is a section which allows page initialization prior to
the header portion of the template, and prior to the setting of the
page controls.
.PP
.Vb 5
\&        <!-- BEGIN PREAMBLE -->
\&                [perl]
\&                        &custom_init();
\&                [/perl]
\&        <!-- END PREAMBLE -->
.Ve
.Ip "Page controls" 4
.IX Item "Page controls"
.PP
Page controls are specified in the template definition, and the user
can set them from the \fIpage control\fR menu when editing the page.
.PP
.Vb 2
\&        [set page_title] A typical page [/set]
\&        [set members_only]0[/set]
.Ve
The above sets two page controls, one used in the header to set the
\&\s-1HTML\s0 title for the page, and the other used to determine if the
customer must be logged in (a member) to access the page.
.Ip "Component controls" 4
.IX Item "Component controls"
.PP
As was said before, a page template can contain multiple components.
Each component can have an unlimited number of settings which can be
used to specify its behavior. These settings are manipulated in the
\&\fIcomponent control\fR sections of the content editor, one for each
component slot.
.PP
.Vb 10
\&        [control reset=1]
\&        [control-set]
\&                [parameter1]setting1[/parameter1]
\&                [parameter2]setting2[/parameter2]
\&        [/control-set]
\&        [control-set]
\&                [parameter1]setting1[/parameter1]
\&                [parameter2]setting2[/parameter2]
\&        [/control-set]
\&        [control reset=1]
.Ve
.Ip "Template header section" 4
.IX Item "Template header section"
.PP
This is the \fIVariable\fR used to contain the top portion of the
template, which may use various \fIpage control\fR settings and have
multiple slots for components.
.PP
.Vb 1
\&        @_LEFTONLY_TOP__@
.Ve
.Ip "\s-1CONTENT\s0 section" 4
.IX Item "CONTENT section"
.PP
This is the actual content of the page. It can be edited in a \s-1TEXTAREA\s0
in the content editor.
.PP
.Vb 1
\&        <!-- BEGIN CONTENT -->
.Ve
.Vb 1
\&                The content of a typical page.
.Ve
.Vb 1
\&        <!-- END CONTENT -->
.Ve
.Ip "Template footer section" 4
.IX Item "Template footer section"
.PP
This is the \fIVariable\fR used to contain the bottom portion of the
template, which may use various \fIpage control\fR settings and have
multiple slots for components.
.PP
.Vb 1
\&        @_LEFTONLY_BOTTOM__@
.Ve
.Ip "\s-1POSTAMBLE\s0" 4
.IX Item "POSTAMBLE"
.PP
The \s-1POSTAMBLE\s0 section can contain cleanup code for the page. It will
rarely be used.
.PP
.Vb 5
\&        <!-- BEGIN POSTAMBLE -->
\&                [perl]
\&                        &custom_cleanup();
\&                [/perl]
\&        <!-- END POSTAMBLE -->
.Ve
Copyright 2002\-2004 Interchange Development Group. Copyright 2001\-2002
Red Hat, Inc. Freely redistributable under terms of the \s-1GNU\s0 General
Public License.