mediawiki-extensions-Visual.../.docs/generate.sh

#!/usr/bin/env bash
cd $(cd $(dirname $0); pwd)

(
	while IFS='' read -r l
	do
		if [[ "$l" == "{{VE-LOAD-HEAD}}" ]]
		then
			php ../maintenance/makeStaticLoader.php --fixdir --section=head --ve-path=../modules/ $*
		elif [[ "$l" == "{{VE-LOAD-BODY}}" ]]
		then
			php ../maintenance/makeStaticLoader.php --fixdir --section=body --ve-path=../modules/ $*
		else
			echo "$l"
		fi
	done
) < eg-iframe.tpl | php > eg-iframe.html

# Disable parallel processing which seems to be causing problems under Ruby 1.8
jsduck --config=config.json --processes=0 --color --warnings-exit-nonzero
ec=$?

rm eg-iframe.html
cd - > /dev/null

# Exit with exit code of jsduck command
exit $ec
Implement inline documentation examples. Refactored the (previously unused) eg-iframe file to be a template with 2 placeholders for script and styles. The previous version was just the basic version to execute javascript code, but that's not good enough since we need a whole bunch of classes to be loaded. A bash file processes the template into proper html, with the help of the makeStaticLoader maintenance script we already had. Updated demo.css, cleaned up redundant properties restyled slightly to be more like the Vector skin and less "raw". Fixed default $IP path in makeStaticLoader.php to work with simple mediawiki core installs having the extension in the regular extensions directory, and prefixed __DIR__ so it doesn't rely on the directory you call it from. Change-Id: Ic789121dfeca08d9db69564d2ad2e52b3fa45de9 2013-02-09 01:33:48 +00:00			`#!/usr/bin/env bash`
			`cd $(cd $(dirname $0); pwd)`

			`(`
			`while IFS='' read -r l`
			`do`
docsgen: Fix error on Ubuntu When running this on Mac, it works fine. But when running it on Ubuntu in labs, the condition checking for "VE-LOAD" head and body always evaluate to false. Not sure what's up with that, but since these lines no longer contain whitespace, a straight comparison is all we need. Also removed the duplicate `<head>` tag in the template. Change-Id: Ic7e8351e784be35fd0104269be331cf9bd0c08b4 2010-01-05 22:27:55 +00:00			`if [[ "$l" == "{{VE-LOAD-HEAD}}" ]]`
Implement inline documentation examples. Refactored the (previously unused) eg-iframe file to be a template with 2 placeholders for script and styles. The previous version was just the basic version to execute javascript code, but that's not good enough since we need a whole bunch of classes to be loaded. A bash file processes the template into proper html, with the help of the makeStaticLoader maintenance script we already had. Updated demo.css, cleaned up redundant properties restyled slightly to be more like the Vector skin and less "raw". Fixed default $IP path in makeStaticLoader.php to work with simple mediawiki core installs having the extension in the regular extensions directory, and prefixed __DIR__ so it doesn't rely on the directory you call it from. Change-Id: Ic789121dfeca08d9db69564d2ad2e52b3fa45de9 2013-02-09 01:33:48 +00:00			`then`
makeStaticLoader: Implement --fixdir option Currently when running this maintenance script it outputs the full path to the i18n file. This was done that way because of .docs/generate.sh (which pipes it to php through stdin). This however means that currently the output is not suitable for pasting into demo and test index files (as the path should be relative for those). The --fixdir option will function as toggle between a fixed path to the directory on disk, or a dynamic resolution at run-time. The default is the latter. generate.sh passes --fixdir. Change-Id: Idebca553587aaff9b31255d884461f4a51e70afd 2013-04-29 15:24:24 +00:00			`php ../maintenance/makeStaticLoader.php --fixdir --section=head --ve-path=../modules/ $*`
docsgen: Fix error on Ubuntu When running this on Mac, it works fine. But when running it on Ubuntu in labs, the condition checking for "VE-LOAD" head and body always evaluate to false. Not sure what's up with that, but since these lines no longer contain whitespace, a straight comparison is all we need. Also removed the duplicate `<head>` tag in the template. Change-Id: Ic7e8351e784be35fd0104269be331cf9bd0c08b4 2010-01-05 22:27:55 +00:00			`elif [[ "$l" == "{{VE-LOAD-BODY}}" ]]`
			`then`
makeStaticLoader: Implement --fixdir option Currently when running this maintenance script it outputs the full path to the i18n file. This was done that way because of .docs/generate.sh (which pipes it to php through stdin). This however means that currently the output is not suitable for pasting into demo and test index files (as the path should be relative for those). The --fixdir option will function as toggle between a fixed path to the directory on disk, or a dynamic resolution at run-time. The default is the latter. generate.sh passes --fixdir. Change-Id: Idebca553587aaff9b31255d884461f4a51e70afd 2013-04-29 15:24:24 +00:00			`php ../maintenance/makeStaticLoader.php --fixdir --section=body --ve-path=../modules/ $*`
Implement inline documentation examples. Refactored the (previously unused) eg-iframe file to be a template with 2 placeholders for script and styles. The previous version was just the basic version to execute javascript code, but that's not good enough since we need a whole bunch of classes to be loaded. A bash file processes the template into proper html, with the help of the makeStaticLoader maintenance script we already had. Updated demo.css, cleaned up redundant properties restyled slightly to be more like the Vector skin and less "raw". Fixed default $IP path in makeStaticLoader.php to work with simple mediawiki core installs having the extension in the regular extensions directory, and prefixed __DIR__ so it doesn't rely on the directory you call it from. Change-Id: Ic789121dfeca08d9db69564d2ad2e52b3fa45de9 2013-02-09 01:33:48 +00:00			`else`
			`echo "$l"`
			`fi`
			`done`
			`) < eg-iframe.tpl \| php > eg-iframe.html`

docgen: Use new jsduck --color and --warnings-exit-nonzero option Change-Id: I8a0d8bb8ece598991b9fd1b85cf618463a950fed 2013-04-30 18:52:23 +00:00			`# Disable parallel processing which seems to be causing problems under Ruby 1.8`
			`jsduck --config=config.json --processes=0 --color --warnings-exit-nonzero`
Docgen: Exit with error status code if there are warnings. This way the Jenkins job will be marked failure if we introduce regressions in the validity of the syntax. Change-Id: I80ea147b96632412913193600960d1cf4127ed25 2013-03-20 16:45:57 +00:00			`ec=$?`

Implement inline documentation examples. Refactored the (previously unused) eg-iframe file to be a template with 2 placeholders for script and styles. The previous version was just the basic version to execute javascript code, but that's not good enough since we need a whole bunch of classes to be loaded. A bash file processes the template into proper html, with the help of the makeStaticLoader maintenance script we already had. Updated demo.css, cleaned up redundant properties restyled slightly to be more like the Vector skin and less "raw". Fixed default $IP path in makeStaticLoader.php to work with simple mediawiki core installs having the extension in the regular extensions directory, and prefixed __DIR__ so it doesn't rely on the directory you call it from. Change-Id: Ic789121dfeca08d9db69564d2ad2e52b3fa45de9 2013-02-09 01:33:48 +00:00			`rm eg-iframe.html`
			`cd - > /dev/null`
Docgen: Exit with error status code if there are warnings. This way the Jenkins job will be marked failure if we introduce regressions in the validity of the syntax. Change-Id: I80ea147b96632412913193600960d1cf4127ed25 2013-03-20 16:45:57 +00:00
docgen: Exit with exit code of jsduck command Change-Id: Idf896dc6d9dcd11effcc9836b857267570db3e15 2013-03-15 16:25:39 +00:00			`# Exit with exit code of jsduck command`
			`exit $ec`