Merge pull request #828 from pmario/new-serve-cmd

make serve.cmd useful for everyone out of the box.

bin/serve.cmd

@@ -1,11 +1,97 @@
+:: This file uses the default settings for Jeremy and 
+:: provides some help and more parameters for the rest of us.
+
+:: This script allows you to serve different TiddlyWiki editions. 
+:: It respects the TIDDLYWIKI_EDITION_PATH variable described
+:: at: # http://tiddlywiki.com/#Environment%20Variables%20on%20Node.js
+::
+:: Be sure your server tiddlywiki.info configuration contains the plugins:
+::   - "tiddlywiki/tiddlyweb" and the "tiddlywiki/filesystem"
+::   - Otherwise saving is not possible. 
+
 @echo off
+echo.
 
-rem serve TiddlyWiki5 over HTTP
+:: Help wanted!! 
+:: If someone knows, how to improve -help and -version handling tell me :)
 
-rem Optional parameter is the username for signing edits
+if "%1" == "--help" call :help
+if "%1" == "-h" call :help
+
+if "%1" == "--version" call :version
+if "%1" == "-v" call :version
+
+if "%1" == "help" (
+	call :help
+) else (
+	call :main %1 %2 %3 %4 %5
+)
+exit 0
+
+:version
+echo TiddlyWiki serve.cmd script version 0.0.1"
+echo.
+exit 0
+goto:eof
+
+:help
+echo Serve TiddlyWiki5 over HTTP
+echo.
+echo Optional parameters
+echo  - %%1 .. editions directory	.. full path or relative to current directory
+echo  - %%2 .. username 		.. for signing edits - can be empty like this: '""'
+echo  - %%3 .. password 		.. can be empty like this: '""'
+echo  - %%4 .. IP address or HOST 	.. defaults to localhost
+echo  - %%5 .. PORT			.. defaults to 8080
+echo.
+echo Example 1 .\serve .\edition\tw5.com-server username
+echo Example 2 .\serve .\edition\tw5.com-server '""' '""' localhost 9090 
+echo .. Example 2 defines: empty username, empty password
+echo.
+echo Help information
+echo  -v, --version		.. shows the script version
+echo  -h, --help, help	.. shows this help information
+echo.
+
+exit 0
+goto:eof
+
+:main
+if [%1] NEQ [] (
+	:: if there is a editions parameter .. use it.
+	set TIDDLYWIKI_EDITION_PATH=%1
+) else (
+	if [%TIDDLYWIKI_EDITION_PATH%] == [] (
+		echo Provide an edition path as your first parameter or
+		echo Define a valid TIDDLYWIKI_EDITION_PATH environment variable.
+		echo.
+		echo No environment variable set, using the default settings!
+		echo.
+		set TIDDLYWIKI_EDITION_PATH= editions\tw5.com-server
+	)
+)
+
+:: The editions path must exist!
+if not exist %TIDDLYWIKI_EDITION_PATH%\nul (
+	echo The Path: "%TIDDLYWIKI_EDITION_PATH%" doesn't exist. Create it!
+	exit 1
+)
+
+if [%5] == [] (
+	echo Using default port 8080
+	set PORT=8080
+) else (
+	echo Using port %5
+	set PORT=%5
+)
+
+echo Using edition: %TIDDLYWIKI_EDITION_PATH% !!
+echo.
 
 node .\tiddlywiki.js ^
-	editions\tw5.com-server ^
+	%TIDDLYWIKI_EDITION_PATH% ^
 	--verbose ^
-	--server 8080 $:/core/save/all text/plain text/html "%1" "%2" "%3"^
+	--server %PORT% $:/core/save/all text/plain text/html %2 %3 %4^
 	|| exit 1
+goto:eof
+