W3C home > Mailing lists > Public > public-swd-wg@w3.org > January 2007

Re: SWD issues, citable URIs for

From: Jon Phipps <jphipps@madcreek.com>
Date: Wed, 10 Jan 2007 11:07:32 -0500
Message-ID: <34b5049c0701100807i7f15ec55g30ab344ee510c242@mail.gmail.com>
To: "Thomas Baker" <baker@sub.uni-goettingen.de>
Cc: "SWD Working Group" <public-swd-wg@w3.org>

Tom,

responses inline below...

Cheers,
--Jon

On 1/10/07, Thomas Baker <baker@sub.uni-goettingen.de> wrote:
>
> Jon,
>
> It's great that in the Table of Contents of
> BestPracticeRecipesIssues [1] one can click on the issue
> "COOKBOOK-I1.1" to jump to that issue.  I see this uses
> a long URI [2].  How usable is that URI for the purposes
> of citation?

> The page source [3] implies that the URIs are being generated
> by TableOfContents (a Python script?).  Are these just
> temporary URIs - do they change when the page is edited?

That URL references an anchor/ID that isn't generated by the TOC but
is inherent in the page structure. It's stable in the sense that it's
not determined by the position of the referenced header in the page,
but it appears to be a hash of the wording of the header. So it's only
stable, and thus citable, if the header content doesn't change.

>
> If the Appendix on Issue Submission [4] were removed in favor
> of a pointer to IssuesProcess [5], there would be no special
> need in this short document for a separate Table of Contents.
>
> However, the Issues in Section 3 should ideally be clickable,
> with URIs suitable for citation purposes.  Could "1. Contents"
> and "3. Overview of issues" somehow be merged so that the
> overview of issues functions as the table of contents,
> ideally with persistent URIs for the issues?

Yes, Ralph suggested this and I unhelpfully simply didn't do it rather
than discuss the pros/cons (mostly cons). Since the header references
used in the TOC aren't generated as the page is being edited, it's a
pain to save the page, copy the auto-generated anchors for use in
links in the Issues Overview. The simple approach is to include the
TOC, which does the scanning in a second pass before page output and
put it as close as possible to the overview.

However, MoinMoin also includes an {anchor} macro [6] that allows you
to embed an anchor of your own design in the page -- the approach used
in the RDFin XHTML issues page [7]. This requires a few minor extra
steps, but is certainly do-able. It has the advantage of a stable,
permanent URL as well.

All of this would be much easier with some custom MoinMoin macros (if
someone had the time). And of course we could always use a dedicated
issue tracking tool.

I've changed the BestPracticeIssues page [1] with some changes to the
links and the TOC , which I still think is useful.

Please let me know what you think.

--Jon

[6] http://www.w3.org/2006/07/SWD/wiki/HelpOnMacros#head-3bd981f061f262d3605935dfe29519d9be970487
[7] http://www.w3.org/2006/07/SWD/wiki/RDFinXHTML_Taskforce_Issues

>
> Tom
>
> [1] http://www.w3.org/2006/07/SWD/wiki/BestPracticeRecipesIssues
> [2] http://www.w3.org/2006/07/SWD/wiki/BestPracticeRecipesIssues#head-7f03e69783008d22f1e9d3ac843f682aa53a4d5e
> [3] http://www.w3.org/2006/07/SWD/wiki/BestPracticeRecipesIssues?action=raw#preview
> [4] http://www.w3.org/2006/07/SWD/wiki/BestPracticeRecipesIssues#head-fc0ca1efc56a5e80951c16c99c9c8a0e2e406b43
> [5] http://www.w3.org/2006/07/SWD/wiki/IssuesProcess
>
>
> --
> Tom Baker - tbaker@tbaker.de - baker@sub.uni-goettingen.de
>
>
Received on Wednesday, 10 January 2007 16:07:53 GMT

This archive was generated by hypermail 2.2.0+W3C-0.50 : Tuesday, 8 January 2008 14:17:27 GMT