Re: Documentation again
Hi Christophe, Let me explain my goal: I just want to have access at the reference as fast as possible. I realised that I quite always: 1) type «so» in the URL field of my browser, 2) then a familiar URL beginning with «http://software-lab.de/doc/ref» appears, 3) I edit this URL with the initial X and the function xxx to have refX.html#xxx, 4) ENTER key, 5) profit. A process that could have less steps. I thought having one big page would be convenient, for use with the search function of my browser. I think you'll know the function http://software-lab.de/doc/refD.html#doc I mostly use it directly from a shell window, with a script 'doc' in my executable path #!/usr/bin/pil @lib/debug.l (raw T) (doc (opt) (opt)) (bye) It is called as $ doc mapcar and directly opens the right browser window. I have 'w3m' as my default browser, so this is blindingly fast, but any other browser works just as well. If e.g. Firefox is already open, it connects to it and just opens a new tab. ♪♫ Alex -- UNSUBSCRIBE: mailto:picolisp@software-lab.de?subject=Unsubscribe
Re: Documentation again
Alexander Burger a...@software-lab.de writes: I think you'll know the function http://software-lab.de/doc/refD.html#doc I mostly use it directly from a shell window, with a script 'doc' in my executable path #!/usr/bin/pil @lib/debug.l (raw T) (doc (opt) (opt)) (bye) It is called as $ doc mapcar and directly opens the right browser window. I have 'w3m' as my default browser, so this is blindingly fast, but any other browser works just as well. If e.g. Firefox is already open, it connects to it and just opens a new tab. In case you are an Emacs user, you can reuse your muscle memory, since in eled.l (the emacs version of the pil line editor) I reused some well-known C-h bindings from Emacs: , | Help/Info/Debugging | | | action| keys | | |---+---| | | debug | C-h d | | | unbug | C-u C-h d | | | file info | C-h i | | | symbol doc| C-h f | | | show symbol | C-h s | | | pretty print (pp) | C-h p p | | | pretty print (pretty) | C-h p r | ` (see http://picolisp.com/wiki/?emacsStyleLed for the complete keybinding reference) Thus calling 'doc' on function/symbol FOO is just 'C-h f FOO RET', and thats already hardcoded in every Emacs user's brain I would guess. -- cheers, Thorsten -- UNSUBSCRIBE: mailto:picolisp@software-lab.de?subject=Unsubscribe
Organize TPMA: The PicoLisp Mail Archive :: Re: Documentation again
1. Orgmode format can be the base format for documentation sources. Even vim has support for .org files. 2. Faced with slow internet, difficulty to get pandoc installed on Porteus Linux. I have converted the two books on picoLisp, by hand to .org (opened in pdf viewer, select all, copy, paste into emacs Org buffer and then editing). 3. Mail archive book will be even more labor intensive if the repeated portions are not cleaned through a script beforehand. But I am not so expert to write such script.
Re: Documentation again
Hi Jolitz Nice to see Emacs expert enthusiasm here! Will definitely give a try to helm. Thanks. Sure! Please send the files as PM attachment at alab...@yahoo.com Will send then back in Orgmode format. Alabhya
Re: Documentation again
Alabhya you might want to check out this: http://www.prodevtips.com/2013/10/18/emacs-as-a-multi-mode-web-dev-ide-is-now-possible/ The Projectile and Ido combination is great for finding files, directories and grepping your files. On Wed, Aug 13, 2014 at 7:55 PM, Alabhya Singh alab...@yahoo.com wrote: Hi Jolitz Nice to see Emacs expert enthusiasm here! Will definitely give a try to helm. Thanks. Sure! Please send the files as PM attachment at alab...@yahoo.com Will send then back in Orgmode format. Alabhya -- * From: * Thorsten Jolitz tjol...@gmail.com; * To: * picolisp@software-lab.de; * Subject: * Re: Documentation again * Sent: * Tue, Aug 12, 2014 1:22:08 PM Alabhya Singh alab...@yahoo.com writes: Thanks a lot! Thorsten Jolitz for detailed informative help. As an Org-mode fan I would really like to have these docs in Org-mode, would make everything easier, but then you need to prepare the export to LaTeX such that the outcome looks as professional as the Springer LaTeX templates I used for the books. Its possible, but likely not easy and time consuming. I do have both books as .txt files (as the only two files in a directory) on my machine, for searching them in parrallel with ,[ C-h f helm-do-grep RET ] | helm-do-grep is an interactive autoloaded Lisp function in | `helm-grep.el'. | | It is bound to C-x c M-g s, menu-bar tools Helm Tools Grep. | | (helm-do-grep) | | Preconfigured helm for grep. | Contrarily to Emacs `grep', no default directory is given, but | the full path of candidates in ONLY. | That allow to grep different files not only in `default-directory' but anywhere | by marking them (C-SPACE). If one or more directory is selected | grep will search in all files of these directories. | You can also use wildcard in the base name of candidate. | If a prefix arg is given use the -r option of grep (recurse). | The prefix arg can be passed before or after start file selection. | See also `helm-do-grep-1'. ` Its very convenient to be able to simply copy found code/text from an Emacs buffer then. Don't remember how I converted the docs, but I could send them as PM attachment if you send me a private email address. -- From: Thorsten Jolitz tjol...@gmail.com; To: picolisp@software-lab.de; Subject: Re: Documentation again Sent: Tue, Aug 12, 2014 9:33:36 AM Alabhya Singh alab...@yahoo.com writes: I support Henrik and even would request the docs to be available in universal and simple formats: 1. Text The .tex sources are just text files, with LaTeX markup though. But there are tools like , | pandoc | latex2html | latex2rtf | tex2man | [...] ` to convert them. 2. Orgmode pandoc does latex-org 3. HTML try latex2html or pandoc again? latex to html should be pretty advanced there or export to org, improve the org file (easy) and the export to html These converters are all less than perfect, but they might give you valid docs in other formats, that can then be improved with a really good editor like Emacs or Vim (or with a PicoLisp program of course). - - From: Henrik Sarvell hsarv...@gmail.com; To: picolisp@software-labde; Subject: Re: Documentation again Sent: Tue, Aug 12, 2014 5:16:39 AM I noted that it's not possible to download PDFs at all from Scribd anymore without paying $9. What about making them downloadable from picolisp.com? On Tue, Aug 12, 2014 at 1:57 AM, Thorsten Jolitz tjol...@gmail.com wrote: Christophe Gragnic christophegrag...@gmail.com writes: Le 7 août 2014 14:11, Jon Kleiser jon.klei...@fsat.no a écrit : I use the frame-based solution for doc lookup (index.html by me), here http://www.software-lab.de/doc/, I realised only a few months ago that these pages were Jon's work (or in part?). Thanks for this. I'd be curious to have an historical point of view concerning the doc. Now a question then a suggestion. Is there a good reason to have separate pages? I understand that only one page would be huge but I'd find it more convenient. Would it be interesting to have the ref in a format like Markdown and generate a single or several pages, in html or pdf? BTW I just noticed in the doc for (usec) that there was a typo and that I don't find it very clear: http://software-lab.de/doc/refU.html#usec Are you aware of http://www.scribd.com/doc/103732688/PicoLisp-Works https://github.com/tj64/picolisp-works http://www.scribd.com/doc/103733857/PicoLisp-by-Example https://github.com/tj64/picolisp
Re: Documentation again
Thorsten Jolitz tjol...@gmail.com writes: Another very valuable contribution would be to create a third book , | The PicoLisp Mail Archive ` with all substantial posts/threads to the PicoLisp mailing list. Alex has a complete archive of these posts that has a pretty consistent format and thus could easily be converted to LaTeX with a script. But in the end human intelligence (and time and effort) is needed to filter out those posts/threads that are worth publishing (there are lots of them), remove text duplication etc. The book could be created using PicoLisp by Example as a LaTeX template. I'm sure Alex and the community would appreciate contributions (I would). Indeed, he mail archive is full of useful information. I usually use the online version at gmane: http://dir.gmane.org/gmane.lisp.picolisp.general There you can search the mailing archive quite comfortable. Together with the official reference, the books and Henriks Blog it answers most common questions for me. Some more explaining documentation would surely be meaningful. I plan to create some tutorials and the like from my experiences learning picolisp. But this is not something coming soon, more like 'maybe next year'... -- UNSUBSCRIBE: mailto:picolisp@software-lab.de?subject=Unsubscribe
Re: Documentation again
I support Henrik and even would request the docs to be available in universal and simple formats: 1. Text 2. Orgmode 3. HTML
Re: Documentation again
Hi Alabahya, they mostly are available in HTML on picolisp.com itself or linked to from picolisp.com. My thinking is more for offline viewing. On Tue, Aug 12, 2014 at 1:02 PM, Alabhya Singh alab...@yahoo.com wrote: I support Henrik and even would request the docs to be available in universal and simple formats: 1. Text 2. Orgmode 3. HTML -- * From: * Henrik Sarvell hsarv...@gmail.com; * To: * picolisp@software-lab.de; * Subject: * Re: Documentation again * Sent: * Tue, Aug 12, 2014 5:16:39 AM I noted that it's not possible to download PDFs at all from Scribd anymore without paying $9. What about making them downloadable from picolisp.com? On Tue, Aug 12, 2014 at 1:57 AM, Thorsten Jolitz tjol...@gmail.com wrote: Christophe Gragnic christophegrag...@gmail.com writes: Le 7 août 2014 14:11, Jon Kleiser jon.klei...@fsat.no a écrit : I use the frame-based solution for doc lookup (index.html by me), here http://www.software-lab.de/doc/, I realised only a few months ago that these pages were Jon's work (or in part?). Thanks for this. I'd be curious to have an historical point of view concerning the doc. Now a question then a suggestion. Is there a good reason to have separate pages? I understand that only one page would be huge but I'd find it more convenient. Would it be interesting to have the ref in a format like Markdown and generate a single or several pages, in html or pdf? BTW I just noticed in the doc for (usec) that there was a typo and that I don't find it very clear: http://software-lab.de/doc/refU.html#usec Are you aware of http://www.scribd.com/doc/103732688/PicoLisp-Works https://github.com/tj64/picolisp-works http://www.scribd.com/doc/103733857/PicoLisp-by-Example https://github.com/tj64/picolisp-by-example ? -- cheers, Thorsten -- UNSUBSCRIBE: mailto:picolisp@software-lab.de?subject=Unsubscribe -- UNSUBSCRIBE: mailto:picolisp@software-labde?subject=Unsubscribe
Re: Documentation again
Henrik Sarvell hsarv...@gmail.com writes: I noted that it's not possible to download PDFs at all from Scribd anymore without paying $9. What about making them downloadable from picolisp.com? On Tue, Aug 12, 2014 at 1:57 AM, Thorsten Jolitz tjol...@gmail.com wrote: Are you aware of http://www.scribd.com/doc/103732688/PicoLisp-Works https://github.com/tj64/picolisp-works http://www.scribd.com/doc/103733857/PicoLisp-by-Example https://github.com/tj64/picolisp-by-example or to http://ondoc.logand.com which is itself written in PicoLisp:-) Cheers, Tomas -- UNSUBSCRIBE: mailto:picolisp@software-lab.de?subject=Unsubscribe
Re: Documentation again
Henrik Sarvell hsarv...@gmail.com writes: Hi Henrik, I noted that it's not possible to download PDFs at all from Scribd anymore without paying $9. Yes, as always they just '(ab)use' the people to make money out of other peoples time and effort ;( But I thought if you open a (free) account you can still download the pdf? OTOH, for a while the docs were really unusable on scribd because they improved their UI, but now it seems much better again and pretty fast. But anyway - the pdfs are on Github too (!), and the two PDF download links on this page (http://picolisp.com/wiki/?Documentation) point to the (raw) PDF files on Github, not on Scribd. So anyone should be able to still download the pdfs for free. Or even better, just fork/clone the git repos and you have the sources and the pdfs. What about making them downloadable from picolisp.com? They are, see above. On Tue, Aug 12, 2014 at 1:57 AM, Thorsten Jolitz tjol...@gmail.com wrote: Christophe Gragnic christophegrag...@gmail.com writes: Le 7 août 2014 14:11, Jon Kleiser jon.klei...@fsat.no a écrit : I use the frame-based solution for doc lookup (index.html by me), here http://www.software-lab.de/doc/, I realised only a few months ago that these pages were Jon's work (or in part?). Thanks for this. I'd be curious to have an historical point of view concerning the doc. Now a question then a suggestion. Is there a good reason to have separate pages? I understand that only one page would be huge but I'd find it more convenient. Would it be interesting to have the ref in a format like Markdown and generate a single or several pages, in html or pdf? BTW I just noticed in the doc for (usec) that there was a typo and that I don't find it very clear: http://software-lab.de/doc/refU.html#usec Are you aware of http://www.scribd.com/doc/103732688/PicoLisp-Works https://github.com/tj64/picolisp-works http://www.scribd.com/doc/103733857/PicoLisp-by-Example https://github.com/tj64/picolisp-by-example ? -- cheers, Thorsten -- UNSUBSCRIBE: mailto:picolisp@software-lab.de?subject=Unsubscribe -- cheers, Thorsten -- UNSUBSCRIBE: mailto:picolisp@software-lab.de?subject=Unsubscribe
Re: Documentation again
Alabhya Singh alab...@yahoo.com writes: I support Henrik and even would request the docs to be available in universal and simple formats: 1. Text The .tex sources are just text files, with LaTeX markup though. But there are tools like , | pandoc | latex2html | latex2rtf | tex2man | [...] ` to convert them. 2. Orgmode pandoc does latex-org 3. HTML try latex2html or pandoc again? latex to html should be pretty advanced there. or export to org, improve the org file (easy) and the export to html These converters are all less than perfect, but they might give you valid docs in other formats, that can then be improved with a really good editor like Emacs or Vim (or with a PicoLisp program of course). -- From: Henrik Sarvell hsarv...@gmail.com; To: picolisp@software-lab.de; Subject: Re: Documentation again Sent: Tue, Aug 12, 2014 5:16:39 AM I noted that it's not possible to download PDFs at all from Scribd anymore without paying $9. What about making them downloadable from picolisp.com? On Tue, Aug 12, 2014 at 1:57 AM, Thorsten Jolitz tjol...@gmail.com wrote: Christophe Gragnic christophegrag...@gmail.com writes: Le 7 août 2014 14:11, Jon Kleiser jon.klei...@fsat.no a écrit : I use the frame-based solution for doc lookup (index.html by me), here http://www.software-lab.de/doc/, I realised only a few months ago that these pages were Jon's work (or in part?). Thanks for this. I'd be curious to have an historical point of view concerning the doc. Now a question then a suggestion. Is there a good reason to have separate pages? I understand that only one page would be huge but I'd find it more convenient. Would it be interesting to have the ref in a format like Markdown and generate a single or several pages, in html or pdf? BTW I just noticed in the doc for (usec) that there was a typo and that I don't find it very clear: http://software-lab.de/doc/refU.html#usec Are you aware of http://www.scribd.com/doc/103732688/PicoLisp-Works https://github.com/tj64/picolisp-works http://www.scribd.com/doc/103733857/PicoLisp-by-Example https://github.com/tj64/picolisp-by-example ? -- cheers, Thorsten -- UNSUBSCRIBE
Re: Documentation again
Tomas Hlavaty t...@logand.com writes: Hi Tomas, or to http://ondoc.logand.com which is itself written in PicoLisp:-) Cool! But with https://github.com/tj64/picolisp-works/blob/master/editor.pdf?raw=true I get an error: , | Location: http://ondoc.logand.com/d/4741/1/ | Reading PDF failed ` -- cheers, Thorsten -- UNSUBSCRIBE: mailto:picolisp@software-lab.de?subject=Unsubscribe
Re: Documentation again
Thanks a lot! Thorsten Jolitz for detailed informative help. Alabhya
Re: Documentation again
Alabhya Singh alab...@yahoo.com writes: Thanks a lot! Thorsten Jolitz for detailed informative help. As an Org-mode fan I would really like to have these docs in Org-mode, would make everything easier, but then you need to prepare the export to LaTeX such that the outcome looks as professional as the Springer LaTeX templates I used for the books. Its possible, but likely not easy and time consuming. I do have both books as .txt files (as the only two files in a directory) on my machine, for searching them in parrallel with ,[ C-h f helm-do-grep RET ] | helm-do-grep is an interactive autoloaded Lisp function in | `helm-grep.el'. | | It is bound to C-x c M-g s, menu-bar tools Helm Tools Grep. | | (helm-do-grep) | | Preconfigured helm for grep. | Contrarily to Emacs `grep', no default directory is given, but | the full path of candidates in ONLY. | That allow to grep different files not only in `default-directory' but anywhere | by marking them (C-SPACE). If one or more directory is selected | grep will search in all files of these directories. | You can also use wildcard in the base name of candidate. | If a prefix arg is given use the -r option of grep (recurse). | The prefix arg can be passed before or after start file selection. | See also `helm-do-grep-1'. ` Its very convenient to be able to simply copy found code/text from an Emacs buffer then. Don't remember how I converted the docs, but I could send them as PM attachment if you send me a private email address. -- From: Thorsten Jolitz tjol...@gmail.com; To: picolisp@software-lab.de; Subject: Re: Documentation again Sent: Tue, Aug 12, 2014 9:33:36 AM Alabhya Singh alab...@yahoo.com writes: I support Henrik and even would request the docs to be available in universal and simple formats: 1. Text The .tex sources are just text files, with LaTeX markup though. But there are tools like , | pandoc | latex2html | latex2rtf | tex2man | [...] ` to convert them. 2. Orgmode pandoc does latex-org 3. HTML try latex2html or pandoc again? latex to html should be pretty advanced there. or export to org, improve the org file (easy) and the export to html These converters are all less than perfect, but they might give you valid docs in other formats, that can then be improved with a really good editor like Emacs or Vim (or with a PicoLisp program of course). - - From: Henrik Sarvell hsarv...@gmail.com; To: picolisp@software-lab.de; Subject: Re: Documentation again Sent: Tue, Aug 12, 2014 5:16:39 AM I noted
Re: Documentation again
Thorsten Jolitz tjol...@gmail.com writes: Alabhya Singh alab...@yahoo.com writes: Thanks a lot! Thorsten Jolitz for detailed informative help. As an Org-mode fan I would really like to have these docs in Org-mode, would make everything easier, but then you need to prepare the export to LaTeX such that the outcome looks as professional as the Springer LaTeX templates I used for the books. Its possible, but likely not easy and time consuming. BTW, while it would be definitely useful to convert these docs to more formats, it would be even more useful (and probably much easier) to update them to include all new docs from the wiki and other sources since their release. They do already exist as PDF (github), can be browsed on the web (scribd) and can easily be converted to .txt with GNU/Linux tools, thats something. Org-mode would be great, but optional I would say. If you want to help improving the PicoLisp documentation with updating the books, let me know, I can give you some scripts and pointers that could be useful. Another very valuable contribution would be to create a third book , | The PicoLisp Mail Archive ` with all substantial posts/threads to the PicoLisp mailing list. Alex has a complete archive of these posts that has a pretty consistent format and thus could easily be converted to LaTeX with a script. But in the end human intelligence (and time and effort) is needed to filter out those posts/threads that are worth publishing (there are lots of them), remove text duplication etc. The book could be created using PicoLisp by Example as a LaTeX template. I'm sure Alex and the community would appreciate contributions (I would). -- cheers, Thorsten -- UNSUBSCRIBE: mailto:picolisp@software-lab.de?subject=Unsubscribe
Re: Documentation again
I noted that it's not possible to download PDFs at all from Scribd anymore without paying $9. What about making them downloadable from picolisp.com? On Tue, Aug 12, 2014 at 1:57 AM, Thorsten Jolitz tjol...@gmail.com wrote: Christophe Gragnic christophegrag...@gmail.com writes: Le 7 août 2014 14:11, Jon Kleiser jon.klei...@fsat.no a écrit : I use the frame-based solution for doc lookup (index.html by me), here http://www.software-lab.de/doc/, I realised only a few months ago that these pages were Jon's work (or in part?). Thanks for this. I'd be curious to have an historical point of view concerning the doc. Now a question then a suggestion. Is there a good reason to have separate pages? I understand that only one page would be huge but I'd find it more convenient. Would it be interesting to have the ref in a format like Markdown and generate a single or several pages, in html or pdf? BTW I just noticed in the doc for (usec) that there was a typo and that I don't find it very clear: http://software-lab.de/doc/refU.html#usec Are you aware of http://www.scribd.com/doc/103732688/PicoLisp-Works https://github.com/tj64/picolisp-works http://www.scribd.com/doc/103733857/PicoLisp-by-Example https://github.com/tj64/picolisp-by-example ? -- cheers, Thorsten -- UNSUBSCRIBE: mailto:picolisp@software-lab.de?subject=Unsubscribe -- UNSUBSCRIBE: mailto:picolisp@software-lab.de?subject=Unsubscribe
