RFC open on newLISP documentation

[Lutz]

and more constant 'trauma', version 7.5.12



http://newlisp.org/download/development/">http://newlisp.org/download/development/



Lutz



ps: I'll try to make this the last one today :)

[nigelbrown]

For the new syntax section can I suggest rather than



"Integers start with a + or - sign followed by a number of digits from 0 to 9. Any other character will makr the end of a number."



the text (or similar):



Integers are one or more digits, optionally preceeded by a + or - sign. Any other character will mark the end of the integer or may be part of the sequence if parsed to a float (see float syntax below).



The last sentence is because

> (parse "1E")

("1" "E")

> (parse "1E1")

("1E1")

>

[nigelbrown]

A request:

could the alphabetic access links

viz:

Functions in alphabetical order

!+-*/<>= A  B  C D E  F  G I  J  L  M  N O P  Q  R S  T  U W X

be placed into the manual so that it is on screen when the manual is first called up (in 'standard' res on 800x600 screen say).

I call up help and see the manual title splash (again) then have to start scrolling around to find the function links.

I suggest maybe placing just under

"newLISPtm

For LINUX, FreeBSD, Mac OSX, Solaris and Win32

Users Manual and Reference v.7.5.12"

and before the

"Copyright © 1991-2004 Lutz Mueller.  http://www.nuevatec.com">www.nuevatec.com. All rights reserved."

then it would be immediately visible.



Nigel

[Lutz]

The next manual will have a link to itself where it says: "Functions in groups"



You bookmark this and it will position the functions group list with the alphabetical index underneath fitting on smaller screens.



Lutz

[eddier]

I know some people HATE frames, BUT, when they are done properly ...



You could have a frame with the index at the top or the side. The docs that come with Java use this method, although you have to go through trees of information with all the classes they have. An index at the side, sure would make navigating the commands easier.



Eddie

[eddier]

Lutz, if you would like me to make the three frames, frameset, index, and body. I would be glad to do it and e-mail them to you.



Eddie

[Lutz]

If this could be done in a way where newlisp_manual.html doesn't need to change, that would be fantastic! So we would have two additional files (1) the manual_frame.html and (2) newlisp_index.html.



Thanks



Lutz

[eddier]

Done!



Eddie

[Lutz]

Beautiful, thankyou, it is online here:



http://newlisp.org/download/development/manual_frame.html">http://newlisp.org/download/development ... frame.html">http://newlisp.org/download/development/manual_frame.html



Lutz

[nigelbrown]

I like it - thanks

[Lutz]

things where misssing in the index and some other small fixes in the manual, now rev-2:



http://newlisp.org/download/development/manual_frame.html">http://newlisp.org/download/development ... frame.html">http://newlisp.org/download/development/manual_frame.html



Lutz

[eddier]

Oops! What did I leave out of the index?



Eddie

[Lutz]

No problem, it was from version 7.3.x and missed 'source' and the array section.



Lutz

[nigelbrown]

correction : index item for date is:

Time and date functions

date return the current date and time in a string



should say something like:



Time and date functions

date converts a data-value type integer to date and time in a string form

[nigelbrown]

Re documentation of cammandline -

I've noted where doit.lsp is (println "hello there") that:

C:newlisp>newlisp doit.lsp -e "(println 10)"

hello there

10

10

C:newlisp>newlisp          -e "(println 10)"  doit.lsp

10

10



That is, newlisp will do lisp files if they are before the -e directive



I'll change the man page synopsis section to reflect that.