Skip to content

Commit

Permalink
doc: update documentation to deal with #23, #22
Browse files Browse the repository at this point in the history
  • Loading branch information
Mark Sprevak committed Jun 16, 2016
1 parent 2bc0da0 commit d587451
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 2 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -470,6 +470,13 @@ Pull requests welcome:
- No Python 2 support
- [Possible issue under Windows](https://github.com/msprev/panzer/pull/9), so far reported by only one user. A leading dot plus slash is required on filter filenames. Rather than having `- run: foo.bar`, on Windows one needs to have `- run: ./foo.bar`. More information on this is welcome. I am happy to fix compatibility problems under Windows.

FAQ
===

1. Why do I get the error `[Errno 13] Permission denied`? Filters and scripts must be executable. Vanilla pandoc allows filters to be run without their executable permission set. panzer does not allow this. The solution: set the executable permission of your filter or script, `chmod +x myfilter_name.py` For more, see [here](https://github.com/msprev/panzer/issues/22).

2. Does panzer expand `~` or `*` inside field of a style definition? panzer does not do attempt any shell expansion or globbing inside a style definition. The reason is described [here](https://github.com/msprev/panzer/issues/23). TL;DR: expansion and globbing are messy and not something that panzer is in a position to do correctly or predictably inside a style definition. You need to use the full path to reference your home directory inside a style definition.

Similar
=======

Expand Down
21 changes: 20 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ panzer user guide
=================

:Author: Mark Sprevak
:Date: 29 January 2016
:Date: 16 June 2016

panzer
======
Expand Down Expand Up @@ -663,6 +663,25 @@ Pull requests welcome:
needs to have ``- run: ./foo.bar``. More information on this is
welcome. I am happy to fix compatibility problems under Windows.

FAQ
===

1. Why do I get the error ``[Errno 13] Permission denied``? Filters and
scripts must be executable. Vanilla pandoc allows filters to be run
without their executable permission set. panzer does not allow this.
The solution: set the executable permission of your filter or script,
``chmod +x myfilter_name.py`` For more, see
`here <https://github.com/msprev/panzer/issues/22>`__.

2. Does panzer expand ``~`` or ``*`` inside field of a style definition?
panzer does not do attempt any shell expansion or globbing inside a
style definition. The reason is described
`here <https://github.com/msprev/panzer/issues/23>`__. TL;DR:
expansion and globbing are messy and not something that panzer is in
a position to do correctly or predictably inside a style definition.
You need to use the full path to reference your home directory inside
a style definition.

Similar
=======

Expand Down
18 changes: 17 additions & 1 deletion doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "panzer user guide"
author:
- name: Mark Sprevak
date: 29 January 2016
date: 16 June 2016
style: Plain
...

Expand Down Expand Up @@ -553,6 +553,22 @@ Pull requests welcome:
More information on this is welcome.
I am happy to fix compatibility problems under Windows.

# FAQ

1. Why do I get the error `[Errno 13] Permission denied`?
Filters and scripts must be executable.
Vanilla pandoc allows filters to be run without their executable permission set.
panzer does not allow this.
The solution: set the executable permission of your filter or script, `chmod +x myfilter_name.py`
For more, see [here](https://github.com/msprev/panzer/issues/22).

2. Does panzer expand `~` or `*` inside field of a style definition?
panzer does not do attempt any shell expansion or globbing inside a style definition.
The reason is described [here](https://github.com/msprev/panzer/issues/23).
TL;DR: expansion and globbing are messy and not something that panzer is in a position to do correctly or predictably inside a style definition.
You need to use the full path to reference your home directory inside a style definition.


# Similar

* <https://github.com/balachia/panopy>
Expand Down

0 comments on commit d587451

Please sign in to comment.