|
Post by tbird on Apr 24, 2019 8:00:45 GMT -6
n00b I am curious what is the point of doing this:
<span class="keyword">FPrint</span>(<span class="string">"This is a sample"</span>)<br> instead of this:
<span class="keyword">FPrint("This is a sample")</span><br> It is far less tedious and produces the exact same results...? As I know almost nothing about HTML, could you inform me of the important difference? The second verison would be alot easier to copy/paste a line then fill in the rest, but if it's just wrong then let me know.
Well I looked at style.css and I can see the difference now...why doesn't firefox produce the results, it's all black and the class "string" doesn't produce the color green..I will have to look into it, maybe disregard this message lol.
Now I included the style.css file in with what i was doing and voila it works.....so me being stupid.
|
|
|
Post by n00b on Apr 24, 2019 11:17:49 GMT -6
Hey TBird and Johnno, sorry for replying so late. I haven't been getting off work at a decent time at all. It seems you both figured out what is being done in the style sheet and the html. Like I said, it is tedious. Even without the styling, writing all the documentation that is currently there took me 3 or 4 weeks. I don't expect all these changes to happen immediately.
|
|
|
Post by tbird on Apr 24, 2019 22:31:11 GMT -6
Ok first off, I tried following your array html...and this is what I came up with.
I have to say, I really don't enjoy html lol
It's ok, I can try and plug away at a few of these when I get a chance and I don't think it will take too long....
|
|
|
Post by n00b on Apr 25, 2019 6:45:59 GMT -6
TBird, this is good for the most part. But could you try to keep the function name left justified. Also you don't need the underscore. We just want to modify the actual documentation and not the title. We can modify that through the style sheet itself. Thanks.
|
|
|
Post by tbird on Apr 25, 2019 7:39:33 GMT -6
Ok I will make the changes when I get a chance.
|
|
|
Post by n00b on Apr 25, 2019 7:47:25 GMT -6
Hey tbird and johnno, I think I can make this process a lot smoother. Instead of editing the html files just put all your documentation in a text file with this format:
Function: Name of Function Here <def>
Description here
<code> example code between code tags </code>
</def>
You can add multiple functions to one file like this but each function must have this format. I will write a program that reads this format and outputs the needed html.
|
|
|
Post by johnno56 on Apr 25, 2019 8:02:16 GMT -6
I have finished 'formatting' the "Math" Lib Refs (25 pages) but 18 need examples.
Hmm... Interesting change...
I will post a sample of a couple of functions just to make sure I am following you correctly... Back soon...
|
|
|
Post by johnno56 on Apr 25, 2019 8:27:17 GMT -6
Function: ABS( n ) <def> Returns the absolute value of a number. <code> ABS( -4 ) This will return 4. </code> </def> Function: ACOS( n ) <def> Returns the ArCosine of a number. <code> ACOS( 0.4 ) This will return 1.159279. </code> </def>
-----------------------------------------------
Something like this? If so, I think we maybe double handling each file. Reason: The html file would have to be opened so as to extract the information that will be placed into the 'text file'. Then the 'text file' is processed to recreate the new html files. The current method maybe tedious but each file will only be handled once. I suppose it's like swings and merry-go-rounds? Either method will work. Both methods will require a lot of work.
Just had a crazy thought... Correct me if I am wrong... All the help files are html, right? Basically they are all text files... Basically they all have the same structure / layout? Is it possible to create a program to open, read and extract the essential information and create the 'text file' that way? Just a thought or two...
|
|
|
Post by n00b on Apr 25, 2019 9:07:39 GMT -6
Johnno, you got the format right. As for your other question, I will have it extract the html files to this format. I can build the tool we need to do this in RCBasic itself. If I get off of work early enough tonight it should not take me too long to write this. If you want to continue with what you are doing thats fine also. I am just trying to simplify the process as much as possible.
|
|
|
Post by johnno56 on Apr 25, 2019 9:59:09 GMT -6
It was only a suggestion to ease the load. If the program either cannot work or it takes too long to make, I have no problem continuing as is... But not now... It's almost 2am and I need to get some sleep... Best of luck.
|
|
|
Post by tbird on Apr 25, 2019 12:37:49 GMT -6
If it isnt a rush n00b I wouldnt bother we got the format now, if you really want to make a conversion program have at er, but me and johnno can pick away at this and get it done either way.
|
|
|
Post by johnno56 on Apr 25, 2019 18:15:37 GMT -6
This is the completed Library Reference category 'Math' using the new format. Please check before using.... lib_ref_math.txt (3.44 KB)
|
|
|
Post by n00b on Apr 25, 2019 18:31:43 GMT -6
Looks good johnno, I would suggest having the part where you say "This returns ..." outside the code block so it is more obvious that it is not part of the code in the example. But its not really going to effect the readability of the documentation.
|
|
|
Post by johnno56 on Apr 25, 2019 19:25:50 GMT -6
|
|
|
Post by johnno56 on Apr 25, 2019 23:11:00 GMT -6
Here is the completed Library Reference category "Strings" in the new format. Please check before using. lib_ref_strings.txt (4.25 KB)
|
|