Fixing Turing Help Documentation
Author |
Message |
BigBear
|
Posted: Sat Mar 14, 2009 3:05 pm Post subject: Fixing Turing Help Documentation |
|
|
I noticed that many of the commands were updated but the Help documentation wasn't updated.
Just look at Font.Sizes the Example Program is there but the Launch sample Program has new features. Also a few of the example program have or had I forget which ones. I remeber the being a list of variables with a comma at the end so it would error when you ran it like Font.Sizes in previous versions or the program displayed in the help file.
This is a link to a project from a few years ago where they were adding modules and editing the Help file to accomidate them.
It seems the in no conclusion to the project does anyone what happend.
http://compsci.ca/v3/viewtopic.php?t=9305&postdays=0&postorder=asc&highlight=password&start=15
Also I know compsci.ca has embraced the help documentation, I was wondering if they have fixed some of the issues I was mentioning and if you can browse the online list like the help documentation. |
|
|
|
|
|
Sponsor Sponsor
|
|
|
corriep
|
Posted: Sat Mar 14, 2009 4:22 pm Post subject: Re: Fixing Turing Help Documentation |
|
|
Most of the GUI module example programs don't work because of silly errors. Take this one from GUI.CreateRadioButton.. Turing: | import GUI
View.Set ("graphics:350;80")
var radio : array 1 .. 6 of int
procedure RadioPressed
Text.Locate (1, 1)
put "Radio Button " ..
for i : 1 .. 6
if radio (i ) = GUI.GetEventWidgetID then
put i ..
end if
end for
put " Selected"
end RadioPressed
radio (1) := GUI.CreateRadioButton (15, maxy 35, % Supposed to be maxy - 35?
"Radio Button 1", 0, RadioPressed )
radio (2) := GUI.CreateRadioButton ( 1, 1, "Radio Button 2",
radio (1), RadioPressed )
radio (3) := GUI.CreateRadioButton ( 1, 1, "Radio Button 3",
radio (2), RadioPressed )
radio (4) := GUI.CreateRadioButtonFull (maxx 15, maxy 35, % Supposed to be maxy - 35?
"Radio Button A (Shortcut: 'a')", 0, RadioPressed,
GUI.RIGHT, 'a')
radio (5) := GUI.CreateRadioButtonFull ( 1, 1,
"Radio Button B (Shortcut: 'b')", radio (4), RadioPressed,
GUI.RIGHT, 'b')
radio (6) := GUI.CreateRadioButtonFull ( 1, 1,
"Radio Button C (Shortcut: 'c')", radio (5), RadioPressed,
GUI.RIGHT, 'c')
loop
exit when GUI.ProcessEvent
end loop |
|
|
|
|
|
|
Dan
|
Posted: Sat Mar 14, 2009 5:10 pm Post subject: RE:Fixing Turing Help Documentation |
|
|
The on line Turing documentation can be found here: http://compsci.ca/holtsoft/doc/
We have not made any changes and it is a copy of the 4.1.1 documentation.
If you could provide a list of errors, better examples, or even new versions of the html file for a command that is more correct i could update it. |
Computer Science Canada
Help with programming in C, C++, Java, PHP, Ruby, Turing, VB and more! |
|
|
|
|
BigBear
|
Posted: Sat Mar 14, 2009 6:08 pm Post subject: RE:Fixing Turing Help Documentation |
|
|
Ok and what about replacing the current F10 help in turing?
I don't know how to create any html help files or edit the current one.
But I could try to find most of the errors.
EDIT: Yeah like that example
Turing: | import GUI
View.Set ("graphics:350;80")
var radio : array 1 .. 6 of int
procedure RadioPressed
Text.Locate (1, 1)
put "Radio Button " ..
for i : 1 .. 6
if radio (i ) = GUI.GetEventWidgetID then
put i ..
end if
end for
put " Selected"
end RadioPressed
radio (1) := GUI.CreateRadioButton (15, maxy - 35, "Radio Button 1", 0, RadioPressed )
radio (2) := GUI.CreateRadioButton (1, 1, "Radio Button 2",
radio (1), RadioPressed )
radio (3) := GUI.CreateRadioButton (1, 1, "Radio Button 3",
radio (2), RadioPressed )
radio (4) := GUI.CreateRadioButtonFull (maxx - 15, maxy - 35, "Radio Button A (Shortcut:'a')", 0, RadioPressed, GUI.RIGHT, 'a')
radio (5) := GUI.CreateRadioButtonFull (1, 1, "Radio Button B (Shortcut: 'b')", radio (4), RadioPressed, GUI.RIGHT, 'b')
radio (6) := GUI.CreateRadioButtonFull (1, 1,
"Radio Button C (Shortcut: 'c')", radio (5), RadioPressed,
GUI.RIGHT, 'c')
loop
exit when GUI.ProcessEvent
end loop |
I noticed most of the programs which open with the Launch Example Program button are different then the program written out right above it.
I guess they didn't update the help file yet or are the programs supposed to be different. |
|
|
|
|
|
BigBear
|
Posted: Fri Apr 24, 2009 5:08 pm Post subject: RE:Fixing Turing Help Documentation |
|
|
OK well I have started to edit the .chm file and I am adding syntax highlights but it doesn't seem to follow the same highlights as Turing
I think all commands are bold even if the aren't in Turing.
Some times maxx and div are bold and somethimes they aren't.
I thought it was when they are important but that doesn't seem to be the case either.
I think I am going to make it like Turing Compiler(is compiler the right word)
EDIT:
Does anyone know why there are random lines containing ...
like in this example
|
|
|
|
|
|
BigBear
|
|
|
|
|
|
|