discuss: Plain text documents
Subject:
Plain text documents
From:
David Lawyer ####@####.####
Date:
9 Feb 2016 09:34:46 +0000
Message-Id: <56B9B2EF.7060000@lafn.org>
These two quotes were fro the "History of LDP" thread
> David Lawyer wrote
> I agree but one nice feature about linuxdoc (seldom used anymore) or
> wikis is that they automatically create a table of contents. If there
> is no such table in a doc, one can as a substitute type in words to
> search the doc but a table of contents is sometimes easier to use to
> find what you are looking for (or for something of interest you were
> not looking for):.
>
> On 2/4/2016 10:46 AM, David Niklas wrote:
> Many people create their own TOC in txt docs, some of them IMHO are very
> pretty :)
>
> Sincerely, David
I don't understand. You likely mean that the created TOC's contain more
that just the section headings and numbering. But how does one get to a
topic found in the TOC? In html one just clicks on it but not for a
text doc. If the doc is very short (a screen or two) then no TOC is
needed (except for smartphones with small screens).
One proposal would be to require (or strongly suggest) a minimal markup
for text docs submitted to LDP. They would need to use 4 tags from
linuxdoc markup and separate paragraphs by blank lines. The tags:
<title>Serial-Howto
<author>David S. Lawyer
<date>Nov. 2011
<sect>Introduction
Optional would the <sect1> tag for subsections. These submissions would
be converted by a script to turn them into valid linuxdoc format with a
table of contents. It's very easy to create such a script just by using
the vim editor (in record mode). To make this valid linuxdoc: Add first
line: <!doctype linudoc system> and then enclose the rest of the article
in <article> tags. It's now valid linuxdoc. The script would also add
a <TOC> (Table of Contents). The doc would now be converted by linuxdoc
to html format, etc. So it would be not really a text documents.
The simplest idea would jest be to keep it a .txt file and not convert
it to linuxdoc. The problem with the above proposal is that it doesn't
support lists or tables
||
|
.
|
