Documentation for release 10.1.0

[nallen05]

Lutz



Are you still going to support the "Manual and Reference" document distributed with newLISP? In its current format (strict HTML with or without index frame) it is probably the nicest lisp manuals I have ever seen...



Nick

[Lutz]

Yes, absolutely!



And this is true for both CodePatterns.html and newlisp_manual.html (The Users Manual and Reference).



Both can be read even with very old browsers or console text browsers (lynx). An both are easy to parse (for online help, translation etc), because they use a simple HTML tagging syntax.



I am still working on CodePatterns.html to perfect it in this respect. Probably it will be translated from the wiki back into HTML with a script, after somebody made edits. CodePatterns.html has never been edited by anybody else than me, and has some pretty horrible English in there (that's what they tell me ;-) at least ).

[cormullion]

Now that we have the wiki it should be possible to review a few sections here and there, rather than try to read the whole lot in one go. I hope everyone here lends a minute or two!



I'm hoping to get round to it soon, but time slips through my fingers like sand at the moment... :)

[tom]

just want to point out that we could use dokuwiki namespaces too, which just sort into directories.  [[manual:introduction]]  makes a file "introduction" in the directory "manual".  



You probably already knew that...

[cormullion]

Thanks Tom. I just stuck some colons in, like I was using newLISP.. :)



Do you know how to split up large documents into smaller sections? (Without doing it all by hand and getting totally lost while doing so.) It would be cool if there was a "split into sections" command.

[newdep]

Is it an Idea to add an extra "Sign" to the functions inside the manual for

an even quicker reverence on functions..



Currently the "!" is used to point on Destructive functions.



I was thinking of adding ->



"L"  returns a list



"E" returns elements



"N" retuns nil



"T" returns true

[newdep]

Hello Lutz,



I dont find the manual very clear on FOOP as it currently is,

a little chaotic explained havnig examples floating between lines..



Here is the small version on how to explain the FOOP construction,

perhpas a better addon for inside the manual?

Code Select Expand



;; A little help for the mindset on FOOP.
;;
;; The following are exactly the same,
;; This is to point out the construction of FOOP

;; FOOP from within the 'MAIN context
(new Class 'Rectangle)
(set 'myrect (Rectangle 5 5 10 20))
(define (Rectangle:area p) (mul (p 3) (p 4)))
(:area myrect)

;; FOOP from within other then the 'MAIN context
(new Class 'MAIN:Rectangle)
(set 'myrect (Rectangle 5 5 10 20))
(define (Rectangle:area p) (mul (p 3) (p 4)))
(:area myrect)

;; FOOP simplyfied ->
(define (Rectangle:Rectangle) (cons (context) (args)))
(define (Rectangle:area p) (mul (p 3) (p 4)))
(Rectangle:area (Rectangle 5 5 10 20))

;; FOOP the namespace way ->
(context 'Rectangle)
(define (Rectangle) (cons (context) (args)))
(define (area p) (mul (p 3) (p 4)))
(context 'MAIN)
(Rectangle:area (Rectangle 5 5 10 20))