xquerydoc icon indicating copy to clipboard operation
xquerydoc copied to clipboard

create windows run script

Open xquery opened this issue 14 years ago • 7 comments

any help please ....

xquery avatar Dec 05 '11 10:12 xquery

I take it you mean windows bat script. I will take this one, can you provide information on what you need or I can use the sh script as a template. I have ANT-Task library for xqdoc. I can just change it to use the new xquery version. Actually I prefer to do this.

garyvidal avatar Dec 05 '11 20:12 garyvidal

cool, basically the windows batch file is a run wrapper for calabash

calabash invoke is as follows

calabash -oresult=$OUTPUT/index.html $XQUERYDOC_HOME/xquerydoc.xpl xquery=$XQUERY output=$OUTPUT currentdir=$CURRENTDIR format=$FORMAT exclude= include=

where $OUTPUT = is desired output directory

$XQUERY = is directory of xquery (xquerydoc does not yet do nested dirs, we will handle this elsewhere and add a flag)

$CURRENTDIR = wherever you invoked xquerydoc from the commandline, in case you have passed in relative $OUTPUT OR $XQUERY directories, note that $OUTPUT and $XQUERY should be absolute by the time you pass them to calabash

$XQUERYDOC_HOME= wherever xquerydoc is installed, note we determine this by checking out /usr/local/bin/xquerydoc original location (e.g. its a symlink)

an example of xquerydoc output is;

http://xquery.github.com/xprocxq/api/

http://xquery.github.com/xquerydoc/api/ (I need to regenerate these)

One other consideration is installation e.g. is it normal to have an install.bat ... if so we prob need to do this as well (to emulate what Makefile does ... e.g. the Makefile invokes calabash own installation routine unsure how this may work on windows, but if we can create an install batch that emulates Makefile that would be great)

give me a shout if you need any help!

xquery avatar Dec 05 '11 20:12 xquery

current windows batch


echo off set CURRENTDIR=D:\test\xquerydoc-0.1

set XQUERY=%CURRENTDIR%\src\xquery set OUTPUT=%CURRENTDIR%\xqdoc set FORMAT=html

echo xquerydoc 0.1, generates xquery api documentation echo Copyright (c) 2011, 2012 Jim Fuller, John Snelson echo see https://github.com/xquery/xquerydoc echo echo xquery dir: %XQUERY% echo output dir: %OUTPUT% echo format: %FORMAT% echo echo generating documentation ...

java -Xmx1024m -jar "deps\xmlcalabash\calabash.jar" -D xquerydoc.xpl "xquery=%XQUERY%" "currentdir=%CURRENTDIR%" "output=%OUTPUT%" "format=%FORMAT%"

IF NOT EXIST "%OUTPUT%" GOTO notestdir GOTO endif2 :notestdir echo Creating directory at "%OUTPUT%" ... mkdir %OUTPUT% mkdir %OUTPUT%\lib

echo. :endif2


works (still need to copy some assets after xproc processes ... but now I am running into windows compat issues within xproc pipeline .... frak

xquery avatar Jan 14 '12 11:01 xquery

I did some more tests, this time with the windows script, and I currently fail to find a correct way to specify CURRENTDIR. I have tried the following variants:

  • CURRENTDIR=c:\Users\user\Desktop\xquerydoc
    com.xmlcalabash.core.XProcException: java.net.MalformedURLException: unknown protocol: c
  • CURRENTDIR=c:\Users\user\Desktop\xquerydoc
    xquerydoc.xpl:41:44:err:XS0018:No value provided for required option "output"
  • CURRENTDIR=file:///c:/Users/user/Desktop/xquerydoc/
    The filename, directory name, or volume label syntax is incorrect
  • CURRENTDIR=c:\Dokumente und Einstellungen\user\Desktop\xquerydoc\
    ...isn't accepted at all (probably due to whitespace parsing issues)

ChristianGruen avatar Jan 15 '12 21:01 ChristianGruen

as the README states, there is no windows support at the moment ... I am aware of the xproc issues

xquery avatar Jan 15 '12 21:01 xquery

..any news on this? I planned to have a look at this by myself, but didn’t manage yet..

ChristianGruen avatar Feb 15 '13 08:02 ChristianGruen

alas, no time ... focusing on xproc.xq at the moment

xquery avatar Feb 15 '13 09:02 xquery