Edgewall Software

Opened 17 years ago

Last modified 3 years ago

#3098 new enhancement

Support "Descript.ion" files in Browse Source — at Version 8

Reported by: trac@… Owned by: Christian Boos
Priority: high Milestone: next-major-releases
Component: version control/browser Version: 0.9.5
Severity: normal Keywords: description
Cc: trac@…, osimons, Ryan J Ollos Branch:
Release Notes:
API Changes:
Internal Changes:

Description (last modified by trac@…)

As the summary says…

Right now we hand edit a Wiki page describing each subdir and file.

The descript.ion metadata file is a quasi-standard by JP-Soft (4DOS) that Browser might be able to support showing a short description of each file.

Change History (8)

comment:1 by Christian Boos, 16 years ago

Keywords: description added
Milestone: 0.12
Owner: changed from Jonas Borgström to Christian Boos
Priority: lownormal

Even better, there could be a setting like:

[browser]
description_top = README.first,.title
description_bottom = .trac,descript.ion,README.trac,README.html,README.txt,README

which could be used to pick one entry among the folder entries which will be previewed in the browser folder list, on top or after the entries list itself.

The preview would be done the standard way, so it would be possible to use wiki formatting either by setting the svn:mime-type property on a README file (if using svn), or by using mime-type associations in mime_map (e.g. text/x-trac-wiki:trac).

Using an ordered list is useful so that you can eventually add a special file (.trac as in the above) to prevent some existing README file to be shown, when this is not desirable.

comment:2 by anonymous, 16 years ago

Cc: trac@… added

comment:3 by Christian Boos, 12 years ago

Priority: normalhigh

Or simpler:

[browser]
readme = README, descript.ion, ...

Show at the top a one-liner of the README, with a link to the full content at the bottom (i.e. GitHub's way).

comment:4 by osimons, 10 years ago

Cc: osimons added

FYI: My th:ReposReadMePlugin implements much of what is requested here. See the plugin docs and the examples I link to from there.

in reply to:  4 comment:5 by Christian Boos, 10 years ago

Replying to osimons:

FYI: My th:ReposReadMePlugin implements much of what is requested here. See the plugin docs and the examples I link to from there.

tracopt.versioncontrol.readme? With the likes of GitHub, BitBucket and co supporting this out of the box, I think it's appropriate to have this feature at least in tracopt.

comment:6 by Ryan J Ollos <ryano@…>, 10 years ago

Cc: ryano@… added

comment:7 by trac@…, 10 years ago

All the comments so far concern a header or a footer. The descript.ion file is a line-by-line description of each individual file in a directory.

I was the OP five years ago, but cannot edit the ticket description to point to the file layout specs that I just found.

comment:8 by trac@…, 10 years ago

Description: modified (diff)
Note: See TracTickets for help on using tickets.