Documentation: add examples to commands/scripting/events -- volunteer required

[un1versal]

trafficstars

One complaint often repeated about KVIrc on IRC is that in relation to general scripting or some commands/functions etc. , there arent any related examples or the examples are not as descriptive or straight forward as they could be.

Obviously doesn't apply to all instances but this would be a welcomed improvement.

Could be done in chunks a little at a time.

Skills required:

• No C++ experience necessary, though some KVIrc scripting understanding would be advantageous.
• Time
• Willingness to contribute back to your IRC client.

[titaniachkt]

I've been going through the recent online [2016] documentation in the past few days [november], and noticed the same as well, especially for the more complex tasks.

If anyone has a list of items/tasks to include with higher priority than others/ or other considerations, feel free to mention it somewhere and I'll take note of those when figuring out what to work on

[alexzulu]

I can to write examples. I need only themes for examples.

[titaniachkt]

Here are some general documentation notes, and related stuff, to be updated as often as possible

If anyone has ideas, thoughts, guidelines etc about any of the content in that project or similar, please let me know asap

Also, are there standard help page formatting guidelines etc? [a link or something would be great, haven't done much digging for it yet]

[un1versal]

that looks good. as for formatting or guidelines this is the most up to date https://github.com/kvirc/KVIrc/blob/master/doc/ui-style.tips.txt for scripting examples try to follow Allman style

A great deal of these https://github.com/kvirc/KVIrc/tree/master/doc need bringing up to date eventually its a terrible mess. the FAQ would be probably better suited to transfer to Wiki instead. FIles that been re-written is the INSTALL file the rest is a spaghetti soup of mess.

If working on internal KVIrc help which is what needs improving, follow the style in existing files that have been updated recently (this doesnt mean that the contents dont need updating, play it by ear) e.g. https://github.com/kvirc/KVIrc/blob/master/src/modules/config/libkviconfig.cpp#L37-L80 FYI those entries is what generates the HTML help files you see on website or internal KVIrc help. So if you would have updated https://github.com/kvirc/KVIrc/blob/master/src/modules/config/libkviconfig.cpp#L37-L80, when KVIrc is compiled with that new content the HTML files are copied to website.

NOTE: Dont work or update kvirc help files in website directly e.g. https://github.com/kvirc/kvirc-www/tree/master/doc those files are generated from these https://github.com/kvirc/KVIrc/blob/master/src/modules/config/libkviconfig.cpp#L37-L80 Internal help formatting for https://github.com/kvirc/KVIrc/blob/master/src/modules/config/libkviconfig.cpp#L37-L80 type it takes things like [i]italic example[/i] [b]bold example[/b] etc...

I recently updated all the internal Aliases/Events/Popups/Actions etc. for coding style and cleanups, so those should not need any work, in fact those are good examples on how to proceed forward coding wise.

EDIT: Feel free to ask for any clarification when in doubt.

[un1versal]

Ive regenerated the internal help files from KVIrc master and updated the website with them in https://github.com/kvirc/kvirc-www/commit/a9e9fc19d963ed484f491c1137793abb709e520e