modules/contextlinks/README.txt

contextlinks.module
README.txt
$Id: README.txt,v 1.3 2006/05/10 16:14:45 jhriggs Exp $

The context links module allows you to easily create links to
context-related material using a simple markup syntax.  The links are
indicated by either linking the text itself or by inserting a specific
string or icon that links to the related information.

Site administrators can define different "classes" of context links.
Each class can have a specific icon or string that is used for all
instances of that class.  Additionally, administrators define a
default class which will be used if no class is specified.

The syntax to insert context links is as follows:

  [?<class>:<URL> <link text>]

or, to use the default class,

  [?:<URL> <link text>]


Notes:

  * The URL can be relative (some/link), linking to information on the
    same site, or fully-qualified (http://some.site/), linking to
    information on another site.

  * The URL can optionally be preceded with a ^ (caret) to force the
    link to open in a new window or a ` (backtick) to force the link
    to open in the current window (if the class defaults to opening in
    a new window).

  * To include a right bracket in the URL or text of a context link,
    it must be "escaped" by preceding it with a backslash (\]).
    Likewise, to use a backslash it must be escaped also (\\).


Files
  - contextlinks.module
      the actual module (PHP source code)

  - contextlinks.info
      the module information file used by Drupal

  - contextlinks.install
      installation/upgrade functions (PHP source code)

  - contextlinks.js
      JavaScript code used for opening links in a new window in an
      HTML4/XHTML-valid manner

  - contextlinks.png
      a screen shot of examples of the default context links classes

  - README.txt (this file)
      general module information

  - INSTALL.txt
      installation/configuration instructions

  - CREDITS.txt
      information on those responsible for this module

  - TODO.txt
      feature requests and modification suggestions

  - CHANGELOG.txt
      change/release history for this module

  - LICENSE.txt
      the license (GNU General Public License) covering the usage,
      modification, and distribution of this software and its
      accompanying files
1	contextlinks.module
2	README.txt
3	$Id: README.txt,v 1.3 2006/05/10 16:14:45 jhriggs Exp $
4
5	The context links module allows you to easily create links to
6	context-related material using a simple markup syntax. The links are
7	indicated by either linking the text itself or by inserting a specific
8	string or icon that links to the related information.
9
10	Site administrators can define different "classes" of context links.
11	Each class can have a specific icon or string that is used for all
12	instances of that class. Additionally, administrators define a
13	default class which will be used if no class is specified.
14
15	The syntax to insert context links is as follows:
16
17	[?<class>:<URL> <link text>]
18
19	or, to use the default class,
20
21	[?:<URL> <link text>]
22
23
24	Notes:
25
26	* The URL can be relative (some/link), linking to information on the
27	same site, or fully-qualified (http://some.site/), linking to
28	information on another site.
29
30	* The URL can optionally be preceded with a ^ (caret) to force the
31	link to open in a new window or a ` (backtick) to force the link
32	to open in the current window (if the class defaults to opening in
33	a new window).
34
35	* To include a right bracket in the URL or text of a context link,
36	it must be "escaped" by preceding it with a backslash (\]).
37	Likewise, to use a backslash it must be escaped also (\\).
38
39
40	Files
41	- contextlinks.module
42	the actual module (PHP source code)
43
44	- contextlinks.info
45	the module information file used by Drupal
46
47	- contextlinks.install
48	installation/upgrade functions (PHP source code)
49
50	- contextlinks.js
51	JavaScript code used for opening links in a new window in an
52	HTML4/XHTML-valid manner
53
54	- contextlinks.png
55	a screen shot of examples of the default context links classes
56
57	- README.txt (this file)
58	general module information
59
60	- INSTALL.txt
61	installation/configuration instructions
62
63	- CREDITS.txt
64	information on those responsible for this module
65
66	- TODO.txt
67	feature requests and modification suggestions
68
69	- CHANGELOG.txt
70	change/release history for this module
71
72	- LICENSE.txt
73	the license (GNU General Public License) covering the usage,
74	modification, and distribution of this software and its
75	accompanying files