Re: Question about designators, again.

Hi Tom:

In message <MWHPR08MB29417A264F8BB02A79E8BDC1CA320@MWHPR08MB2941.namprd08.prod.
outlook.com>,
Tom Ekberg writes:

>I have a tracker developer using a feature of roundup that appears to
>not be documented. [...]
>
>So far nothing special. In the same file immediately below the list
>of idblock values is this fragment:
>
><tr>
> <td ><input type="text" name="idblock-1@mrn" /></td>
> <td ><input type="text" name="idblock-1@accession_number" /></td>
> <td ><input type="text" name="idblock-1@su_number" /></td>
> <td ><input type="text" name="idblock-1@block_number" /></td>
> <td ><input type="text" name="idblock-1@tissue_type" /></td>
> <td ><input type="text" name="idblock-1@run" /></td>
> <td style="text-align:center"><input type="checkbox"  name="idblock-1@is_control" /></td>
> <td colspan="4" ><textarea name="idblock-1@comment" wrap="soft" rows="1" cols="80" ></textarea>
>     <input type="hidden" name="@link@idblocks" value="idblock-1"/>
> </td>
></tr>
>
>This fragment defines another small table which has column headers
>like the previous fragment. This fragment is where the user enters
>new values to create a new idblock object.
>
>Both of these fragments are within the <form> / </form> block. Note
>the name attributes in the last code fragment. The idblock-1 looks
>like a field designator. But the - (dash) character isn't allowed in
>the hyperdb.splitDesignator function.

As you discovered this is the mechanism for creating new instances of
other classes (e.g. files and messages which also have the shortcuts
@note and @files).

However you have pointed out another instance where the documentation
needs to be updated/reorganized. I have added a description of
classname-number to the glossary under designator, but I am not sure
that is useful.

I wonder if the current customizing.txt needs to be split into 4 or so
documents:

  tracker configuration, schema, detectors/extensions/interfaces.py

  tracker security/access controls

  html interface - (compare with having separate rest or xmlrpc documentation)

  customizing doc with examples

Thoughts on the re-org or a better way to allow you to have found
your question (via better indexing perhaps).

--
				-- rouilj
John Rouillard
===========================================================================
My employers don't acknowledge my existence much less my opinions.