modules/outline/README.txt

;$Id: README.txt,v 1.1 2008/11/26 03:03:23 augustin Exp $
README.txt for outline module.


==================
== Permissions  ==
==================

______________________________________
1) Permissions defined by book.module:
______________________________________

add content to books
--------------------
The users see the link "Add child page" below a node, allowing them to create a new node which will automatically be added to the book outline.


administer book outlines
------------------------
The users see the link "Add child page" below a node, allowing them to create a new node which will automatically be added to the book outline.
They see the "Outline tab" in a node.
They can add any node into any outline, even nodes that are not regularly allowed in book outlines.


create new books 
----------------
The users can create new books, e.g. new top level nodes acting as book covers of new outlines.


access printer-friendly version
-------------------------------
The users see the link "Show a printer-friendly version of this book page and its sub-pages." below a node.


_________________________________________
2) Permissions defined by outline.module:
_________________________________________

The following book.module permissions are not modified in any way by outline.module:
  - administer book outlines.
  - create new books
  - access printer-friendly version 

By default, outline.module does not modify the permission 'add content to books' set by book.module. 
If you have been using book.module for a while, when you enable outline.module for the first time, none of the current permissions will be affected.
Only when you edit the permissions for a specific book, will the outline.module affect the default permissions.

With outline module, you can edit the 'add content to books'  permissions or a per-book basis.
You can set which roles can add content to which books.
You can also set which individual users can add content to which books.
Thus users who didn't have the 'add content to books' can add content to specific books.
Inversely, users who had that permission, can be denied adding content to specific books.


Note, the link "Create child page" at the bottom of an outlined node will show up if the two following conditions are met:
- the user must be allowed to add content to the current book.
- the user is allowed to create content of the default type set for that book.


==============================
== Your support is welcome  ==
==============================

The module outline is charity-ware.
--------------------------------------

Please contribute back by supporting the charity work of the following web sites. 
None of the web sites listed here are for profit, and none of them carry advertising.
They are all web sites dedicated to creating a better tomorrow for the whole society.

 * http://activistsolutions.org/ Activist Solutions: harvesting grassroots power.
 * htpp://www.reuniting.info/ Reuniting: healing with sexual relationships.
 * http://overshoot.tv/ Overshoot TV: making high quality videos and documentaries promoting environmental and economical sustainability.
 * http://minguo.info/ Minguo.info: promotting better voting systems, and an experiment in direct democracy.
 * http://www.wechange.org/ We Change: because we live in a world of solutions...


You can support those web sites in the following ways:

 * Blog about them.
 * Put links in a block in a sidebar.
 * Put links in any other logical place in your web site, where your visitors will find the information useful.
 * Register and participate if they match your own interest!
 * We also appreciate if, on behalf of this maintainer, you help any charity of your choice, or/and make a donation to them.

Please let the maintainer know about the options you chose. 

Thank you for your support and cooperation.


1	;$Id: README.txt,v 1.1 2008/11/26 03:03:23 augustin Exp $
2	README.txt for outline module.
3
4
5	==================
6	== Permissions ==
7	==================
8
9	______________________________________
10	1) Permissions defined by book.module:
11	______________________________________
12
13	add content to books
14	--------------------
15	The users see the link "Add child page" below a node, allowing them to create a new node which will automatically be added to the book outline.
16
17
18
19	administer book outlines
20	------------------------
21	The users see the link "Add child page" below a node, allowing them to create a new node which will automatically be added to the book outline.
22	They see the "Outline tab" in a node.
23	They can add any node into any outline, even nodes that are not regularly allowed in book outlines.
24
25
26	create new books
27	----------------
28	The users can create new books, e.g. new top level nodes acting as book covers of new outlines.
29
30
31	access printer-friendly version
32	-------------------------------
33	The users see the link "Show a printer-friendly version of this book page and its sub-pages." below a node.
34
35
36	_________________________________________
37	2) Permissions defined by outline.module:
38	_________________________________________
39
40	The following book.module permissions are not modified in any way by outline.module:
41	- administer book outlines.
42	- create new books
43	- access printer-friendly version
44
45	By default, outline.module does not modify the permission 'add content to books' set by book.module.
46	If you have been using book.module for a while, when you enable outline.module for the first time, none of the current permissions will be affected.
47	Only when you edit the permissions for a specific book, will the outline.module affect the default permissions.
48
49	With outline module, you can edit the 'add content to books' permissions or a per-book basis.
50	You can set which roles can add content to which books.
51	You can also set which individual users can add content to which books.
52	Thus users who didn't have the 'add content to books' can add content to specific books.
53	Inversely, users who had that permission, can be denied adding content to specific books.
54
55
56
57	Note, the link "Create child page" at the bottom of an outlined node will show up if the two following conditions are met:
58	- the user must be allowed to add content to the current book.
59	- the user is allowed to create content of the default type set for that book.
60
61
62	==============================
63	== Your support is welcome ==
64	==============================
65
66	The module outline is charity-ware.
67	--------------------------------------
68
69	Please contribute back by supporting the charity work of the following web sites.
70	None of the web sites listed here are for profit, and none of them carry advertising.
71	They are all web sites dedicated to creating a better tomorrow for the whole society.
72
73	* http://activistsolutions.org/ Activist Solutions: harvesting grassroots power.
74	* htpp://www.reuniting.info/ Reuniting: healing with sexual relationships.
75	* http://overshoot.tv/ Overshoot TV: making high quality videos and documentaries promoting environmental and economical sustainability.
76	* http://minguo.info/ Minguo.info: promotting better voting systems, and an experiment in direct democracy.
77	* http://www.wechange.org/ We Change: because we live in a world of solutions...
78
79
80	You can support those web sites in the following ways:
81
82	* Blog about them.
83	* Put links in a block in a sidebar.
84	* Put links in any other logical place in your web site, where your visitors will find the information useful.
85	* Register and participate if they match your own interest!
86	* We also appreciate if, on behalf of this maintainer, you help any charity of your choice, or/and make a donation to them.
87
88	Please let the maintainer know about the options you chose.
89
90	Thank you for your support and cooperation.
91
92
93
94