Re: Documentation Development

Charles Crayne wrote:
> On Fri, 18 Apr 2008 18:46:50 -0400
> Frank Kotler <fbkotlerverizon.net> wrote:
>> Robert Rush wrote:
>>>   I will be perusing the source documentation
and the other data
>>> that I have recently collected on NASM. Once I
have feathered the
>>> docs enough for my comfort I will construct a
prototype page as an
>>> idiom to illustrate what it is that I'm trying
to convey to you all
>>> at NASM Dev. 
> 
> I am sure that all of us on the NASM development team
would welcome
> your help in improving the documentation, as, like most
developers, we
> would rather write code than document it. However, the
current
> documentation is delivered in a variety of formats,
including plain
> ascii text, ps, html, rtf, and Windows help format, all
of which are
> automatically generated from a single master file. 
> 
> My concern is that you are proposing features that will
not work in all
> of these different formats, as (for example) writing
your prototype
> page in html, or with some tool which creates html.
> 

Yes, indeed.  That being said, there are a number of better
tools than 
what we have that can do the same job; it's just a matter of
suffering 
through the conversion process.  The one I'm most familiar
with is 
DocBook, which I believe the git people use.

	-hpa

------------------------------------------------------------
-------------
This SF.net email is sponsored by the 2008 JavaOne(SM)
Conference 
Don't miss this year's exciting event. There's still time to
save $100. 
Use priority code J8TL2D2. 
http://ad.doubleclick.net/clk;1987
57673;13503038;p?http://java.sun.com/javaone
_______________________________________________
Nasm-devel mailing list
Nasm-devellists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/nasm-devel

On Fri, 18 Apr 2008 21:27:40 -0400
"H. Peter Anvin" <hpazytor.com> wrote:

> there are a number of better tools than 
> what we have that can do the same job; it's just a
matter of
> suffering through the conversion process

Considering that we already have a tool for parsing our
current markup
language, modifying it to output XML should not be that
difficult.
However, the basic issue remains unchanged -- all changes
must be made
to the nominative format, and how those changes will affect
the
derivative formats must be carefully considered.

-- 
Chuck 
htt
p://www.pacificsites.com/~ccrayne/charles.html


------------------------------------------------------------
-------------
This SF.net email is sponsored by the 2008 JavaOne(SM)
Conference 
Don't miss this year's exciting event. There's still time to
save $100. 
Use priority code J8TL2D2. 
http://ad.doubleclick.net/clk;1987
57673;13503038;p?http://java.sun.com/javaone
_______________________________________________
Nasm-devel mailing list
Nasm-devellists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/nasm-devel