search

OpenCollarTeam / OpenCollar

Other
119 stars 127 forks source link

There is NO master list of ALL Commands. Why not in Remote and Collar for easy use/access? #996

Open DrWebX opened 9 months ago

DrWebX commented 9 months ago

What version of OpenCollar are you using? 8

What behavior did you expect? Be able to see, cut and paste commands available to me.

What behavior did you see instead? There is no help, no list, no commands inside the collar or remote.

What steps does someone need to take to reproduce the problem? Try to find commands online with Google. What a shame!

SilkieSabra commented 9 months ago

the "List of All Commands" is the Holy Grail of OpenCollar documentation. The list changes with every update. The list will not fit in collar or remote menus. Except possibly as a chat dump. The most commonly used commands are available on the manual page for each menu, and also on the separate page, for Prefixes, Chat Commands, and other non-menu functions, if they do not correspond to a menu button. Wish List: Someone to go through every script in the collar, find the existing chat commands, list them on a github wiki page, and also flag the ones that could be there but aren't. And then update that list after every release. Are you up to this task, @DrWebX ?

DrWebX commented 9 months ago

No, not something I can do. Appreciate your help....

On Wed, Oct 11, 2023, 4:01 PM Silkie Sabra @.***> wrote:

the "List of All Commands" is the Holy Grail of OpenCollar documentation. The list changes with every update. The list will not fit in collar or remote menus. Except possibly as a chat dump. The most commonly used commands are available on the manual page for each menu, and also on the separate page, for Prefixes, Chat Commands, and other non-menu functions, if they do not correspond to a menu button. Wish List: Someone to go through every script in the collar, find the existing chat commands, list them on a github wiki page, and also flag the ones that could be there but aren't. Are you up to this task, @DrWebX https://github.com/DrWebX ?

— Reply to this email directly, view it on GitHub https://github.com/OpenCollarTeam/OpenCollar/issues/996#issuecomment-1758661783, or unsubscribe https://github.com/notifications/unsubscribe-auth/AT6PYV7WNRH67ZSHVTIN3A3X64QNRANCNFSM6AAAAAA5XFPV7Y . You are receiving this because you were mentioned.Message ID: @.***>

Trix7125 commented 3 months ago

We could use tool like Doxygen to automate generate documentation. Down is GPT4 response how todo it.

`File Extensions for Custom Documentation: Doxygen treats certain file extensions as additional documentation files. To include custom file extensions, follow these steps: Edit your Doxygen configuration file (usually named Doxyfile). Locate the FILE_PATTERNS setting in the configuration file. Add the desired file extension (e.g., .lsl) to the list of patterns. For example: FILE_PATTERNS = .cpp .h .txt .lsl

This tells Doxygen to consider files with the .lsl extension as part of the documentation12. Commenting in LSL Files: In your LSL files, use comment blocks that Doxygen recognizes. Doxygen expects two lines of either the following formats: /// or //! for starting a Doxygen-aware comment block. It also accepts multi-line comment blocks using /* and /!1. Example Comment in an LSL File: For instance, in your LSL file (my-script.lsl), you can add comments like this: //! @file my-script.lsl //! This script does something amazing. //! ...`

Pingout commented 1 month ago

We have this in the Github: It's not complete, but it is a start. https://github.com/OpenCollarTeam/OpenCollar/blob/master/src/collar/OpenCollar_Help

DrWebX commented 1 month ago

Thank you, very useful.. it empowers the chat line commands for easier use in various settings and environments. Wonderful to add to the core knowledge...

Thanks, Michael aka DrWeb

Michael| E-mail: @.***|Facebook: Facebook https://www.facebook.com/michael.mcculley.drweb| Blog: (DrWeb's Domain https://drwebdomain.blog/)

On Wed, Jun 5, 2024 at 6:18 AM Pingout Duffield @.***> wrote:

We have this in the Github: It's not complete, but it is a start. https://github.com/OpenCollarTeam/OpenCollar/blob/master/src/collar/OpenCollar_Help

— Reply to this email directly, view it on GitHub https://github.com/OpenCollarTeam/OpenCollar/issues/996#issuecomment-2149881592, or unsubscribe https://github.com/notifications/unsubscribe-auth/AT6PYVYPADEPGCDE6CWQEEDZF4F2VAVCNFSM6AAAAAA5XFPV72VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCNBZHA4DCNJZGI . You are receiving this because you were mentioned.Message ID: @.***>