patch for modules-en.xml
Johannes Hoechstaedter <[email protected]>
| Newsgroups | gmane.comp.java.scarab.devel |
|---|---|
| Message-ID | <[email protected]> |
Hi Jean, here is a patch from my side for the explanation of module creation. I think all screenshots which show the admin menu or the form for edit a module have to be replaced. I would be happy if you can do this for me. cheers, Johannes --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
docbook_modules.patch
(text/plain, 9.1 KB)
Index: www/book/modules-en.xml =================================================================== --- www/book/modules-en.xml (revision 10544) +++ www/book/modules-en.xml (working copy) @@ -1,52 +1,134 @@ -<!-- $Id --> -<chapter> - <title>Creating and managing modules</title> - <sect1> - <title>Creating a new module</title> - <simpara>From the home page, choose any module, if you have not done that already (creation of a new module cannot occur outside a context, but that is irrelevant with the task we want to perform).</simpara> - <screenshot> - <graphic fileref="images/module-creation0.png"/> - </screenshot> - <simpara>From a module home page, or from many other pages, you can reach the module administration functions, but you may need to double-click in the left margin to make the menu appear.</simpara> - <screenshot> - <graphic fileref="images/module-creation1a.png"/> - </screenshot> - <screenshot> - <graphic fileref="images/module-creation1b.png"/> - </screenshot> - <simpara>From there, choose Modules, Manage modules and push the Create new button.</simpara> - <screenshot> - <graphic fileref="images/module-creation2.png"/> - </screenshot> - <simpara>You may now enter the information about the module that you want to create.</simpara> - <screenshot> - <graphic fileref="images/module-creation3.png"/> - </screenshot> - <simpara>Two fields are worth a particular attention.</simpara> - <simpara> - The <emphasis>Parent module</emphasis> determines at this time the module which will be used as a template, a model, for the module you are about to create. - Basically this means that the new module will "inherit" all Issue types and attributes from the parent module you choose.</simpara> - <caution> - <simpara>This "inheritance" occurs once and for all at the time of module creation. Issue types and attributes are copied from the parent to the new modules.</simpara> - <simpara>Modifications to the issue types and attributes of the parent module you choose now <emphasis>will not be propagated</emphasis> to the new module afterwards.</simpara> - <simpara>To say it yet another way, issue types and attributes are copied from the parent to the new module, not shared between them.</simpara> - </caution> - <simpara>The module parent will also appear in the modules lists. For instance, the <emphasis>Source</emphasis> module which has <emphasis>Pacman JVM</emphasis> as parent appears as such in the list:</simpara> - <screenshot> - <graphic fileref="images/module-creation3.png"/> - </screenshot> - <simpara>You can change the parent later (see next Section) if you want to change the display logic but that should not be the main reason of your parent module choice at creation time.</simpara> - </sect1> - <sect1> - <title>Editing a module</title> - <simpara>To edit the definition and properties of a module, choose <emphasis>Manage modules</emphasis> in the <emphasis>Admin</emphasis> menu, then choose the module.</simpara> - <simpara>The next screen is pretty self-explanatory.</simpara> - <screenshot> - <graphic fileref="images/module-edition1.png"/> - </screenshot> - <simpara>You cannot delete a module but you can mark it as deleted. The module will no longer appear in the modules lists (though it will still appear, as deleted, in the <emphasis>Manage modules</emphasis> list if you ever want to recall it someday later).</simpara> - <screenshot> - <graphic fileref="images/module-edition2.png"/> - </screenshot> - </sect1> -</chapter> +<?xml version="1.0" encoding="UTF-8"?> +<!-- $Id --> +<chapter> + <title>Creating and managing modules</title> + + <sect1> + <title>Creating a new module</title> + + <simpara>From the home page, choose any module, if you have not done that + already (creation of a new module cannot occur outside a context, but that + is irrelevant with the task we want to perform).</simpara> + + <screenshot> + <graphic fileref="images/module-creation0.png" /> + </screenshot> + + <simpara>From a module home page, or from many other pages, you can reach + the module administration functions, but you may need to double-click in + the left margin to make the menu appear.</simpara> + + <screenshot> + <graphic fileref="images/module-creation1a.png" /> + </screenshot> + + <screenshot> + <graphic fileref="images/module-creation1b.png" /> + </screenshot> + + <simpara>From there, choose <emphasis>Global data > Manage + modules</emphasis> and push the <emphasis>Create new</emphasis> + button.</simpara> + + <screenshot> + <graphic fileref="images/module-creation2.png" /> + </screenshot> + + <simpara>You may now enter the information about the module that you want + to create.</simpara> + + <screenshot> + <graphic fileref="images/module-creation3.png" /> + </screenshot> + + <simpara>A module is defined by the name attribute, a descripion, the code + attribute, a parent module and some more optional attributes. Read on for + some explanations for all of the attributes, which you can/have to set + when you create a module:</simpara> + + <simpara>The <emphasis>Name</emphasis> of the module id displayed, to + identify the module for example in the bread crumb trail, and all other + menues, where you can select a module.</simpara> + + <simpara>The <emphasis>Description</emphasis> is used as a more detailed + description of the module, in some menues.</simpara> + + <simpara>The <emphasis>Code</emphasis> represents the prefix for the issue + numbers of the module. If you choose NEWM for example, every issue number + of this module will have this prefix (NEWM1, NEWM2,...). Choose a unique + code with up to four letters.</simpara> + + <simpara>The <emphasis>Parent module</emphasis> determines at this time + the module which will be used as a template, for the module you are about + to create. Basically this means that the new module will "inherit" all + Issue types and attributes from the parent module you choose. You can + change the parent later (see next Section) if you want to change the + display logic.</simpara> + + <caution> + <simpara>This "inheritance" occurs once and for all at the time of + module creation. Issue types and attributes are copied from the parent + to the new modules.</simpara> + + <simpara>Modifications to the issue types and attributes of the parent + module you choose now <emphasis>will not be propagated</emphasis> to the + new module afterwards.</simpara> + + <simpara>To say it yet another way, issue types and attributes are + copied from the parent to the new module, not shared between + them.</simpara> + </caution> + + <simpara>The <emphasis>Visible by role </emphasis>attribute defines, which + users with which role have access to this module.</simpara> + + <simpara>For the <emphasis>Default report</emphasis> attribute, you can + choose every defined report for this module, which is public. The default + report will be displayed on the module home page.</simpara> + + <simpara>The <emphasis>Archive email</emphasis> is the main email address + for the module. On every activity, this email address will receive a + notification mail.</simpara> + + <simpara>By the <emphasis>Enable email</emphasis> attribute, you can + enable or disable, if scarab will send notification mails to the + users.</simpara> + + <simpara>The <emphasis>Inculde issue details</emphasis> attribute defines, + if scarab should include more detailed information about each activity + into the notification emails. If you don't enable this feature the + notification emails will only contain a link to the issue, which caused + the activity.</simpara> + + <simpara><emphasis>Render engine</emphasis> means if the comments of this + module will be interpreted, by an engine like the wiki radeox engine or + not. You can choose between the engines by the drop down menu.</simpara> + + <simpara>The <emphasis>Reason-field required</emphasis> attribute defines, + if the reason field on changing an attribute is optional or not.</simpara> + </sect1> + + <sect1> + <title>Editing a module</title> + + <simpara>To edit the definition and properties of a module, choose + <emphasis>Global data > Manage modules</emphasis> in the + <emphasis>Admin</emphasis> menu, then choose the module.</simpara> + + <simpara>The next screen is pretty self-explanatory, or see chapter 1 + <emphasis>Creating a new module</emphasis>.</simpara> + + <screenshot> + <graphic fileref="images/module-edition1.png" /> + </screenshot> + + <simpara>You cannot delete a module but you can mark it as deleted. The + module will no longer appear in the modules lists (though it will still + appear, as deleted, in the <emphasis>Manage modules</emphasis> list if you + ever want to recall it someday later).</simpara> + + <screenshot> + <graphic fileref="images/module-edition2.png" /> + </screenshot> + </sect1> +</chapter> \ No newline at end of file