Skip to content

Improve Docfiles format #102

Open
Open
@xrchz

Description

@xrchz

An old email from Michael to me:

The doc files are in a standard format of Tom Melham's invention. I'd like to convert them all to something like Markdown as that is richer in terms of the features that it supports. The obstacle to this is that we'd need to be able to convert to LaTeX and HTML and reasonable raw text. Markdown does the latter two (on the assumption that it is reasonable raw text in itself). The multimarkdown tool also does conversion to LaTeX.

I'd also like to be able to do all this with SML tools, but it's less important because users don't have to do the conversions, only developers. So really, all you need to do is convert the existing files to markdown. It'd be nice to retain the automatic cross-referencing for the SEEALSO sections.

My (Ramana's) only problem with Markdown is that it's not standardised - there are too many flavours and no specs.

I should add that part of the impetus here is to be able to link the Docfiles with the Wiki somehow.

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions