Hi all,

this may be a question for the dev group, but thought I would field it
here first, since it has both a "approach" and implementation part.
Sorry for the Length of this post.

I want to link to requirements in the wiki, I see a few ways to do
this:

put the requirements in source control, as text, and #include them in
a wiki "requirements" page named for the document.  I can then
references the requirement in the docuement, and link to the page.
The disadvantage of this is, I can't link directly to the requirement
itself, unless:
  if it is text based, I could technically link to a specific line #,
or even a range, and highlight it.  The flaw with this of course, is
if anyone inserts, or deletes a line, it breaks.  This would be
awesome of someone has a way to manage this issue.  I bet there would
be a way to script the file on commit, and update the wiki globally
with a batch replace, just not sure on the reliability.

Next option I thought of, and I don't know about feasibility, or if
it's just a bad idea.  if I exported my requirements, and imported
them into the trac database, I could use a query link, and query on
the field(s) that is unique to the requirement.  This would
essentially link to a query that always returns exactly one result.
but then I need to figure out how to actually display the requirement/
text, in theory could have a link to an image, or of course, links to
other requirements, or trac items...etc. as well as the text.  plus I
really want the whole document, just focused on the requirement
itself.

Another option, just export each requirement to it's own text file,
named by requirement ID.  put all requirements for a single
requirement "document" in a directory named for the requirement
document:
/trunk/docs/requirements/gui_requirements/1.txt, 2.txt, 3.txt...N.txt
etc.  They could have reference to the other documents as needed:
  say, in 2.txt:
 "to align with the requirement in /trunk/docs/requirements/
system_requirements/[EMAIL PROTECTED] we shall...."  should show up as a link
in trac, I think, unless I need to preface it with src: which would be
ok too I guess

Finally, I was thinking, my requirements documents could be text
based, I could use some magic post commit script on subversion to
update the file properties to have the line Starting line # for each
requirement, and dynamically build the line# link mentioned up in the
first option.  most likely actually generating a "TOC" type page, with
the line# links that is actually displayed for each requirement
document.  so, the <insert wiki page/ticket/report/etc. here> would
just link to the "requirement" document, and reference the identifier
by NAME, then the TOC page gets shown, user clicks on the requirement
by NAME, and ends up in the correct line #, even if that number
changes.

I think I just answered my own question, but would love some feedback
on this, especially if anyone has done anything like it.

Thanks.
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups "Trac 
Users" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at 
http://groups.google.com/group/trac-users?hl=en
-~----------~----~----~----~------~----~------~--~---

Reply via email to