jeremy 02/02/22 14:18:10
Added: src/scratchpad/webapp/mount/editor/editor/docs welcome.xml
Log:
Whoops, left this out
Revision Changes Path
1.1
xml-cocoon2/src/scratchpad/webapp/mount/editor/editor/docs/welcome.xml
Index: welcome.xml
===================================================================
<?xml version="1.0" encoding="utf-8"?>
<page>
<title><slash-edit/></title>
<content>
<para>
How to use <slash-edit/>
<para>
Top right you see some icons, this is <slash-edit/>'s
toolbar.
</para><para>
<img src="image/dir.gif"/> Gives you a Directory Listing of
your current directory inside your project's 'docs' directory.
</para><para>
<img src="image/new.gif"/> Gives you a form, made from a
template, for you to make a new file in the current directory.
</para><para>
<img src="image/get.gif"/> Gives you a form to edit this file.
</para><para>
<img src="image/view.gif"/> View this file in the editor,
useful for proof reading etc.
</para><para>
There is no Delete function available, though you can
overwrite files.
</para><para>
If you need to make a new directory, add it's name to the path
field when you go to save a file.
</para>
</para>
<para>
To make use of it in your project, I envisage the following:
<para>
You add this to your project sitemap:
<pre>
<map:match pattern="edit**">
<map:mount uri-prefix="edit" src="editor.xmap" check-reload="yes"/>
</map:match>
</pre>
<table>
<tr>
<td colspan="3">You copy to the root of your
project (where the sitemap is) the following:</td>
</tr>
<tr>
<td>  </td> <td>editor.xmap</td>
<td>- the sitemap for the editor</td>
</tr>
<tr>
<td></td> <td>editor</td> <td>- a directory of
the editor's files</td>
</tr>
</table>
</para>
<para>
You make adjustments to the editor.xmap incase your project's files do
not reside in 'docs'.
</para><para>
You make any necessary adjustments to the stylesheets in
editor/stylesheets to cope with the structure of the documents you use in your project
(the samples use cocoon's 'simple-page' style).
</para><para>
You make any stylistic adjustments required to how the editor looks.
</para><para>
You add an appropriate authentication mechanism to protect anything
inside '/edit'.
</para><para>
That's the plan, anyway!
</para>
</para>
<para>
<table>
<tr>
<td colspan="3">Components Used:</td>
</tr>
<tr valign="top">
<td>  </td><td>FileWritingTransformer</td><td>Serialises part of the SAX
stream to disk</td>
</tr>
<tr valign="top">
<td></td><td>DirectoryGenerator</td><td>Generates a
directory listing</td>
</tr>
<tr valign="top">
<td></td><td>FileGenerator</td><td>Generates a SAX
stream from a file</td>
</tr>
<tr valign="top">
<td></td><td>StreamGenerator</td><td>Generates XML by
parsing a named form field in the Request</td>
</tr>
</table>
</para>
<table>
<tr>
<td colspan="4">commands:</td>
</tr>
<tr>
<td>  </td><td>dir</td><td>your-project/edit/<b>dir</b>/path/to/directory/</td><td>gives
you a directory listing</td>
</tr>
<tr valign="top">
<td></td><td>view</td><td>your-project/edit/<b>view</b>/path/to/file</td><td>views
your page within the editor (it is not going to look the same, outside the context of
your project)</td>
</tr>
<tr valign="top">
<td></td><td>get</td><td>your-project/edit/<b>get</b>/path/to/file</td><td>converts
the file into an HTML Form for editing</td>
</tr>
<tr valign="top">
<td></td><td>new</td><td>your-project/edit/<b>new</b>/path/to/file</td><td>gives you a
Form made from a template to make a new file at that location</td>
</tr>
<tr valign="top">
<td></td><td>put</td><td>your-project/edit/<b>put</b></td><td>receives a Form, writing
the contents back to File</td>
</tr>
</table>
</content>
</page>
----------------------------------------------------------------------
In case of troubles, e-mail: [EMAIL PROTECTED]
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
