 Notice. New forum software under development. It's going to miss a few functions and look a bit ugly for a while, but I'm working on it full time now as the old forum was too unstable. Couple days, all good. If you notice any issues, please contact me. |
Forum Index : Microcontroller and PC projects : Help files and how best to use them
| Author | Message | ||||
electricat Senior Member  Joined: 30/11/2020 Location: LithuaniaPosts: 299 |
For any furthurer discusions (and sharing), this was moved from RC thread. help.txt templates Only commands Commands and functions with full desriptions. Edited 2025-04-21 22:47 by electricat My MMBasic 'sand box' |
||||
| electricat Senior Member Joined: 30/11/2020 Location: LithuaniaPosts: 299 |
- I made help.txt files accordingly. - I found also, I missed and not added in previous uploads TRIANGLE SAVE / RESTORE - Added text files as in official help manual (no pictures, tried use ASCII if possible). Means , now there is almost full official help +3D commands from CMM2 - Tried to remove unnecessary duplicatings - Moved important BETA notes to external file. All beta changes can be listed in one go, entering '*' as keywoard. > HELP *** Sure I might be missed something. Tried to follow and documenting beta thread at my best. So now, there is three groups of files inside archive. -Beta changes (long only/verbose) -commands and functions only (long/verbose and short) -full help as per official manual (long/verbose and short) Short versions still contains explanations near commands I felt might be important/hard to rememeber. Help_system_Picomites.zip If you see any bad problems needed to fix, please post. I will fix at free time. P.S. Personally I use different format of this help. ~ COMM/FN (or TOPIC or OPT or MM) ; args ; optionals ; theme_keyword(s) ; * I believe it`s more friendly for new users. I updated files, should be OK now Edited 2025-04-25 02:10 by electricat My MMBasic 'sand box' |
||||
| electricat Senior Member Joined: 30/11/2020 Location: LithuaniaPosts: 299 |
Dirty and simple three help.txt files switcher. Copy choosen help files to -> A: Rename them -> long_help.txt ; short_help.txt ; beta_help.txt Add -> OPTION F6 "sw_help"+chr$(13) Code below -> LIBRARY SAVE Sub sw_help sw_cdrw$=MM.Info(DRIVE) sw_cdir$=Cwd$ Drive "A:" Chdir "A:" sw_long_h=MM.Info(exists file "long_help.txt") sw_short_h=MM.Info(exists file "short_help.txt") sw_beta_h=MM.Info(exists file "beta_help.txt") If sw_long_h= 1 And sw_short_h=1 Then Rename "help.txt" As "beta_help.txt" Rename "short_help.txt" As "help.txt" Print "SHORT HELP version online" End If If sw_long_h= 1 And sw_beta_h=1 Then Rename "help.txt" As "short_help.txt" Rename "long_help.txt" As "help.txt" Print "LONG HELP version online" End If If sw_short_h= 1 And sw_beta_h=1 Then Rename "help.txt" As "long_help.txt" Rename "beta_help.txt" As "help.txt" Print "BETA HELP version online" End If Drive sw_cdrw$ Chdir sw_cdir$ End Sub My MMBasic 'sand box' |
||||
| dddns Guru  Joined: 20/09/2024 Location: GermanyPosts: 426 |
Hello electricat! I would like to bring this up once more and I would like to say many thanks for the enormous work! Sorry that I was so busy and didn't pay enough attention till now. @Mani hinted me yesterday and I searched for it, which was not so easy. Then I tried to get an overview and this wasn't so easy as well for a newcomer to this issue because everything said is very technical and not easy to understand (for a newcomer). This help system is very nice and of cause many thanks @matherp as well! Please describe it once more in easy words what needs to be done to install it and how to use it. And after looking at it I would please you to further develop it. For my taste the formatting could be nicer and more clear to read. The line length differs too much. Nice work! |
||||
| dddns Guru Joined: 20/09/2024 Location: GermanyPosts: 426 |
Another thought: look for help.txt in a: and/or b: if present |
||||
| dddns Guru Joined: 20/09/2024 Location: GermanyPosts: 426 |
And a last one: > help list* LIST [fname$] or LIST ALL [fname$] List a program on the console. LIST on its own will list the program with a pause at every screen full. LIST ALL will list the program without pauses. This is useful if you wish to transfer the program to a terminal emulator on a PC that has the ability to capture its input stream to a file. If the optional 'fname$' is specified then that file on the SD card will be listed. LIST COMMANDS or LIST FUNCTIONS Lists all valid commands or functions Maybe it is an idea to have a stable and a development branch of this file which then could be used to update the manual for the next stable? Edited 2025-05-16 19:21 by dddns |
||||
| electricat Senior Member Joined: 30/11/2020 Location: LithuaniaPosts: 299 |
This file was part of experimenal help system I made before 'inbuilt' help system. This is why formating is as is. Lines are splitted becouse they can not exceed 255 limit too. Yes, but if Peter is interested/have time or wish to make this at firmware side (or multiple users would ask for this, so Peter would know it is not wasting of time?  ). In my experimental help system, I made before inbuilt HELP was introduced, there was such functionality. Program looked for help files at B: and if not found in A: ind if not found then user was informed there is no ready help file. I am interested in this system, and will do my best to include changes on next stable release. Will post here. It depends on my 'free time deposit' and 'real life' time consumes so there is no any qaurantee I can make it happen 'next day'  My MMBasic 'sand box' |
||||
| dddns Guru Joined: 20/09/2024 Location: GermanyPosts: 426 |
Hello electricat, I didn't know the situation how much you are still involved. I think this is important but was discussed so less. Anyway, thanks for your precious work! |
||||
 Print this page |
 |
The Back Shed's forum code is written, and hosted, in Australia. | © JAQ Software 2025 |
