Adding php-standalone and php-symfony

[weaverryan]

Hi Fabien!

Easy-enough addition, but thought I'd help anyways. This is for the form component documentation (symfony/symfony-docs#1883). It's still an experiment, but I think worth trying.

Two issues that you mentioned still are:

a) If we like this, we'll need to code so that a user can download different versions of the book
b) We don't have a solution yet for the printed book

I suppose that if this is the right way to doc some of the components, then we'll figure out (b) when we need to. Also, for now, we're keeping the form book chapter in tact. So, the "form component" documentation for now is only really needed for form component users (i.e. it would still be ok to print just the component-use version in a book).

Along with this, the conf.py file will need the following 2 lines added:

lexers['php-standalone'] = PhpLexer(startinline=True)
lexers['php-symfony'] = PhpLexer(startinline=True)

Thanks!

[mattattui]

@fabpot nudge Would be great to get this merged in (if it's not too controversial) so that we can have some Form Component documentation ❤️. It's been ready for 3 months, according to the comments on symfony/symfony-docs#1883

[ghost]

+1

[weaverryan]

One issue which may be delaying this (I'm not sure though) is that we don't really know how to handle this with the PDF book. Which version do we show? Do we show both? Do we allow the user to select which version of the book we want? I'm not sure we've really gotten a satisfiable answer to that, so merging this in means we have to deal with that.

If you have any thoughts, it'd be nice to hear them :).

[mattattui]

It's an ugly choice to have to make. I understand!

The only way I can think of doing it is stacking all the alternative presentations (including the default one) on their own page in a Reference appendix at the end of the PDF, then add links and page numbers under the default view (e.g. the Annotations one) so people browsing the PDF can just click to get there, while people who printed it out can flick to that page.

It's less than ideal, but at least it clusters the presentational ugliness at the end of the book and makes it into a reference section, which would be useful in its own right.

On 4 Mar 2013, at 14:11, Ryan Weaver notifications@github.com wrote:

One issue which may be delaying this (I'm not sure though) is that we don't really know how to handle this with the PDF book. Which version do we show? Do we show both? Do we allow the user to select which version of the book we want? I'm not sure we've really gotten a satisfiable answer to that, so merging this in means we have to deal with that.

If you have any thoughts, it'd be nice to hear them :).

—
Reply to this email directly or view it on GitHub.