modules/links/PREFIXES.txt

$Id: PREFIXES.txt,v 1.1 2006/03/17 16:17:09 syscrusher Exp $

This file is an informally-maintained registry of the module prefixes that are
used in the Links API calls for the $module parameter.

The actual URLs cataloged by the Links API are global to all Drupal modules,
but the references in the {links_node} table that map these URLs to individual
nodes can be made local to a specific module or module package.

Module developers who use the Links API may request a namespace prefix string
that allows their modules to create such application-specific link references.
Once you have a prefix, anything "under" that prefix is yours to name as you
wish.

Suppose, for instance, that you register the prefix "example". You can then
store links with $module="example" and be (reasonably) assured that no other
module will tinker with the link-node mapping (the URL itself, however, is
managed by links.module globally).

The underscore can be used to create sub-namespaces within your registered prefix,
to any desired nesting depth. So if instead of just example.module you are
creating "the Example package" with modules example.module, example_view.module,
example_taxonomy.module, and so on, you can (if you wish) carve up your
namespace with $module="example", $module="example_view", and
$module="example_taxonomy". You are not *required* to do this -- it is purely
up to you, depending on whether your modules should share link references or
treat them separately. Basically, you may place any string after the "example_"
prefix that you wish as long as it fits into the database column.

Prefix registrations should be considered case-insensitive; that is, if you
reserve "example" no one else can reserve "Example" or "EXAMPLE" because they
are treated as equal by the API. Also, ownership of "example" implies ownership
of "example_*" but NOT of "example*" (so, for instance, you don't get
"examples" or "examplemania" or "examplethemes").


REGISTRATION PROCEDURE:

	Please DO NOT update the following lists. This information is kept by
	the Links Package maintainer, Syscrusher (http://drupal.org/user/9184).
	To request a new prefix registry, or remove one no longer needed,
	use the Drupal contact form for Syscrusher.

RESERVED PREFIXES:

	(empty string)		Reserved to indicate a "don't care" or "any"
				selection criterion for finding links for a
				node.

	links			Reserved for the Links Package and its included
				modules.

	drupal			Reserved for future use.

	example			As in domain names, the word "example" in this
				context is reserved for illustrative purposes
				in documentation.

REGISTERED PREFIXES:

	tagmark			budda (http://drupal.org/user/13164)

	cck			Content Construction Kit (CCK)

1	$Id: PREFIXES.txt,v 1.1 2006/03/17 16:17:09 syscrusher Exp $
2
3	This file is an informally-maintained registry of the module prefixes that are
4	used in the Links API calls for the $module parameter.
5
6	The actual URLs cataloged by the Links API are global to all Drupal modules,
7	but the references in the {links_node} table that map these URLs to individual
8	nodes can be made local to a specific module or module package.
9
10	Module developers who use the Links API may request a namespace prefix string
11	that allows their modules to create such application-specific link references.
12	Once you have a prefix, anything "under" that prefix is yours to name as you
13	wish.
14
15	Suppose, for instance, that you register the prefix "example". You can then
16	store links with $module="example" and be (reasonably) assured that no other
17	module will tinker with the link-node mapping (the URL itself, however, is
18	managed by links.module globally).
19
20	The underscore can be used to create sub-namespaces within your registered prefix,
21	to any desired nesting depth. So if instead of just example.module you are
22	creating "the Example package" with modules example.module, example_view.module,
23	example_taxonomy.module, and so on, you can (if you wish) carve up your
24	namespace with $module="example", $module="example_view", and
25	$module="example_taxonomy". You are not required to do this -- it is purely
26	up to you, depending on whether your modules should share link references or
27	treat them separately. Basically, you may place any string after the "example_"
28	prefix that you wish as long as it fits into the database column.
29
30	Prefix registrations should be considered case-insensitive; that is, if you
31	reserve "example" no one else can reserve "Example" or "EXAMPLE" because they
32	are treated as equal by the API. Also, ownership of "example" implies ownership
33	of "example_" but NOT of "example" (so, for instance, you don't get
34	"examples" or "examplemania" or "examplethemes").
35
36
37	REGISTRATION PROCEDURE:
38
39	Please DO NOT update the following lists. This information is kept by
40	the Links Package maintainer, Syscrusher (http://drupal.org/user/9184).
41	To request a new prefix registry, or remove one no longer needed,
42	use the Drupal contact form for Syscrusher.
43
44	RESERVED PREFIXES:
45
46	(empty string) Reserved to indicate a "don't care" or "any"
47	selection criterion for finding links for a
48	node.
49
50	links Reserved for the Links Package and its included
51	modules.
52
53	drupal Reserved for future use.
54
55	example As in domain names, the word "example" in this
56	context is reserved for illustrative purposes
57	in documentation.
58
59	REGISTERED PREFIXES:
60
61	tagmark budda (http://drupal.org/user/13164)
62
63	cck Content Construction Kit (CCK)
64