Deleted
Deleted Member
Posts: 0
|
Search
Jul 6, 2016 18:12:56 GMT -6
Post by Deleted on Jul 6, 2016 18:12:56 GMT -6
Is it possible to include a 'search' in the editor? Small listings are ok but when they get bigger, finding stuff, can be a job and a half... No rush...
J
|
|
|
Search
Jul 6, 2016 18:38:33 GMT -6
Post by n00b on Jul 6, 2016 18:38:33 GMT -6
I am always open to implementing extra features. Right now I am working on adding the ability to pre-compile libraries so that you don't have to waste time recompiling lots of code for longer programs. I will add definitely add this to the top of my things to do though. If possible, it would help out if you have a little time every now and then to add some examples to the manual and also it would help out if you could write a few example snippets to include with future releases. I have been meaning to do all this for a while but it does take a long time to just work on the compiler, runtime, and the editor. All the documentation that it comes with was handwritten by me, but there is around 300 built-in functions plus stuff like documenting variables, arrays, functions, and so on. Any little bit helps.
|
|
Deleted
Deleted Member
Posts: 0
|
Search
Jul 7, 2016 6:40:49 GMT -6
Post by Deleted on Jul 7, 2016 6:40:49 GMT -6
Cool.
Ok. Document writing. That's something that I have not done since early sdlbasic. Not for the website, just for me. I prefer either a hard copy or PDF. I have the rcbasic pdf and have created a text file of all the commands. (converted the html documents into one text file - took many, many, many nano-seconds to do ... lol)
I have noticed that the documentation is a bit on the spartan side. I will see what I can do. Example snippets as well... hmmm... Ok. Sounds like a huge job...
How do you want the information formatted? Plain text; PDF; Doc
I will work on the single text file that I have, and if I can, I will attempt to add snippets. Time to hit the books.
J
|
|
|
Search
Jul 7, 2016 11:12:05 GMT -6
Post by n00b on Jul 7, 2016 11:12:05 GMT -6
If you can, try to keep any docs you produce in plain text that way I can easily convert it to any format. I know the documentation I have done so far is lacking but the documentation is really a separate project in itself and I really didn't devote a whole lot of time to it. My goal is ultimately to make it as accessible and easy to learn as possible. Any help is greatly appreciated.
|
|
Deleted
Deleted Member
Posts: 0
|
Search
Jul 7, 2016 16:25:28 GMT -6
Post by Deleted on Jul 7, 2016 16:25:28 GMT -6
Ok. Text it is. I am going to assume, that at some stage or another, the documentation will be a little more 'interactive'? ie: List by category or by keyword with links.
J
|
|
Deleted
Deleted Member
Posts: 0
|
Search
Jul 7, 2016 18:11:29 GMT -6
Post by Deleted on Jul 7, 2016 18:11:29 GMT -6
Update: I have counted about 280 keywords ranging from 'ABS' to 'ZONEINPUTS$'
Bring on the coffee...
J
|
|
|
Search
Jul 7, 2016 19:06:46 GMT -6
Post by n00b on Jul 7, 2016 19:06:46 GMT -6
I plan to have it organized a little bit better. As it is right now it is organized by categories. You should see all the categories in a list when you go to help->reference from the editor.
|
|
Deleted
Deleted Member
Posts: 0
|
Search
Jul 7, 2016 20:34:30 GMT -6
Post by Deleted on Jul 7, 2016 20:34:30 GMT -6
Too late. Spotted them already... lol
Creating separate text files: Keywords, Categories and References
Once I have completed the keywords (at least those that I am familiar with) I can then 'slot' them into their different categories... I hope...
I am planning a format for DOC and PDF that will be something like:
----------------------------------------
ABS
ABS ( numeric expression )
Print ABS(-67.98) 67.98
Function: Returns the absolute value of the given expression - which primarily means that negative numbers are returned as positive.
Associated keywords: SIGN
-------------------------------------
Setting the main title 'ABS' to a different font style can make it easier to create a Table of Contents for a DOC file. NB: the '----' are only there for this example.
Just a thought...
J
|
|
|
Search
Jul 8, 2016 0:08:27 GMT -6
Post by n00b on Jul 8, 2016 0:08:27 GMT -6
I actually did a pdf reference manual for RCBasic v1.0 (which was a lot more like sdlBasic than the current version). I had everything formatted a lot diffently and I think it was close to what you are talking about. I will look through my old docs and see if I can find it. It might give you a good starting point.
|
|
Deleted
Deleted Member
Posts: 0
|
Search
Jul 8, 2016 5:49:59 GMT -6
Post by Deleted on Jul 8, 2016 5:49:59 GMT -6
I may already have that one.. It's amazing what Google can find... lol
J
|
|
Deleted
Deleted Member
Posts: 0
|
Search
Jul 13, 2016 0:18:22 GMT -6
Post by Deleted on Jul 13, 2016 0:18:22 GMT -6
UPDATE:
Slowly making my way through the keywords. This is a potentially huge job... I am updating the definitions of the keywords that I am familiar with and attempting some simple examples as I go. A lot of the keywords seem to be specific for RC so the definitions for those will be the same as the manual. However the examples for those keywords will need to be updated by someone with a far better understanding of RC than myself. Come to think of it, the current text file, is looking a lot like the PDF layout except for the fancy text...
As far as the common keywords go, I am currently up to "I" (Inkey), and my coffee supply is beginning to run low... *sigh*
When I get about halfway, possibly "M" or "N", I will send you a copy. (I will try to preserve a similar format to the original PDF)
J
|
|
Deleted
Deleted Member
Posts: 0
|
Search
Jul 13, 2016 15:21:35 GMT -6
Post by Deleted on Jul 13, 2016 15:21:35 GMT -6
This will give you a chuckle... as I was working on the keywords, an idea popped in (I know. How rare is that?) to make editing easier (for me anyway...). Stopped what I was doing; Threw together the appropriate program; Ran it. Program created individual files for each keyword with a skeleton of the layout for each file. When finished, simply merge all the files, and done. Why is it that I come up with these ideas when I am almost halfway through the initial task? (rhetorical...) *sigh* Back to the list....
|
|
|
Search
Jul 13, 2016 18:52:39 GMT -6
Post by n00b on Jul 13, 2016 18:52:39 GMT -6
I haven't been able to reply because my internet is down right now. Thats awesome that you made so much progress. The program you made sounds like it could be developed into some fairly usable software. Every other documentation software takes longer to learn how to use than actually writing the docs. I am looking forward to seeing what you have done. I have actually been working a little bit on my game which still is in very early stages. I have actually been refering to the manual quite a bit because even though I wrote every function of RCBasic, I often forget what a lot of them do. I know, its pretty funny. Anyway thanks for all the hard work.
|
|