Jamroom Help: The first docs I want to read: Jamroom5 docs suggestion list
Brian Jamroom Team
Joined: 09 Jul 2003
Posts: 37583
Location: Seattle, WA
Posted: 08/12/13 07:13
Douglas:
SteveX:
That sounds cool. Views alone might not be the best way to go with it, might be best to let the developer arbitrate as to which ones are the relevant faq and which ones are just being gamed by numpties. But you know that already Brian.
@Douglas - are you updating your faq module for jr5?
Although you could probably use the jrAparna module to create a FAQ module fairly quick, the jrDocs module would also work well as a FAQ module, so I really didn't see a need to create a FAQ module.
Do we need a FAQ module for JR5?
I don't think so - the Docs module will work just fine.
Anything at all to do with validation, one paragraph would probably do.
To tide you over. There are a couple of 'validate' locations. One is the "checktypes" which is the validation system for the form fields created in, for example, the config.php files that look like this
Code
// Block MP3 Downloads
$_tmp = array(
'name' => 'block_download',
'default' => 'on',
'type' => 'checkbox',
'validate' => 'onoff',
'required' => 'on',
'label' => 'block MP3 downloads',
'help' => 'By default MP3 files are blocked from being downloaded via the "download" URL, and are only playable in the site audio players. Uncheck this option to allow download of MP3 files',
'order' => 1
);
jrCore_register_setting('jrAudio',$_tmp);
That one has the 'validate' => 'onoff'. This is the checktype form of validation. The options you have are easy to see if you open the file:
/modules/jrCore/lib/checktype.php
It will have all the core defined checktypes in it as individual functions. (modules can define their own checktypes too.)
For me the easyest way to get there and look at that file is
* ctrl+shift+alt+n in phpstorm "search for symbol" and type 'onoff'.
That will get me to the checktype.php file, then
* ctrl+shift+- will squish the functions down to where there is only the function definitions and explanations.
So then you can use any of those checktypes for the 'validate' = portion of the form fields.
---------------
Ill get the custom checktype validation explanation out with the docs, but if the options above dont cut it, please say and Ill write a bit on adding your own type of validation. an example of this would be "function jrAudio_form_field_audio_validate()"
Is there going to be a full fledged function reference again? Or are they going to be in each module section?
Kyle
Each module developer will have their own profile once jamroom.net gets changed over to running JR5. Each developer will be responsible for their own docs.
Making a list of all the functions wasn't something on my radar. Probably because I didn't use that much in JR4. And now with JR5 + phpstorm, you can type 'jrCore' then use ctrl+space to autocomplete, then do ctrl+q for extra info and get all the docblock for the function as you are coding it. Saves going to the docs at all.
Looks like this:
You can do the same for anything. so if you wanted a jrAudio function 'jrAudio' ctrl+space then ctrl+q and you have all the jrAudio functions in front of you. Docs built into the editor automatically.
As a new user to Jamroom I would really love some Docs to work with. Still trying to get my head around the tpl's etc. Any idea on how long till we have some documentation?
Joined: 09 Jul 2003
Posts: 37583
Location: Seattle, WA
Posted: 09/07/13 09:01
ba9801:
As a new user to Jamroom I would really love some Docs to work with. Still trying to get my head around the tpl's etc. Any idea on how long till we have some documentation?
Very soon - I would say in the next week or so we will be opening up the new Jamroom.net for beta testing - that will let us get feedback from everyone before we throw the switch on it.
