YetAnotherForum
Welcome Guest Search | Active Topics | Log In | Register

New Topic Post Reply
New online 3.0 Standard library documentation system.
neonapple
#1 Posted : Monday, September 19, 2011 2:21:58 PM(UTC)
Rank: Newbie

Groups: Registered
Joined: 9/17/2011(UTC)
Posts: 2
Location: Sweden

Thanks: 0 times
Was thanked: 2 time(s) in 1 post(s)
I have taken the Squirrel 3.0 Standard library documentation and created the following after a few hard days of work:

http://squirreldoc.neonapple.com

Some pages that show layout examples:

http://squirreldoc.neona...ing.Regexp.capture.html
http://squirreldoc.neona.../lib.string.regexp.html
http://squirreldoc.neona...3/lib.string.split.html
http://squirreldoc.neona...lib.blob.Blob.seek.html

I would like to collect examples for each method and class (as show in the regexp.capture). If anyone is willing to assist please let me know.
I am still working on collecting the version on which methods were first implemented and modified due to bugs or enhancement.

I made some corrections to typos, grammar, run-on sentences and such, but not all of it. I would like to see the parameter names be a bit more standardized such as "target" and "source" rather than "destpath" and "closure"

I will develop the search, sidebar, and the reference library next.


-Alex
2 users thanked neonapple for this useful post.
henry4k on 11/24/2011(UTC), bonch on 9/19/2012(UTC)
fagiano
#2 Posted : Monday, September 19, 2011 2:32:52 PM(UTC)
Rank: Advanced Member

Groups: Registered, Administrators
Joined: 6/11/2005(UTC)
Posts: 1,056

Thanks: 0 times
Was thanked: 78 time(s) in 60 post(s)
Hi Alex,
That's very nice. If you are interested I use docbook(XML) for the documentation sources, Ic ould pass you the XMLs, it could be easier for you to get the content out. And for the API documentation I have a simple "XML language" that I transform to docbook with XSLT.

ciao
Alberto
Follow me on Twitter @squirrellang
neonapple
#3 Posted : Monday, September 19, 2011 2:49:18 PM(UTC)
Rank: Newbie

Groups: Registered
Joined: 9/17/2011(UTC)
Posts: 2
Location: Sweden

Thanks: 0 times
Was thanked: 2 time(s) in 1 post(s)
That would be great. I currently use my own XSL styles for this method and for creating the TOC for html help. However having raw XML to extract from would be nice.

I'll work on getting it compiled down to chm.
pfalcon
#4 Posted : Tuesday, August 6, 2013 1:28:31 PM(UTC)
Rank: Advanced Member

Groups: Registered
Joined: 1/9/2013(UTC)
Posts: 59

Thanks: 1 times
Was thanked: 3 time(s) in 3 post(s)
fagiano, neonapple: Can you please consider releasing sources for the documentation as open-source, so others can contribute to it? (And then release on somewhere like github, so it actually was easy to contribute.) For example, there're lot of typos/missing punctuation in current docs as shipped in source archive, but as those are PDFs, it's unclear how to fix them.

Thanks!
Quick Reply Show Quick Reply
Users browsing this topic
Guest
New Topic Post Reply
Forum Jump  
You can post new topics in this forum.
You can reply to topics in this forum.
You can delete your posts in this forum.
You can edit your posts in this forum.
You cannot create polls in this forum.
You can vote in polls in this forum.

Clean Slate theme by Jaben Cargman (Tiny Gecko)
Powered by YAF 1.9.4 | YAF © 2003-2010, Yet Another Forum.NET
This page was generated in 0.115 seconds.