[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Phpgroupware-cvs] CVS: sitemgr/doc sitemgr.html,1.1,1.2 sitemgr.pdf,1.
From: |
Michael Totschnig <address@hidden> |
Subject: |
[Phpgroupware-cvs] CVS: sitemgr/doc sitemgr.html,1.1,1.2 sitemgr.pdf,1.1,1.2 sitemgr.sgml,1.1,1.2 |
Date: |
Fri, 06 Jun 2003 14:38:52 -0400 |
Update of /cvsroot/phpgroupware/sitemgr/doc
In directory subversions:/tmp/cvs-serv14411
Modified Files:
sitemgr.html sitemgr.pdf sitemgr.sgml
Log Message:
rebuild documentation (SGML produced by patched lyx
http://bugzilla.lyx.org/show_bug.cgi?id=821)
Index: sitemgr.html
===================================================================
RCS file: /cvsroot/phpgroupware/sitemgr/doc/sitemgr.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -r1.1 -r1.2
*** sitemgr.html 31 May 2003 03:53:51 -0000 1.1
--- sitemgr.html 6 Jun 2003 18:38:49 -0000 1.2
***************
*** 43,52 ****
><DT
><A
! HREF="#AEN100"
>User manual</A
></DT
><DT
><A
! HREF="#AEN252"
>Administrator manual<A
NAME="ADMINISTRATOR-MANUAL"
--- 43,52 ----
><DT
><A
! HREF="#AEN102"
>User manual</A
></DT
><DT
><A
! HREF="#AEN254"
>Administrator manual<A
NAME="ADMINISTRATOR-MANUAL"
***************
*** 56,60 ****
><DT
><A
! HREF="#AEN339"
>Template designer manual<A
NAME="TEMPLATE-DESIGNER-MANUAL"
--- 56,60 ----
><DT
><A
! HREF="#AEN341"
>Template designer manual<A
NAME="TEMPLATE-DESIGNER-MANUAL"
***************
*** 64,68 ****
><DT
><A
! HREF="#AEN356"
>Module developper manual<A
NAME="MODULE-DEVELOPPER-MANUAL"
--- 64,68 ----
><DT
><A
! HREF="#AEN358"
>Module developper manual<A
NAME="MODULE-DEVELOPPER-MANUAL"
***************
*** 91,95 ****
NAME="AEN12">Template</H3
><P
! >Sitemgr builds web sites from templates. Those are stored in the directory
sitemgr/sitemg-site/templates. Each of them has a directory of its own. The
file main.tpl defines the template of the whole site, there can be other files
that define code for separate areas of the page or for specific modules.
Templates contain four kinds of variables. These are explained here since the
types 2,3 and 4 can be used both in the template as in the page content a
module generates.
</P
><P
--- 91,95 ----
NAME="AEN12">Template</H3
><P
! >Sitemgr builds web sites from templates. Those are stored in the directory
sitemgr/sitemg-site/templates. Each of them has a directory of its own. The
file main.tpl defines the template of the whole site, there can be other files
that define code for separate areas of the page or for specific modules.
Templates contain four kinds of variables. These are explained here since the
types 2,3,4 and 5 can be used both in the template as in the page content a
module generates.
</P
><P
***************
*** 162,165 ****
--- 162,170 ----
></OL
></LI
+ ><LI
+ ><P
+ >{lang_translatable_string} This lets you make the template
internationalized. The translatable string is sent through phpgroupware's lang
function. Thus you can add it to the lang files in the setup directory and
install it through the setup programm.
+ </P
+ ></LI
></OL
></DIV
***************
*** 169,173 ****
CLASS="SECT2"
><A
! NAME="AEN40">Module</H3
><P
>The main function of a sitemgr module is to generate dynamic web site
content. To make the development of new modules, and the use of modules easy
and convenient, sitemgr defines an “abstract” class module which
each module should extend. This parent of all modules, provides one essential
service: It hooks the module into the content managment interface and permits
the editing of the module's arguments that determine what content will be
generated. Thus in order to create a new module, all you have to do, is to
extend the abstract super module, define the modules arguments, and write a
get_content function that returns the content that should be displayed on the
website. More on this in the chapter about<A
--- 174,178 ----
CLASS="SECT2"
><A
! NAME="AEN42">Module</H3
><P
>The main function of a sitemgr module is to generate dynamic web site
content. To make the development of new modules, and the use of modules easy
and convenient, sitemgr defines an “abstract” class module which
each module should extend. This parent of all modules, provides one essential
service: It hooks the module into the content managment interface and permits
the editing of the module's arguments that determine what content will be
generated. Thus in order to create a new module, all you have to do, is to
extend the abstract super module, define the modules arguments, and write a
get_content function that returns the content that should be displayed on the
website. More on this in the chapter about<A
***************
*** 182,186 ****
CLASS="SECT2"
><A
! NAME="AEN44">Argument/Content</H3
><P
>A module can be seen as a transformation of input arguments into generated
content. It is important to understand that the input arguments can be of
completely different kinds. On the one hand there can be arguments that are as
close as possible to the generated content. For example the html module's only
argument is named “htmlcontent” and in normal circumstances it is
not transformed at all but handed over as is to the page generation engine. On
the other hand arguments can play any conceivable role in the generation of
content that is driven by data coming from other phpgroupware applications.
They can be used to select between different categories of content, they can
choose a certain format of presentation, they can function as search terms, etc.
--- 187,191 ----
CLASS="SECT2"
><A
! NAME="AEN46">Argument/Content</H3
><P
>A module can be seen as a transformation of input arguments into generated
content. It is important to understand that the input arguments can be of
completely different kinds. On the one hand there can be arguments that are as
close as possible to the generated content. For example the html module's only
argument is named “htmlcontent” and in normal circumstances it is
not transformed at all but handed over as is to the page generation engine. On
the other hand arguments can play any conceivable role in the generation of
content that is driven by data coming from other phpgroupware applications.
They can be used to select between different categories of content, they can
choose a certain format of presentation, they can function as search terms, etc.
***************
*** 192,196 ****
CLASS="SECT2"
><A
! NAME="AEN47">Properties</H3
><P
>A module can define properties. Properties are accessible to the modules
get_content function in the same way as arguments, but they differ from them in
two ways:
--- 197,201 ----
CLASS="SECT2"
><A
! NAME="AEN49">Properties</H3
><P
>A module can define properties. Properties are accessible to the modules
get_content function in the same way as arguments, but they differ from them in
two ways:
***************
*** 219,223 ****
CLASS="SECT2"
><A
! NAME="AEN56">Blocks, content areas and scope</H3
><P
>There are three ways a module can generate content that will be displayed on
a web page:
--- 224,228 ----
CLASS="SECT2"
><A
! NAME="AEN58">Blocks, content areas and scope</H3
><P
>There are three ways a module can generate content that will be displayed on
a web page:
***************
*** 251,255 ****
CLASS="SECT2"
><A
! NAME="AEN66">Versioning</H3
><P
>Sitemgr handles block content in versions. This means that you can have
different versions of one block at the same time, but only one of them is
visible on the website. This allows for working on several changes to the
website and viewing them in a draft mode, before commiting them all at once to
the production site. Sitemgr distinguishes five states for versions:
--- 256,260 ----
CLASS="SECT2"
><A
! NAME="AEN68">Versioning</H3
><P
>Sitemgr handles block content in versions. This means that you can have
different versions of one block at the same time, but only one of them is
visible on the website. This allows for working on several changes to the
website and viewing them in a draft mode, before commiting them all at once to
the production site. Sitemgr distinguishes five states for versions:
***************
*** 309,313 ****
CLASS="SECT2"
><A
! NAME="AEN92">Transformer</H3
><P
>The architecture for sitemgr modules provides for the distinction between
some form of raw content a module produces and the way it should get displayed
on the web site, with the future possibility to plug other display types into
the same framework. The idea is that the raw content of a module gets passed
through different transformers, possibly even several transformers in a
sequence at the time of content generation. Additionally this provides for a
use of modules outside of sitemgr, for example remote retrieval of information
with something like XML-RPC.
--- 314,318 ----
CLASS="SECT2"
><A
! NAME="AEN94">Transformer</H3
><P
>The architecture for sitemgr modules provides for the distinction between
some form of raw content a module produces and the way it should get displayed
on the web site, with the future possibility to plug other display types into
the same framework. The idea is that the raw content of a module gets passed
through different transformers, possibly even several transformers in a
sequence at the time of content generation. Additionally this provides for a
use of modules outside of sitemgr, for example remote retrieval of information
with something like XML-RPC.
***************
*** 325,329 ****
CLASS="SECT2"
><A
! NAME="AEN97">Translations</H3
><P
>Sitemgr in its new modularized architecture continues to be fully
multilingual. It is very simple to have a new module use this feature. All that
is needed is to use a special flag in the definition of the module's arguments.
All arguments that have this flag will be stored in a language specific
database table, and can be translated in the translation manager, very similar
to the way category and page definitions could already be translated to several
languages.
--- 330,334 ----
CLASS="SECT2"
><A
! NAME="AEN99">Translations</H3
><P
>Sitemgr in its new modularized architecture continues to be fully
multilingual. It is very simple to have a new module use this feature. All that
is needed is to use a special flag in the definition of the module's arguments.
All arguments that have this flag will be stored in a language specific
database table, and can be translated in the translation manager, very similar
to the way category and page definitions could already be translated to several
languages.
***************
*** 336,340 ****
CLASS="SECT1"
><A
! NAME="AEN100">User manual</H2
><DIV
CLASS="SECT2"
--- 341,345 ----
CLASS="SECT1"
><A
! NAME="AEN102">User manual</H2
><DIV
CLASS="SECT2"
***************
*** 342,346 ****
CLASS="SECT2"
><A
! NAME="AEN102">Manage categories and pages</H3
><DIV
CLASS="SECT3"
--- 347,351 ----
CLASS="SECT2"
><A
! NAME="AEN104">Manage categories and pages</H3
><DIV
CLASS="SECT3"
***************
*** 348,352 ****
CLASS="SECT3"
><A
! NAME="AEN104">Create a new category</H4
><P
>to be completed
--- 353,357 ----
CLASS="SECT3"
><A
! NAME="AEN106">Create a new category</H4
><P
>to be completed
***************
*** 358,362 ****
CLASS="SECT3"
><A
! NAME="AEN107">Edit a category</H4
><P
>to be completed
--- 363,367 ----
CLASS="SECT3"
><A
! NAME="AEN109">Edit a category</H4
><P
>to be completed
***************
*** 368,372 ****
CLASS="SECT3"
><A
! NAME="AEN110">Delete a category</H4
><P
>to be completed
--- 373,377 ----
CLASS="SECT3"
><A
! NAME="AEN112">Delete a category</H4
><P
>to be completed
***************
*** 378,382 ****
CLASS="SECT3"
><A
! NAME="AEN113">Create a new page</H4
><P
>to be completed
--- 383,387 ----
CLASS="SECT3"
><A
! NAME="AEN115">Create a new page</H4
><P
>to be completed
***************
*** 388,392 ****
CLASS="SECT3"
><A
! NAME="AEN116">Edit a page</H4
><P
>to be completed
--- 393,397 ----
CLASS="SECT3"
><A
! NAME="AEN118">Edit a page</H4
><P
>to be completed
***************
*** 398,402 ****
CLASS="SECT3"
><A
! NAME="AEN119">Editing page content</H4
><P
>There are two interfaces for creating and editing content blocks. The first
one is called “content manager” and works inside the phpgw
interface, the second works in interaction with the generated web site and we
call it “editing mode”.
--- 403,407 ----
CLASS="SECT3"
><A
! NAME="AEN121">Editing page content</H4
><P
>There are two interfaces for creating and editing content blocks. The first
one is called “content manager” and works inside the phpgw
interface, the second works in interaction with the generated web site and we
call it “editing mode”.
***************
*** 407,411 ****
CLASS="SECT4"
><A
! NAME="AEN122">The content manager</H5
><P
>The interface for creating content blocks is the same on each level of
scope, besides that when editing blocks on a lower level you can see all the
blocks that have been defined on a higher level, and will be displayed on the
website together with the blocks you are editing. I will refer to this
interface as the content manager.
--- 412,416 ----
CLASS="SECT4"
><A
! NAME="AEN124">The content manager</H5
><P
>The interface for creating content blocks is the same on each level of
scope, besides that when editing blocks on a lower level you can see all the
blocks that have been defined on a higher level, and will be displayed on the
website together with the blocks you are editing. I will refer to this
interface as the content manager.
***************
*** 420,424 ****
CLASS="SECT4"
><A
! NAME="AEN126">Editing mode</H5
><P
>In order to use editing mode, you must add a site-wide administration block
to your website (viewable only by registered users). This block has a dropdown
menu where you can switch between production mode (viewing the website in its
public state), draft mode (viewing the website in the prepublished state, i.e.
how it will look after you commit any pending changes) and edit mode. In edit
mode, you will see the same content as in draft mode, but in front of each
content block you will see a link “Edit block”. Activating this
link will pop up a new window for editing it.
--- 425,429 ----
CLASS="SECT4"
><A
! NAME="AEN128">Editing mode</H5
><P
>In order to use editing mode, you must add a site-wide administration block
to your website (viewable only by registered users). This block has a dropdown
menu where you can switch between production mode (viewing the website in its
public state), draft mode (viewing the website in the prepublished state, i.e.
how it will look after you commit any pending changes) and edit mode. In edit
mode, you will see the same content as in draft mode, but in front of each
content block you will see a link “Edit block”. Activating this
link will pop up a new window for editing it.
***************
*** 430,434 ****
CLASS="SECT4"
><A
! NAME="AEN129">Editing a block</H5
><P
>In both the content manager and the editing window that opens in editing
mode, the interface for editing the block is the same. There are three standard
interface elements you can edit for each block:
--- 435,439 ----
CLASS="SECT4"
><A
! NAME="AEN131">Editing a block</H5
><P
>In both the content manager and the editing window that opens in editing
mode, the interface for editing the block is the same. There are three standard
interface elements you can edit for each block:
***************
*** 642,646 ****
CLASS="SECT4"
><A
! NAME="AEN240">Handling versions</H5
><P
>For each content block you can create a new version simply by clicking on
the “Create new version link”. Once you have several versions of a
block, you can change their status at any time. If you want to immediately
publish a block, you choose “published”. If you want to register a
version for being published at the next commit, you choose
“prepublished”. A version that is “preunpublished” is
visible on the website, but will be archived at the next commit. Thus if you
want to replace some content at the next commit, you have to put the published
version into “preunpublished” and create a new version that you put
into “prepublished” state. Archived versions will be no longer
visible in the content managment interface, but will not be deleted from your
database. They can be reactivated in the “Manage archived content”
interface.
--- 647,651 ----
CLASS="SECT4"
><A
! NAME="AEN242">Handling versions</H5
><P
>For each content block you can create a new version simply by clicking on
the “Create new version link”. Once you have several versions of a
block, you can change their status at any time. If you want to immediately
publish a block, you choose “published”. If you want to register a
version for being published at the next commit, you choose
“prepublished”. A version that is “preunpublished” is
visible on the website, but will be archived at the next commit. Thus if you
want to replace some content at the next commit, you have to put the published
version into “preunpublished” and create a new version that you put
into “prepublished” state. Archived versions will be no longer
visible in the content managment interface, but will not be deleted from your
database. They can be reactivated in the “Manage archived content”
interface.
***************
*** 654,658 ****
CLASS="SECT2"
><A
! NAME="AEN243">Manage translations</H3
><P
>to be completed
--- 659,663 ----
CLASS="SECT2"
><A
! NAME="AEN245">Manage translations</H3
><P
>to be completed
***************
*** 664,668 ****
CLASS="SECT2"
><A
! NAME="AEN246">Commit changes</H3
><P
>In this interface you see a list of all categories, pages and blocks that
are in prepublished or preunpublished state. You can return to any of them for
further editing or changing their status, and you can choose between them for
commiting. Prepublished content will go public, preunpublished content will go
to the archive.
--- 669,673 ----
CLASS="SECT2"
><A
! NAME="AEN248">Commit changes</H3
><P
>In this interface you see a list of all categories, pages and blocks that
are in prepublished or preunpublished state. You can return to any of them for
further editing or changing their status, and you can choose between them for
commiting. Prepublished content will go public, preunpublished content will go
to the archive.
***************
*** 674,678 ****
CLASS="SECT2"
><A
! NAME="AEN249">Manage archived content</H3
><P
>to be completed
--- 679,683 ----
CLASS="SECT2"
><A
! NAME="AEN251">Manage archived content</H3
><P
>to be completed
***************
*** 685,689 ****
CLASS="SECT1"
><A
! NAME="AEN252">Administrator manual<A
NAME="ADMINISTRATOR-MANUAL"
></A
--- 690,694 ----
CLASS="SECT1"
><A
! NAME="AEN254">Administrator manual<A
NAME="ADMINISTRATOR-MANUAL"
></A
***************
*** 694,698 ****
CLASS="SECT2"
><A
! NAME="AEN255">Installation<A
NAME="INSTALLATION"
></A
--- 699,703 ----
CLASS="SECT2"
><A
! NAME="AEN257">Installation<A
NAME="INSTALLATION"
></A
***************
*** 883,887 ****
CLASS="SECT2"
><A
! NAME="AEN329">Maintenance</H3
><P
>As a site administrator, you have three privileges/responsibilies:
--- 888,892 ----
CLASS="SECT2"
><A
! NAME="AEN331">Maintenance</H3
><P
>As a site administrator, you have three privileges/responsibilies:
***************
*** 917,921 ****
CLASS="SECT1"
><A
! NAME="AEN339">Template designer manual<A
NAME="TEMPLATE-DESIGNER-MANUAL"
></A
--- 922,926 ----
CLASS="SECT1"
><A
! NAME="AEN341">Template designer manual<A
NAME="TEMPLATE-DESIGNER-MANUAL"
></A
***************
*** 940,945 ****
><P
>A contentarea serves to display the content blocks, the site administrator
and contributors define. Each contentarea can have its own way of wrapping html
code around each content block. This at the moment defined in a class that
implements the transformer interface, i.e. defines a function
apply_transform($title,$content).This class' name is areaname_bt (for
blocktransformer) and it is stored in file areaname_bt.inc.php inside the
template directory. The function apply_transform just has to wrap the desired
html around the content. It is free to ignore the title, for example the block
title does not necessarily make sense in a page's central content area. A block
transformer could apply other transformations to the content, but this would
probably have counter-intuitive effects on your page's contributors<A
! NAME="AEN350"
! HREF="#FTN.AEN350"
>[1]</A
>.
--- 945,950 ----
><P
>A contentarea serves to display the content blocks, the site administrator
and contributors define. Each contentarea can have its own way of wrapping html
code around each content block. This at the moment defined in a class that
implements the transformer interface, i.e. defines a function
apply_transform($title,$content).This class' name is areaname_bt (for
blocktransformer) and it is stored in file areaname_bt.inc.php inside the
template directory. The function apply_transform just has to wrap the desired
html around the content. It is free to ignore the title, for example the block
title does not necessarily make sense in a page's central content area. A block
transformer could apply other transformations to the content, but this would
probably have counter-intuitive effects on your page's contributors<A
! NAME="AEN352"
! HREF="#FTN.AEN352"
>[1]</A
>.
***************
*** 963,967 ****
CLASS="SECT1"
><A
! NAME="AEN356">Module developper manual<A
NAME="MODULE-DEVELOPPER-MANUAL"
></A
--- 968,972 ----
CLASS="SECT1"
><A
! NAME="AEN358">Module developper manual<A
NAME="MODULE-DEVELOPPER-MANUAL"
></A
***************
*** 1003,1008 ****
><P
>Once your module is registered<A
! NAME="AEN362"
! HREF="#FTN.AEN362"
>[2]</A
> and added to the list of permitted modules for some context, users can
create blocks from this module: They will see in the content manager a
textfield where they edit the argument name, and once the block is activated,
it will generate the hello phrase on the website. Easy, isn't it?
--- 1008,1013 ----
><P
>Once your module is registered<A
! NAME="AEN364"
! HREF="#FTN.AEN364"
>[2]</A
> and added to the list of permitted modules for some context, users can
create blocks from this module: They will see in the content manager a
textfield where they edit the argument name, and once the block is activated,
it will generate the hello phrase on the website. Easy, isn't it?
***************
*** 1300,1305 ****
WIDTH="5%"
><A
! NAME="FTN.AEN350"
! HREF="#AEN350"
>[1]</A
></TD
--- 1305,1310 ----
WIDTH="5%"
><A
! NAME="FTN.AEN352"
! HREF="#AEN352"
>[1]</A
></TD
***************
*** 1318,1323 ****
WIDTH="5%"
><A
! NAME="FTN.AEN362"
! HREF="#AEN362"
>[2]</A
></TD
--- 1323,1328 ----
WIDTH="5%"
><A
! NAME="FTN.AEN364"
! HREF="#AEN364"
>[2]</A
></TD
Index: sitemgr.pdf
===================================================================
RCS file: /cvsroot/phpgroupware/sitemgr/doc/sitemgr.pdf,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -r1.1 -r1.2
Binary files /tmp/cvsFwil1u and /tmp/cvsEmkv5O differ
Index: sitemgr.sgml
===================================================================
RCS file: /cvsroot/phpgroupware/sitemgr/doc/sitemgr.sgml,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -r1.1 -r1.2
*** sitemgr.sgml 31 May 2003 03:53:51 -0000 1.1
--- sitemgr.sgml 6 Jun 2003 18:38:49 -0000 1.2
***************
*** 31,35 ****
</title>
<para>
! Sitemgr builds web sites from templates. Those are stored in the directory
sitemgr/sitemg-site/templates. Each of them has a directory of its own. The
file main.tpl defines the template of the whole site, there can be other files
that define code for separate areas of the page or for specific modules.
Templates contain four kinds of variables. These are explained here since the
types 2,3 and 4 can be used both in the template as in the page content a
module generates.
</para>
<orderedlist>
--- 31,35 ----
</title>
<para>
! Sitemgr builds web sites from templates. Those are stored in the directory
sitemgr/sitemg-site/templates. Each of them has a directory of its own. The
file main.tpl defines the template of the whole site, there can be other files
that define code for separate areas of the page or for specific modules.
Templates contain four kinds of variables. These are explained here since the
types 2,3,4 and 5 can be used both in the template as in the page content a
module generates.
</para>
<orderedlist>
***************
*** 106,109 ****
--- 106,115 ----
</listitem>
+ <listitem>
+ <para>
+ {lang_translatable_string} This lets you make the template
internationalized. The translatable string is sent through phpgroupware's lang
function. Thus you can add it to the lang files in the setup directory and
install it through the setup programm.
+ </para>
+
+ </listitem>
</orderedlist>
***************
*** 697,702 ****
</para>
- </listitem>
-
</listitem>
--- 703,706 ----
***************
*** 731,736 ****
</para>
- </listitem>
-
</listitem>
--- 735,738 ----
***************
*** 1108,1113 ****
This would make sure that the module argument name would always be lowercase.
</para>
-
- </listitem>
--- 1110,1113 ----
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Phpgroupware-cvs] CVS: sitemgr/doc sitemgr.html,1.1,1.2 sitemgr.pdf,1.1,1.2 sitemgr.sgml,1.1,1.2,
Michael Totschnig <address@hidden> <=
- Prev by Date:
[Phpgroupware-cvs] CVS: property/templates/default location_form_2.xsl,NONE,1.1 location_view_2.xsl,NONE,1.1
- Next by Date:
[Phpgroupware-cvs] CVS: phpgwapi/inc class.sessions.inc.php,1.104.4.11,1.104.4.12
- Previous by thread:
[Phpgroupware-cvs] CVS: property/templates/default location_form_2.xsl,NONE,1.1 location_view_2.xsl,NONE,1.1
- Next by thread:
[Phpgroupware-cvs] CVS: phpgwapi/inc class.sessions.inc.php,1.104.4.11,1.104.4.12
- Index(es):