modules/reptag/README.txt

*****************************************************************************
                     R E P L A C E M E N T    T A G S
*****************************************************************************
Name: reptag module
Author: Thilo Wawrzik <drupal at profix898 dot de>
Drupal: 6.x
*****************************************************************************
DESCRIPTION:

The Rep[lacement]Tags module allows you to define tags (like $MYTAG$
or {DATE}) and replace them with user-defined text, images, code, ...
or use RepTag to format your pages with simple markup-style tags.

This is especially useful to save typing-time when similar phrases or
or complex text-pattern are used frequently.

*****************************************************************************
INSTALLATION:

1. Place whole reptag folder into your Drupal modules/ directory.

2. Enable the reptag module by navigating to
     Administer > Site Building > Modules (admin/build/modules)
     
3. Bring up the reptag configuration screen by navigating to
     Administer > Site Configuration > RepTag (admin/settings/reptag)
     
4. Configure all settings after your fancy
   
5. Click "Save Configuration".

*****************************************************************************
UPDATE:

1. Replace all files with the latest version and run 'update.php'

2. It is very recommended to enable 'PartialCache' feature under
   'Settings / General / Expert-Settings' to increase performance.

*****************************************************************************

Visit http://www.profix898.de/drupal/reptag to read more
detailed documentation on the Rep[lacement]Tags module.

! You can use module tags in the replacement of site/user tags. This
is possible because module tags are processed after the table tags.
(order of execution: table tags first -> then module tags by weight)

*****************************************************************************
DETAILED DESCRIPTION:

The reptag module makes three different types of replacement tags
available to the user.

+ Module - Replacement Tags
There are several .tags modules in the reptag folder. Theses module
are using some kind of plugin framework to extend the basic reptag
functionality. All these modules export certain tags.
For example system.tags adds Date, Time, User ... tags like {DATE} or
{USERNAME}, which are replaced with the current date and username,
node.tags exports {AUTHOR} representing the current node's author ...
For detailed information on .tags modules take a look at sample.tags_
and read the DEVELOPER.txt documentation.

+ SiteWide - Replacement Tags
SiteWide replacement tags can be used by everyone on your site (thats
why they are called site wide ;)) These tags can be managed by users
with 'manage sitewide reptags' permission.

+ User - Replacement Tags
Every user with 'manage user reptags' permission can define his/her
own tags in addition to the modules tags and site wide tags. The
user-defined tags are available only on nodes created by the user and
have a higher priority than site wide ones by default.

SiteWide- and User-Tags are managed from the reptag administration
pages. You can easily add/delete/modify these tags online.
On sites using the 'workspace' module users can manage their reptags
from a tab within their workspace (assumed you grant them 'manage
user reptags' permissions).

Reptag provides a powerful rights management. You can enable/disable
tags modules per role and define 'exclude tags' to disable distinct
tags (modules or sitewide/user) for use in certain roles.
Additionally you can select the content fields to run the replacement
process on. What means you can also run reptag on cck (text) fields.

Reptag module provides online help and automatically generates an
overview table of all tags available for the current node and user.
You can find it under 'Rep[lacement]Tags - Help' on every node
creation form.

Read the documentation to get more information and guidelines on
how to configure, use and extend the Rep[lacement]Tags module.

*****************************************************************************
ABOUT PARTIAL CACHE

Many tags are static, what means they do not change with the user or
time a node is displayed. SiteWide- and User-Tags are always static
and .tags-Modules are marked internally static/dynamic. Most benefit
from above distinction is the ability to cache all static parts of a
node. That provides a performance boost, since most nodes are no
longer processed on every view.

*****************************************************************************
Have fun with reptag, Thilo.
1	*****************************************************************************
2	R E P L A C E M E N T T A G S
3	*****************************************************************************
4	Name: reptag module
5	Author: Thilo Wawrzik <drupal at profix898 dot de>
6	Drupal: 6.x
7	*****************************************************************************
8	DESCRIPTION:
9
10	The Rep[lacement]Tags module allows you to define tags (like $MYTAG$
11	or {DATE}) and replace them with user-defined text, images, code, ...
12	or use RepTag to format your pages with simple markup-style tags.
13
14	This is especially useful to save typing-time when similar phrases or
15	or complex text-pattern are used frequently.
16
17	*****************************************************************************
18	INSTALLATION:
19
20	1. Place whole reptag folder into your Drupal modules/ directory.
21
22	2. Enable the reptag module by navigating to
23	Administer > Site Building > Modules (admin/build/modules)
24
25	3. Bring up the reptag configuration screen by navigating to
26	Administer > Site Configuration > RepTag (admin/settings/reptag)
27
28	4. Configure all settings after your fancy
29
30	5. Click "Save Configuration".
31
32	*****************************************************************************
33	UPDATE:
34
35	1. Replace all files with the latest version and run 'update.php'
36
37	2. It is very recommended to enable 'PartialCache' feature under
38	'Settings / General / Expert-Settings' to increase performance.
39
40	*****************************************************************************
41
42	Visit http://www.profix898.de/drupal/reptag to read more
43	detailed documentation on the Rep[lacement]Tags module.
44
45	! You can use module tags in the replacement of site/user tags. This
46	is possible because module tags are processed after the table tags.
47	(order of execution: table tags first -> then module tags by weight)
48
49	*****************************************************************************
50	DETAILED DESCRIPTION:
51
52	The reptag module makes three different types of replacement tags
53	available to the user.
54
55	+ Module - Replacement Tags
56	There are several .tags modules in the reptag folder. Theses module
57	are using some kind of plugin framework to extend the basic reptag
58	functionality. All these modules export certain tags.
59	For example system.tags adds Date, Time, User ... tags like {DATE} or
60	{USERNAME}, which are replaced with the current date and username,
61	node.tags exports {AUTHOR} representing the current node's author ...
62	For detailed information on .tags modules take a look at sample.tags_
63	and read the DEVELOPER.txt documentation.
64
65	+ SiteWide - Replacement Tags
66	SiteWide replacement tags can be used by everyone on your site (thats
67	why they are called site wide ;)) These tags can be managed by users
68	with 'manage sitewide reptags' permission.
69
70	+ User - Replacement Tags
71	Every user with 'manage user reptags' permission can define his/her
72	own tags in addition to the modules tags and site wide tags. The
73	user-defined tags are available only on nodes created by the user and
74	have a higher priority than site wide ones by default.
75
76	SiteWide- and User-Tags are managed from the reptag administration
77	pages. You can easily add/delete/modify these tags online.
78	On sites using the 'workspace' module users can manage their reptags
79	from a tab within their workspace (assumed you grant them 'manage
80	user reptags' permissions).
81
82	Reptag provides a powerful rights management. You can enable/disable
83	tags modules per role and define 'exclude tags' to disable distinct
84	tags (modules or sitewide/user) for use in certain roles.
85	Additionally you can select the content fields to run the replacement
86	process on. What means you can also run reptag on cck (text) fields.
87
88	Reptag module provides online help and automatically generates an
89	overview table of all tags available for the current node and user.
90	You can find it under 'Rep[lacement]Tags - Help' on every node
91	creation form.
92
93	Read the documentation to get more information and guidelines on
94	how to configure, use and extend the Rep[lacement]Tags module.
95
96	*****************************************************************************
97	ABOUT PARTIAL CACHE
98
99	Many tags are static, what means they do not change with the user or
100	time a node is displayed. SiteWide- and User-Tags are always static
101	and .tags-Modules are marked internally static/dynamic. Most benefit
102	from above distinction is the ability to cache all static parts of a
103	node. That provides a performance boost, since most nodes are no
104	longer processed on every view.
105
106	*****************************************************************************
107	Have fun with reptag, Thilo.