src/cm/templates/site/help.html
author rbernard
Wed, 20 Jan 2010 20:43:38 +0100
changeset 103 61fd17f9ab78
parent 0 40c8f766c9b8
child 106 36165e7cd1f0
permissions -rw-r--r--
enh: detached comments bug fix: test corrected bug fix: permalink to comment
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     1
{% extends "site/layout/base_workspace.html" %}
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     2
{% load com %}
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     3
{% load i18n %}
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     4
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     5
{% block title %}
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     6
{% blocktrans %}Help{% endblocktrans %}
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     7
{% endblock %}
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     8
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
     9
{% block head %}
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    10
{% endblock %}
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    11
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    12
{% block content %}
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    13
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    14
<h1>Help</h1>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    15
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    16
<h2>General Presentation</h2>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    17
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    18
XXX
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    19
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    20
<h2>Glossary</h2>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    21
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    22
<h3>Text edition</h3>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    23
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    24
<dl>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    25
  <dt><a name="markdown"></a>Markdown</dt>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    26
    <dd>XXX</dd>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    27
    
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    28
</dl>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    29
103
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    30
<h3>Texts</h3>
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    31
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    32
<dl>
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    33
  <dt><a name="version_edit"></a>Edit</dt>
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    34
    <dd></dd>
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    35
</dl>
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    36
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    37
<h3>Comments</h3>
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    38
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    39
<dl>
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    40
  <dt><a name="collaboration"></a>Collaboration <em>à remonter</em></dt>
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    41
    <dd>For now co-ment chose to allow groups of people to collaborate using an unilateral moderation scheme. A group of users, initially chosen by the creator of the workspace, are given supervisors kind of rôles, that allow them to moderate others' comments. This privileged group of users, having say, a Manager rôle could be singled out to a teacher managing a classroom. The right management scheme allows for temporary delegation and offers the minimum openness and organizational incentives we thought we should expect from community driven softwares.
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    42
     
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    43
    un peu de feedback  un lien vers contact dans la newsletter
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    44
    Give it a try. And remember to tell us about moderation policy you chose.</dd>
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    45
    
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    46
  <dt><a name="comment_moderation"></a>Moderation</dt>
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    47
    <dd><p>Comment moderation is the process of editing/removing comments from a text. Moderator rôle is the collection of permissions required to edit/remove a comment submitted by users of the workspace.</p> 
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    48
    <p>Although this is not the default, you can choose that "pending comments require publishing" and what that really means is that comments from users with an Observer or Commentator role won't be visible to their author's peers before a user (with at least Moderator role) actually validate the content.</p> 
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    49
    Moderators is the mimimum rôle to publish comments.
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    50
  <dt><a name="comment_state"></a>States</dt>
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    51
    <dd>co-ment uses states to manage its featured moderation policies. Unapproved comments are only visible to Managers, Editors and Moderators. Approved comments are visible to users with any rôle. Pending comments will be visible if you decide so in the settings tab of the text.</dd>
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    52
  <dt><a name="comment_tag"></a>Tags</dt>
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    53
    <dd>Here at co-ment.org we think that simple workflow as well as basic classification needs will be satisfied using tags one clever way or another. We find it usefull to use tag for TODOs, peer revisions, and general content follow up.</dd>
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    54
    
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    55
  <dt><a name="comment_inter_links"></a>Linking to a comment</dt>
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    56
    <dd>You may find yourself needing to link to a comment from another one. In such case you can do so by copying your target comment's permalink that shows up when you hover over a comment title.  Please note: Your visitor experience will be different if the comment you are referring to belongs to same text. If it does then the link won't open a new window and getting back to the referrer comment can be a difficult task. (allowing a systematic new window on comment links is still to be implemented as is the even better solution of updating comment referrences between versions <em>BUG link</em> we rely on users feedback <em>link</em>for  proper behaviors on situations like this). If the referrenced comment is in another text then opening a new window is the default behavior.</dd>
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    57
    
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    58
  <dt><a name="comment_scope"></a>Scope</dt>
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    59
    <dd>We call scope of the comment the annotated part of the text the comment is about.</dd>
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    60
  <dt><a name="comment_versions"></a>Keeping your comments across versions</dt>
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    61
    <dd>When you create a new version of the text, comments are duplicated.  In case the text edition did not change the <a href="#comment_scope">scope</a> of the comment co-ment will retain comment's scope between versions through a simple computation. If the scope has been modified then a decision has to be made regarding the conservation of the comment in the new version. For all such comments you'll be given a choice wether you want them kept in the new version as 'detached' from the text (annotation won't be highlighted in the new version's but comments will still be available when browsing) or entirely removed from the new version.</dd>
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    62
    
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    63
</dl>
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    64
0
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    65
<h3>Roles</h3>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    66
<dl>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    67
  <dt><a name="roles"></a>Roles</dt>
103
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    68
    <dd>Roles are predefined sets of permissions. </dd>
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    69
    <dd>Your text will not be available by public vistors before anonymous users are given a role on the text.</dd>
0
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    70
    
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    71
  <dt><a name="local_role"></a>Local role</dt>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    72
    <dd>A local role is a role that is set for a specific user on a specific text.  It can be used to override a possibly existing workspace-level role or to give a user a role on a text (and not on every text in the workspace).</dd>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    73
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    74
  <dt><a name="role_model"></a>Role model</dt>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    75
    <dd>A role model is a role set useful in a specific use case</dd>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    76
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    77
</dl>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    78
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    79
<h3>Notification and feeds</h3>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    80
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    81
<dl>    
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    82
  <dt><a name="email_notifications"></a>Email notification</dt>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    83
    <dd>Email notifications are a way for users to be informed when a new comment is added on a text they follow by receiving emails.</dd>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    84
    
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    85
  <dt><a name="feed"></a>Feeds</dt>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    86
    <dd>A <a title="Web feed definition on Wikipedia" href="http://en.wikipedia.org/wiki/Web_feed">(web) feed</a> is a news feed on a specific text or on the whole workspace.</dd>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    87
    
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    88
  <dt><a name="public_private_feed"></a>Public and private feeds</dt>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    89
    <dd>The public feed includes all the events publically accessible on the workspace or a specific text.  The private feed includes all events.  Be sure to share this feed with caution.</dd>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    90
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    91
  <dt><a name="embed"></a>Text embedding</dt>
103
61fd17f9ab78 enh: detached comments
rbernard
parents: 0
diff changeset
    92
    <dd>You can embed your text into a page of your own website. Visitors will be able to add comments from your website depending on anonymous users' roles on the text. For a proper test condition when embedding in your own site, in particular for experiencing links referencing comments in the same or different text, be sure your are not logged into your workspace in another tab of your browser. </dd>
0
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    93
    
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    94
</dl>
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    95
40c8f766c9b8 import from internal svn r 4007
raph
parents:
diff changeset
    96
{% endblock %}