Command-line flags

[weierophinney]

We're planning on using Bookdown for the documentation of the various Zend Framework components. One thing I'd like to be able to do is have a bare-minimum bookdown.json that specifies the title and content, and optionally the default target, and then specify the template (and possibly the target) via a command-line flag. This would allow us to have the "official" templates in a top-level repo that aggregates documentation from each of the components, but also allow developers to render the documentation using that template if it's checked out somewhere on their filesystem:

$ bookdown --template=../documentation/templates/main.php doc/bookdown.json

Or, to override the target:

$ bookdown \
> --template=../documentation/templates/main.php \
> --target=../documentation/html/ \
> doc/bookdown.json

[pmjones]

/me nods

Given config file and option flag, which do you think should take precedence? (I'd say option flag.)

[weierophinney]

Definitely option flag; that's the most specific, as it's specified at time
of invocation.
On Jun 13, 2015 1:50 PM, "Paul M. Jones" notifications@github.com wrote:

/me nods

Given config file and option flag, which do you think should take
precedence? (I'd say option flag.)

—
Reply to this email directly or view it on GitHub
#11 (comment)
.

[pmjones]

Agreed. Let me see what I can do. (Additionally, if you have time and inclination to work up a PR, I'll review it.)

[pmjones]

This should be fixed; try the dev-develop branch and let me know how it goes for you.

[pmjones]

Nope, not yet -- sorry for the noise.

[pmjones]

@weierophinney OK, now try dev-develop. You should be able override with --template= and/or --target= at will.

[weierophinney]

I can confirm it works... but there's one oddity. :)

So, I have a directory structure that has the following:

documentation/
    doc/
        templates/
a-component/
    doc/
        bookdown.json
        book/

Inside of a-component/, I invoked bookdown with the following:

$ bookdown --template=../documentation/doc/templates/main.php doc/bookdown.json

This failed; it could not find the template:

Cannot find template 'doc/../documentation/doc/templates/main.php'.

In other words, it was resolving the relative path relative to the bookdown.json, not where bookdown was actually invoked.

I would expect it to resolve the path based on where the script was invoked. This would require resolving path arguments prior to parsing the bookdown.json, probably.

(When I re-ran and specified the path relative to the bookdown.json, it worked perfectly.)

[pmjones]

Mmm, I can guess what the problem is. I'll take a look.

[pmjones]

OK @weierophinney give it another go. The relevant commit is dee1f42 and takes away the code to "fix" the path to make it relative to the bookdown.json file.

[weierophinney]

Works perfectly, @pmjones ! 🚢 !!!

[pmjones]

Finally. Sorry for the hassle, and thanks for your patience. New release forthcoming as a result!