Work at SourceForge, help us to make it a better place! We have an immediate need for a Support Technician in our San Francisco or Denver office.

Close

#40 Documentation (was Add sections, refine features)

2.9.x
closed-fixed
7
2002-05-05
2002-04-26
Stefan Waldherr
No

make subsections in section "starting privoxy" into
the different platforms like in "installation". group
platforms if necessary.

make also subsections in section "configuration files
overview": action files, filter file.

fix the README file, where I have commented out the
contact section (the readme.sgml cannot cope with
<sec2> tags for some reason or the other.

Discussion

    • summary: Add sections --> Add sections, refine features
     
  • Logged In: YES
    user_id=74317

    I forgot:

    complete the features list to include not only new features
    but all features. prefix new features with "NEW". complete
    the list first.

     
    • assigned_to: nobody --> swa
     
  • Logged In: YES
    user_id=74317

    subsections fixed, still open:

    fix the README file, where I have commented out the
    contact section (the readme.sgml cannot cope with
    <sec2> tags for some reason or the other.

    complete the features list to include not only new features
    but all features. prefix new features with "NEW". complete
    the list first.

     
    • summary: Add sections, refine features --> Documentation (was Add sections, refine features)
    • status: open --> open-remind
     
  • Hal Burgiss
    Hal Burgiss
    2002-04-28

    Logged In: YES
    user_id=322640

    >fix the README file, where I have commented out the
    >contact section (the readme.sgml cannot cope with
    ><sec2> tags for some reason or the other.

    I believe the problem here is that you just can't start
    using section tags in the middle of an article. Docbook
    wants consistency on these things. Either the whole thing
    has to be sections (with a few exception like <artheader>
    that can come before the first section), or no sections. The
    error message is just not very informative.

    As to the features list, I'd agree now that the ties to JB
    have been cut, we need something better and not just say JB
    + these features. But I also think a comprehensive list of
    features would be tediously long.
    So I think we need middle ground on this. Maybe a summary of
    important features, and then individually highlight the
    important stuff (ie important to potential users), and maybe
    the really, new cool stuff.

    I plan on hitting faq next, as I still think we need to find
    all the blatant inaccuracies that are a result of multiple
    actions files, and the actions that have been
    recently renamed. That shouldn't be a real big job, but
    needs attention.

     
    • status: open-remind --> closed-fixed
     
  • Logged In: YES
    user_id=74317

    readme.sgml fixed. it creates a TOC though. closing.

     
  • Hal Burgiss
    Hal Burgiss
    2002-05-05

    Logged In: YES
    user_id=322640

    Do we know why those sect2's are producing wierd looking
    numbering:

    CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS

    .1. Get Support
    .2. Report bugs
    .3. Request new features
    .4. Report ads or other filter problems
    .5. Other

    That should be 5.1., etc

     
  • Hal Burgiss
    Hal Burgiss
    2002-05-05

    Logged In: YES
    user_id=322640

    OK, I found the numbering problem. Fixed in CVS. Also, I
    moved that large copyright/statement of purpose
    statement to the top of file by putting it in <abstract>.