Edgewall Software

Opened 17 years ago

Last modified 3 years ago

#3098 new enhancement

Support "Descript.ion" files in Browse Source

Reported by: trac@… Owned by:
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.

Attachments (0)

Change History (17)

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:

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:

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, 11 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, 11 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@…>, 11 years ago

Cc: ryano@… added

comment:7 by trac@…, 11 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@…, 11 years ago

Description: modified (diff)

comment:9 by osimons, 11 years ago

So this really boils down to 2 separate technical needs:

  1. A way of rendering directory files following a certain naming scheme (like readme*, descript.ion) much like th:ReposReadMePlugin
  2. A content renderer for the .ion file type that can parse and render the file description information contained within

comment:10 by anonymous, 11 years ago


  • A IPropertyRenderer. But then the version control backend would have to be extended to parse and attach the file description information as properties first. Maybe a new extension point IPropertyProvider is needed?
  • A nice way to present this information would be to add an additional column Description to the directory listing table (dirlist_thead.html / dir_entries.html). Maybe a new extension point IBrowserColumnProvider is needed?

comment:12 by Ryan J Ollos, 9 years ago

Cc: Ryan J Ollos added; ryano@… removed

comment:13 by Ryan J Ollos, 8 years ago

Some related requests in #2702.

comment:14 by Ryan J Ollos, 8 years ago

Milestone: next-major-releasesnext-dev-1.1.x

comment:15 by Ryan J Ollos, 8 years ago

Owner: Christian Boos removed

comment:16 by Ryan J Ollos, 7 years ago

Milestone: next-dev-1.1.xnext-dev-1.3.x

Narrowing focus for milestone:1.2. Please move ticket to milestone:1.2 if you intend to fix it.

comment:17 by Ryan J Ollos, 3 years ago

Milestone: next-dev-1.3.xnext-dev-1.5.x

Milestone renamed

comment:18 by Ryan J Ollos, 3 years ago

Milestone: next-dev-1.5.xnext-major-releases

Modify Ticket

Change Properties
Set your email in Preferences
as new The ticket will remain with no owner.
The ticket will be disowned.
as The resolution will be set. Next status will be 'closed'.
The owner will be changed from (none) to anonymous. Next status will be 'assigned'.

Add Comment

E-mail address and name can be saved in the Preferences .
Note: See TracTickets for help on using tickets.