I'm having some trouble writing the specs.
The problem is that the page is going to be VERY long and its
hard to keep track of the hierarchical structure.
Breaking the page up into "chapters" would help but even
then each chapter is still going to be a fairly deep tree.
On the other hand, if the tree is split into many pages,
flow is lost, and a lot of links will need to be clicked
to navigate. It also make reorganisation very hard.
The current text is 1400 lines and the final text
is sure to be at least 10x more: 14 thousand lines
is a pretty big page :)
A single page has the advantage one can do a text search,
Both in the browser and the text editor I use to write it.
however flx_iscr can be used to split the source page up,
at the cost to me of having to run the dang thing to look at
what I just modified (at the moment, running the Felix webserver,
I can examine what I wrote by simply saving the text in the editor).
With either system there's a problem with cross references.
With many pages its a bit easier to specify a cross reference
link, but harder to actually name the pages. fdoc format
and webserver processing do not handle cross references
automatically at all. Manually naming pages for cross referencing
is bad too, because it leads to dangling pointers (broken links).
generally in a language, the grammar drives the organisation,
which is why the grammar comes with enough comments to
explain the non-terminal in a very cursory way.
So any thoughts on how to handle this would be great!
the current document is
src/web/ref/spec_01.flx
it is not online, you will need a built Felix and running flx_web to browse it.
--
john skaller
skal...@users.sourceforge.net
http://felix-lang.org
------------------------------------------------------------------------------
Slashdot TV.
Video for Nerds. Stuff that matters.
http://tv.slashdot.org/
_______________________________________________
Felix-language mailing list
Felix-language@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/felix-language
