|
|
Post by n00b on Apr 22, 2019 8:33:51 GMT -6
Hey Guys,
We got a new banner and new logo but there are a few more things I could use some help with leading up to the new release. Look below and see if there is anything you would be willing to help with.
*Demos - Basically well commented demos showing off some cool effects or programming concepts
*Documentation - I have every function documented but most are not documented well. If you think there is something in the docs that could be improved and want to improve it, just send me the modified html file. Try to keep the same format I have for consistency.
*Bug Reporting - With the latest release, I made a lot of changes that could have effected GetPixel, FloodFill, ImageFromBuffer, ImageFromBuffer_Ex, and all the mouse functions. I have been working on most of the graphics routines for about 5 years now so I am fairly confident that they are stable but I am human.
*Credits - If you submitted anything, let me know how you want to be credited in the readme.
Final Note: I have other projects I want to work on so the next release will probably be the last release for the year unless there is a major bug with no work arounds.
|
|
|
|
Post by johnno56 on Apr 22, 2019 15:33:17 GMT -6
Personally, I think the documentation, is going to be your 'biggest' part of the project. SDLBasic's 'help' is ok but has a lot of examples missing... On the other hand, QB64 has a 'huge' help function and is pretty much complete.
As you are more than likely aware, the documentation or help system, is one of the most used areas of a language especially for we noobies...
There is probably quite a lot I do not as yet understand about RCBasic, but I also feel that 'this' part of the project is important, so I put my hand up to volunteer... but it would be better if 'my' hand was not the 'only' one... lol
I would imagine that 'time frames' on documentation is kind of 'open ended' as it's always being modified or update as new features or changes are made to RC.
What do I need to begin?
J
|
|
|
|
Post by n00b on Apr 22, 2019 16:30:50 GMT -6
Hey johnn0, thanks for volunteering. If you go into the docs folder and go into the rc_basic_doc folder there is a lot of html files. The file names should be "rc_basic_<function name>". It is very simple html.
Here is how to get the syntax highlighting for code examples:
Lets pretend we are documenting this function:
function hello( s$, n)
In html you would reference the spans from the style.css file like this:
<span class = "code">
<span class="keyword"> hello </span> ( <span class="string">"world"</span>, <span class="number">5</span>)
</span>
In the above example I applied the keyword span to hello, the string span to "world", and the number span to 5. I surrounded all of it in the code span which will apply a mono space font to it.
The rest of the documentation can be done with break tags inside the paragraph tag. Look at the rc_basic_arrays.html file for some good examples. Its the only file that follows this format currently but eventually I would like to try to get all of them to that point. But there are a lot of them ( over 300 files in total), so I don't reasonably think that is going to happen anytime soon. But whatever you can do I do appreciate it.
|
|
|
|
Post by johnno56 on Apr 22, 2019 17:31:43 GMT -6
Ok. My HTML is rusty, but I'll give it a bash. What I will do, is to make a copy to work on, then if it looks ok I'll bounce it back to you for approval....
Over 300 files you say? "How do you eat an Elephant?" would apply here... lol
|
|
|
|
Post by johnno56 on Apr 22, 2019 17:36:49 GMT -6
I just checked... 382 html files... Oh my aching fingers... lol
|
|
|
|
Post by tbird on Apr 22, 2019 18:46:27 GMT -6
I will throw my hat in the ring also, I will help where I can, have never done html but now is as good a time as any. I also have a few little ideas for some demos.
|
|
|
|
Post by n00b on Apr 22, 2019 19:35:29 GMT -6
Any help is appreciated. Whenever you start working on a file could you post it here so no one is working on the same file.
As far as demos, please try to add some comments so new users can learn from your code. Also make sure to credit yourself in a comment section at the top.
I am planning on going back and improving some of the current demos as well.
|
|
|
|
Post by johnno56 on Apr 22, 2019 22:41:39 GMT -6
Are you wanting some sample code to go with commands that just have the description? Mind you, there may be some commands that I may not have any idea about... lol
I am of two minds as to how to tackle this... Alphabetically or by Category. Category meaning, updating each topic in order that appears on the main help page.
Oh. Just a quick note. The help files in version 308 seem to be in a different location to version 307.
307 = rcbasic_linux_307/rcbasic64/doc/rcbasic_doc
308 = rcbasic_linux_308/doc/rc_basic_doc
I am going to assume that everyone should be using version 308.
|
|
|
|
Post by tbird on Apr 22, 2019 23:51:14 GMT -6
I will post what I start on...but to simplify I will go reverse alphabetically by category....if that makes sense  |
|
|
|
Post by johnno56 on Apr 23, 2019 3:12:36 GMT -6
Makes sense to me.... |
|
|
|
Post by johnno56 on Apr 23, 2019 3:46:12 GMT -6
The first reference to Getting Started: RCBASIC is ready. Before overwriting your existing doc folder, I would strongly suggest that, you make a copy... just in case... gettingStarted_rcbasic.zip (139.8 KB) Note: The rc_basic_man.html file has been slightly modified. It originally 'pointed' to the "IO" html file. This now points to the title_links html. (RCBASIC menu link) Also included is the new logo png. Either rename the original or overwrite. Let me know if you spot any 'random features'... lol J ps: It looks like that RCBASIC in Getting Started was the only link that needed updating. Please check to confirm. I will attempt to move onto the Library Reference. Starting with Console I/O |
|
|
|
Post by johnno56 on Apr 23, 2019 4:52:14 GMT -6
Library Reference - Console I/O completed library_console.zip (896 B) Attempted some examples. Please check / correct before adding? |
|
|
|
Post by tbird on Apr 23, 2019 8:11:18 GMT -6
Sorry johnno I should have said from the bottom of the category not alphabetically...but I think you knew what I meant lol.
|
|
|
|
Post by n00b on Apr 23, 2019 8:24:23 GMT -6
Hey Johnno, I looked at one of your fprint revision. You still need to add the formatting for the stylesheet. I made the corrections. Put this in the folder with the style.css file to see what I am talking about. rc_basic_fprint.html (813 B) I think that since it will be really tedious to manually add the span tags to over 300 html files, it might be a good idea for us to build a tool that will make this process easier. We are programmers after all. |
|
|
|
Post by johnno56 on Apr 23, 2019 16:05:22 GMT -6
Wow... My html isn't just rusty but almost completely corroded! Looks like it's back to school... html 101... lol I am slowly getting my head around the 'span' thingy and I think you maybe correct about 'tedious'... Never the less... rc_basic_input.html (534 B) Here is the modified 'input' ps: I prefer the indentations in html. For me, it make it easier to read, at the cost of a few bytes in white space...  Is the "sample" text meant to be this small or is it a font/Linux thing? |
|
