XRef Plugin Requirements

Here's my requirements for a cross referencing plugin.

%XREF_TAG%

tag="x"

%XREF_TAG%

uid="x"

%XREF_TAG%

tag="x"

%XREF_TAG%

uid="x"

%XREF{topic="SomeTopic" uid="x"}% will grab the corresponding tag setting from the <verbatim>%XREF_TAG%</verbatim> in the specified [[TWiki.TWikiTopics][TWikiTopic]] and it will become the rendered value. |
| | 3.1  | If a topic setting is not specified it will default to the current one. |
| <b>4</b>  || The auto setting of <verbatim>%XREF_TAG%</verbatim> determines whether a topic is automatically renumbered upon saving. |
| | 4.1  | If the auto setting of a <verbatim>%XREF_TAG%</verbatim> keyword is set to on and the [[TWiki.TWikiTopics][TWikiTopic]] is being saved it will automatically renumber the tag setting of <verbatim>%XREF_TAG%</verbatim> keywords |
| | 4.2  | When renumbering if no parent setting is specified then it will set it to the number of <verbatim>%XREF_TAG%</verbatim> keywords with no parent setting plus one occuring before this one in the [[TWiki.TWikiTopics][TWikiTopic]]. |
| | 4.3  | When renumbering, if a parent setting is specified, i.e. <verbatim>parent="uid"</verbatim>, then tag is set to the corresponding parent's tag concatenated with seperator, followed by the number of keywords with the same parent setting occuring before the current one plus one in the [[TWiki.TWikiTopics][TWikiTopic]]. |
| | 4.4  | If the auto setting of a <verbatim>%XREF_TAG%</verbatim> keyword is set to off and there is no tag, the tag will be set to a question mark. |
| | 4.5  | The auto setting defaults to on when it isn't present. |
| <b>5</b>  || The <verbatim>%XREF_TAG%</verbatim> will be rendered as it's tag setting. |

%X% The current problem I have is I can't get a plugin of a different name to register and activate. I copy the empty plugin, and change it's filename, it's module name in two places in the file. And nada. Do I have to have more than this to start testing a plugin?

---+++ Discussion
1.1 : Tag should be unique (specwise ? over release? 1.2 say topic) . should they be continuous ? over a full specs ? one fragment ?  like this req) ? I understand continuity is helpful from a readability viewpoint, but I think partial order may suffice, or in the context of electronic ref (html) , the value is less important, as you do not read it, u just click on it. see my point ?

-- Main.ShawnGarbett - 12 Nov 2003 Tag's can be specified by the editor and are not required to be unique. To make this requirement, really adds a large overhead to the process. Only the uid is required to be unique.

3. what about detecting conflicts ? i.e. value already used ? also, renumbering ? (dnt know if that last one is pertinent. just came to my mind)

-- Main.ShawnGarbett - 12 Nov 2003 Detecting conflicts in the uids is troublesome. People shouldn't be editing them, they should be automatic. If you touch, expect trouble. The renumbering is automatic, for everything with auto=on. This is the real beauty of the plugin, I can rearranged a set of requirements like the above to my hearts content. All references to it will automatically update. Hmmm. There's a requirement I missed, all xrefs should be links. What about cross web links?

General: 
The Action tracker plugin rewrite the text when saved. what is not filled become filled with default. meaning that the "default" are not detectable after saved. I understand it is not the case here, right ? no rewrite, I mean ...

-- Main.ShawnGarbett - 12 Nov 2003 This is doable easily. The only default of note is the "auto" setting. The others are filled in.