Support "Descript.ion" files in Browse Source

[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.

[Christian Boos]

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.

[Christian Boos]

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).

[osimons]

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

[Christian Boos]

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.

[trac@…]

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.

[osimons]

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

[anonymous]

Or/and:

• 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?

[Ryan J Ollos]

Some related requests in #2702.

[Ryan J Ollos]

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

[Ryan J Ollos]

Milestone renamed