On Tue, Jan 26, 2010 at 6:23 AM, Miro Kropacek <miro.kropacek@gmail.com
> wrote:
Because having a wiki is cool, being able to consult the dev docs
on good
old TOS is damn cooler. So the idea was to inject TOS.HYP into
Wikipendium,
then edit Wikipendium and still being able to generate UDO sources
(from the
updated Wikipendium content) and with this, compile (updated)
STguide HYP
files.
Very cool idea, indeed. Ideal for both worlds (atari with its hyp,
PC with
modern web browsers). I assume you know work of
Standa, http://phoenix.inf.upol.cz/~opichals/libhyp/, in this way
you can
convert also existing (but important/actual) HYPs into html.
--
Mark has something lined up for the dev-docs site using this (if I
recall correctly).
Definitly a HYP, HTML is easy (even with Cab/Links/HW), some other
output options for print purposes.
As Jo notes, the .HYP source format is very simple, and the sources in
TOS-HYP CVS are relatively simple too (UDO format?)
a specific example of linking and cross-referencing would be say
parsing Doxygen over Highwire, providing relevant links to TOS-HYP and
other ref material. An example using HYP format would be a HW dev
manual with associated dev HYP's that mostly are not available yet
(www, html, w3c, js engines, dom, etc)
As a result of this, I was hoping to produce some sort of cross-docs
search engine that can be used locally, even if all the docs are not
currently available, something that could easily be update via online,
but also contains "related searches"
There is a lot of info available already, with TOS-HYP being the
current center, but it needs going over again, and fleshing out in
some places, and I would like to see some other languages to, besides
English and German, even if the HTML version is just english.
I am about to test Doxygens skills on HighWire, just to see what it
can do (or fail miserably at). If it goes well, then I will use it as
an example of linking and cross-reference for development purposes
After that I will look at a higher level than source, which would be
more practical in relation to non-source documentation, however some
way to list code examples (or link to them) would be useful for
reverse referencing out of TOS-HYP and other documentation or
discussions.
I seem to have chosen HighWire as my test case atm, but I would
consider XaAES my next choice (after the current round changes have
finished), specifically because if directly affects AES & VDI
programming, and practical examples of ideas on its use.
The overall achievement of this system would be to allow a non-atari
dev to get up and running straight away, and never more than one click
away from the "required docs", even if that means downloading them
Obviously the examples I used here imply a HighWire-DevKit.. and that
contains more than just docs & reference material or links.. The idea
being that one person or one site can be set up with everything, or
you can have a piece locally, and either browse online or dynamically
download any new docs, never having to worry about there format or how
to read them.
So any way of accessing either udo source or hyp source to and from
wiki would be a "must have" even if there is only seen limited use in
the begining. This should not be a problem in general, but may require
some "added value" to wiki in the future. We will see...
Cheers
Paul
PS Brandon, I like that you have already started something, I will
take some time to go through it..