[lkml]   [2009]   [Feb]   [25]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
Messages in this thread
    SubjectRe: Documentation:Update the INDEX of the documents
    On Wed, Feb 25, 2009 at 11:25:08PM +0800, Yang Hongyang wrote:
    > > If folks do find the 00-INDEX files useful, my suggestion would be to
    > > make a way of automatically extracting them from the individual files
    > > and/or directories, and then making the 00-INDEX files to be
    > > automatically generated.
    > Sounds like a good idea but How to automatically generate
    > the summaries then?

    Well, for text files (including subdirectory's 00-INDEX files) we
    could have a convention which is the first line of the file should be
    a (max 60 characters) one-line summary of the file.

    We would probably have to do something special with non-free-form-text
    files, including structured text files like Docbook files. So it's
    not quite so straightforward, but it should be doable.

    - Ted

     \ /
      Last update: 2009-02-25 16:59    [W:0.021 / U:6.216 seconds]
    ©2003-2016 Jasper Spaans. hosted at Digital OceanAdvertise on this site