History: Preferences report
Source of version: 20 (current)
Copy to clipboard
^ This is the responsibility of the ((tw:Profiles Team)) (please join!) ^
This has now been moved to ((doc:Console))
An example: ((doc:TikiMaster-Preference-Report))
{CODE(caption="To generate a report of all prefs" colors="shell")}php doc/devtools/prefreport.php > prefreport.csv{CODE}
Should be done on a fresh install, in English. This scans all the code for relevant info, and generated a .csv file with meta data on all prefs. The result will be (for example) at http://example.org/prefreport.csv
This script was created to help manual checks to make sure
# No typos on using feature names
**to avoid problems like the one solved on {commit id=17972}, {commit id=21618}, etc.
# None are forgotten
** Will all the work on ((Magic)), ((AdminUIrevamp)) and ((Preferences)), chances are high to have lost one or two :-)
# There are no duplicates like {commit id=35237}
# Make a list of all possible feature_names appearing in admin panels
# Make a list of all possible feature_names appearing lib/setup/prefs.php
! How to improve
* Make modules as prefs so we get links to documentation, and other details
* add anything missing in the report (ex.: keywords) and detect descriptors that are not currently listed (could be a typo)
* .csv to html and .csv to wiki, with something like http://www.textfixer.com/html/csv-convert-table.php
** See .csv viewer example: https://github.com/plotly/datasets/blob/master/Key%20Macroeconomic%20Indicators.csv
*Add the Tiki version that created the report as a line at the start
*Ensure all string vars are properly quoted in outpout file, at present, file gets truncated in OpenOffice due to formatting errors
*Remove line-breaks in variables (causes problems when opening in Excel)
*Make it ((doc:MultiTiki))-ready (see [wish6748])
-=alias=- (alias(Pref Report)) (alias(Prefs Report))