Ticket #237 (new enhancement)

Opened 10 months ago

Last modified 10 months ago

Support addition of links to Cabal project pages

Reported by: dons Assigned to: dons@galois.com
Priority: normal Milestone:
Component: hackageDB website Version: 1.2.3.0
Severity: normal Keywords:
Cc: Difficulty: normal
GHC Version: 6.8.2 Platform:

Description

Many libraries have documentation online, other than the hackage information.

We need a way to tie all the blog and online tutes to the relevant library.

Support a way for authenticated users to add links to tutorials, online docs, RSS feeds and other project specific information.

Example: ohloh's code metric site:

http://www.ohloh.net/projects/6869?p=xmonad

allows adding "Links" by registered users to the project docs, wikis etc.

Change History

02/12/08 01:29:15 changed by duncan

The project description is haddock markup so adding links is already possible. Perhaps that'd be enough if it was well known.

(follow-up: ↓ 3 ) 02/12/08 02:57:50 changed by nominolo

Hm, maybe we should split the description field into short-description and long-description or similar. Or, like in Emacs introduce the convention that the first 80 characters or the first sentence are a short description of the respective package, to be used in overview pages.

If people adds lots and lots of links to the description field, the layout of the package site on Hackage might also be less functional since some information would move down.

(in reply to: ↑ 2 ) 02/12/08 03:29:25 changed by ross@soi.city.ac.uk

The package list uses the Synopsis field (plain text), rather than Description (haddock markup).

(follow-up: ↓ 6 ) 02/12/08 05:51:31 changed by nominolo

Ok, then how about a two-column layout? The text goes on the left and the meta information on the right. This way all the important information would stay on top, and authors are free to add more information into the Description part. (At the same time we'd make the text column narrower, which is good, too.)

02/12/08 05:53:25 changed by ross@soi.city.ac.uk

I see Don wanted users to be able to add the links to a package after upload. They'd probably want to add text too, so what's required is essentially a wiki page for each package, though I'm not sure what's the best way to provide that. The hackageDB password file is in the same Apache format used by Trac, so that could be a possibility. See also #57.

(in reply to: ↑ 4 ; follow-up: ↓ 7 ) 02/12/08 05:55:07 changed by ross@soi.city.ac.uk

Replying to nominolo:

Ok, then how about a two-column layout? The text goes on the left and the meta information on the right. This way all the important information would stay on top, and authors are free to add more information into the Description part. (At the same time we'd make the text column narrower, which is good, too.)

Are you referring to the package list or the page for an individual package?

(in reply to: ↑ 6 ) 02/12/08 06:03:07 changed by nominolo

Replying to ross@soi.city.ac.uk:

Are you referring to the package list or the page for an individual package?

To the page for the individual package.