<?xml version="1.0" encoding="iso-8859-1"?>
<chapter id="modules_notes">
  <title>The notes module</title>
  
  <para>The notes module gives you the possibility to store texts in
    moregroupware. These texts can be assigned to groups, which can be
    freely created. Main purpose of this module is the management of short
    parts of documentation, configuration notes, code snippets or
    whatever. You may use it as a sticky notes replacement as well, if you
    like.
  </para>
  
  <section id="modules_notes_overview">
    <title>Notes in the Overview module</title>
    
    <para>If you enable the display of notes for the Overview module, the
      Overview module will show you the notes that have been created or
      modified since your last login.
    </para>
    
  </section>
  
  <section id="modules_notes_notes">
    <title>Managing notes</title>
    
    <para>This section describes the creation and management of notes.</para>
    
    <section id="modules_notes_notes_overview">
      <title>The notes overview screen</title>
      
      <para>As you can see, the notes are displayed in a list, showing the
        public setting on the left side, followed by the note title and the
        group the note is associated to.
      </para>
      
      <figure>
        <title>Notes overview</title>
        <graphic fileref="images/modules/notes/overview.png"/>
      </figure>
      
      <para>The submenu allows you to get back to this overview page by
        clicking on "Notes Overview" any time. You can create a new note by
        clicking on "New Note" in the submenu or by clicking on the new note
        link on the right side above and below the notes list.
      </para>
      
    </section>
    
    <section id="modules_notes_notes_details">
      <title>Viewing notes details</title>
      
      <para>To see the note's content, click on the detail link on the left
        of the group column on the overview screen. This will take you to the
        note detail screen.
      </para>
      
      <figure>
        <title>Notes details</title>
        <graphic fileref="images/modules/notes/details.png"/>
      </figure>
      
      <para>Click on &quot;back&quot; or use the submenu to return to the
        overview page.
      </para>
      
      <para>If comments are enabled, you will have the possibility to add
        comments to a note. To do so simply fill in the field at the bottom
        of the screen and click the 'Save' button. Your comment will be shown
        below the note's contents.
      </para>
      
      <note>
        <para>Once submitted, a comment cannot be edited or deleted (yet)!</para>
      </note>
      
    </section>
    
    <section id="modules_notes_notes_create">
      <title>Creating notes</title>
      
      <para>To create a new note click on "New Note" in the submenu or use
        the new note links above and below the notes overview list.
      </para>
      
      <figure>
        <title>Creating a note</title>
        <graphic fileref="images/modules/notes/create.png"/>
      </figure>
      
      <para>Fill in the title and the content (everything will be displayed
        just as you input it). Adjust the public setting as you like (setting
        it to yes will enable other users to view and edit your note) and
        choose a group if you want. See "Managing Groups" for more information
        on creating groups.
      </para>
      
      <para>Click on "Create" to save the new note when finished. You will
        return to the notes overview, where you will see your newly created
        note
      </para>
      
    </section>
    
    <section id="modules_notes_notes_edit">
      <title>Editing notes</title>
      
      <para>To edit a note, just click on the edit link on the notes
        overview page. You will be taken to a page similar to the "New Note"
        screen. The form will be populated with the note's data, which can be
        changed as you like. Click on "Save" to save your changes. Clicking on
        a submenu link or on "back" aborts the edit process.
      </para>
      
      <figure>
        <title>Editing a note</title>
        <graphic fileref="images/modules/notes/edit.png"/>
      </figure>
      
      <note>
        <para>If a note is declared public, every user can edit or even delete
          the note! And if you see a note, which is public but not owned by you,
          you can declare it non-public - it will no longer be listed on the
          overview screen.
        </para>
      </note>
      
    </section>
    
    <section id="modules_notes_notes_delete">
      <title>Deleting notes</title>
      
      <para>To delete a note, just click on the delete link on the notes
        overview page. You will be prompted for confirmation, before the note
        is deleted.
      </para>
      
    </section>
    
  </section>
  
  <section id="modules_notes_categories">
    <title>Managing note categories</title>
    
    <section id="modules_notes_categories_overview">
      <title>The notes categories overview screen</title>
      
      <para>As you can see, the categories are displayed in a list, showing the
        category name and the category's description.
      </para>
      
      <figure>
        <title>Category overview</title>
        <graphic fileref="images/modules/notes/catoverview.png"/>
      </figure>
      
      <para>The submenu allows you to get back to this overview page by
        clicking on "Category Management" any time. You can create a new
        category by clicking on "New Category" in the submenu or by clicking
        on the new categroy link on the right side above and below the
        list.
      </para>
      
    </section>
    
    <section id="modules_notes_categories_create">
      <title>Creating categories</title>
      
      <para>To create a new category click on "New Category" in the submenu
        or use the new category links above and below the overview
        list.
      </para>
      
      <figure>
        <title>Creating a category</title>
        <graphic fileref="images/modules/notes/catcreate.png"/>
      </figure>
      
      <para>Fill in the name and the description for the new category. Click
        on "Create" to create the new category when finished. You will return
        to the overview, where you will see your newly created
        category.
      </para>
      
    </section>
    
    <section id="modules_notes_categories_edit">
      <title>Editing categories</title>
      
      <para>To edit a category, just click on the edit link on the overview
        page. You will be taken to a page similar to the "New Category"
        screen. The form will be populated with the category's data, which can
        be changed as you like. Click on "Save" to save your changes. Clicking
        on a submenu link or on "back" aborts the edit process.
      </para>
      
      <figure>
        <title>Editing a category</title>
        <graphic fileref="images/modules/notes/catedit.png"/>
      </figure>
      
    </section>
    
    <section id="modules_notes_categories_delete">
      <title>Deleting a category</title>
      
      <para>To delete a category, just click on the delete link on the
        overview page. You will be prompted for confirmation, before the note
        is deleted. If you delete a category which has notes associated to it,
        the notes will be reset to "No category mapping"!
      </para>
      
    </section>
    
  </section>
  
  <section id="modules_notes_configuration">
    <title>Configuring the notes module</title>
    
    <para>To configure the notes module, you need to access the Settings
      page by clicking the &quot;Settings&quot; tab on the menu bar. Once
      that page opens, find the Notes section and click on the
      &quot;Settings&quot; link. If you are logged in as an Admin, there
      will be a second link named &quot;General settings&quot;.
    </para>
    
    <section id="modules_notes_configuration_user">
      <title>User settings</title>
      
      <variablelist>
        <varlistentry>
          <term>Sort by
          </term>
          <listitem>
            <para>The default sorting method for the notes overview list.
            </para>
          </listitem>
        </varlistentry>
        
        <varlistentry>
          <term>Sort order
          </term>
          <listitem>
            <para>The default sorting order for the notes overview list.
            </para>
          </listitem>
        </varlistentry>
        
        <varlistentry>
          <term>Max. number of notes in overview
          </term>
          <listitem>
            <para>How many notes to show in the Overview module as a maximum.
            </para>
          </listitem>
        </varlistentry>
      </variablelist>
    </section>
    
    <section id="modules_notes_configuration_general">
      <title>General settings</title>
      
      <variablelist>
        <varlistentry>
          <term>Comments on notes
          </term>
          <listitem>
            <para>Allows to enable or disable the comment feature for the notes module.
            </para>
          </listitem>
        </varlistentry>
      </variablelist>
    </section>
    
  </section>
  
</chapter>
