Code class labeling/syntax highlighting

[Christian South]

Some javascript/style in this post has been disabled (why?)

Docs Team,
    I don't know how likely this is but it would be nice for the code blocks for php and html code in the documentation to be labeled as such. i.e. <code class="html"> and <code class="php"> this would make it easier for anyone trying to run the docs through a syntax highlighter or other plugin a little easier. Like I said just throwing it out there.

Christian

[weierophinney]

-- Christian South <[hidden email]> wrote
(on Thursday, 04 September 2008, 04:31 AM -0400):
>     I don't know how likely this is but it would be nice for the code blocks
> for php and html code in the documentation to be labeled as such. i.e. <code
> class="html"> and <code class="php"> this would make it easier for anyone
> trying to run the docs through a syntax highlighter or other plugin a little
> easier. Like I said just throwing it out there.

Unfortunately, this isn't easy to achieve. While we can, and do, set the
"role" property on the <programlisting> tags, the DocBook HTML chunker
does not utilize this property when generating the HTML markup, and we
don't really want to start maintaining a fork of the XSLT stylesheets. :(

--
Matthew Weier O'Phinney
Software Architect       | [hidden email]
Zend Framework           | http://framework.zend.com/

[Onur]

Please don't email anymore for this topic!

On Thu, Sep 4, 2008 at 2:56 PM, Matthew Weier O'Phinney <[hidden email]> wrote:

-- Christian South <[hidden email]> wrote
(on Thursday, 04 September 2008, 04:31 AM -0400):

>     I don't know how likely this is but it would be nice for the code blocks
> for php and html code in the documentation to be labeled as such. i.e. <code
> class="html"> and <code class="php"> this would make it easier for anyone
> trying to run the docs through a syntax highlighter or other plugin a little
> easier. Like I said just throwing it out there.

Unfortunately, this isn't easy to achieve. While we can, and do, set the
"role" property on the <programlisting> tags, the DocBook HTML chunker
does not utilize this property when generating the HTML markup, and we
don't really want to start maintaining a fork of the XSLT stylesheets. :(

--
Matthew Weier O'Phinney
Software Architect       | [hidden email]
Zend Framework           | http://framework.zend.com/

[wllm]

Some javascript/style in this post has been disabled (why?)

Sorry, you can blame our mailing list software for this. L Typically when you see multiple messages coming in like this, it is simply the mailer having a hard time getting through to the list. According to a later post by the original mailer, this was the case here, too.

I’m looking in to the mailing list software right now; I’ve noticed other issues lately, too.

 

,Wil

 

From: Onur Yerlikaya [mailto:[hidden email]]
Sent: Thursday, September 04, 2008 6:06 AM
To: [hidden email]
Subject: Re: Code class labeling/syntax highlighting

 

Please don't email anymore for this topic!

On Thu, Sep 4, 2008 at 2:56 PM, Matthew Weier O'Phinney <[hidden email]> wrote:

-- Christian South <[hidden email]> wrote
(on Thursday, 04 September 2008, 04:31 AM -0400):

>     I don't know how likely this is but it would be nice for the code blocks
> for php and html code in the documentation to be labeled as such. i.e. <code
> class="html"> and <code class="php"> this would make it easier for anyone
> trying to run the docs through a syntax highlighter or other plugin a little
> easier. Like I said just throwing it out there.

Unfortunately, this isn't easy to achieve. While we can, and do, set the
"role" property on the <programlisting> tags, the DocBook HTML chunker
does not utilize this property when generating the HTML markup, and we
don't really want to start maintaining a fork of the XSLT stylesheets. :(

--
Matthew Weier O'Phinney
Software Architect       | [hidden email]
Zend Framework           | http://framework.zend.com/

 

[Christian South]

Some javascript/style in this post has been disabled (why?)

All,
    Yeah. I'm sorry. Again I apologize. I kept getting messages from the mailer daemon saying it didn't go through... Luckily eventually I gave up or it would have filled everyones emails boxes. Eventually I checked the online version and realized they all went through. Again I apologize.


Wil Sinclair wrote:

Sorry, you can blame our mailing list software for this. L Typically when you see multiple messages coming in like this, it is simply the mailer having a hard time getting through to the list. According to a later post by the original mailer, this was the case here, too.

I’m looking in to the mailing list software right now; I’ve noticed other issues lately, too.

 

,Wil

 

From: Onur Yerlikaya [[hidden email]]
Sent: Thursday, September 04, 2008 6:06 AM
To: [hidden email]
Subject: Re: Code class labeling/syntax highlighting

 

Please don't email anymore for this topic!

On Thu, Sep 4, 2008 at 2:56 PM, Matthew Weier O'Phinney <[hidden email]> wrote:

-- Christian South <[hidden email]> wrote
(on Thursday, 04 September 2008, 04:31 AM -0400):

>     I don't know how likely this is but it would be nice for the code blocks
> for php and html code in the documentation to be labeled as such. i.e. <code
> class="html"> and <code class="php"> this would make it easier for anyone
> trying to run the docs through a syntax highlighter or other plugin a little
> easier. Like I said just throwing it out there.

Unfortunately, this isn't easy to achieve. While we can, and do, set the
"role" property on the <programlisting> tags, the DocBook HTML chunker
does not utilize this property when generating the HTML markup, and we
don't really want to start maintaining a fork of the XSLT stylesheets. :(

--
Matthew Weier O'Phinney
Software Architect       | [hidden email]
Zend Framework           | http://framework.zend.com/

 

[Christian South]

Some javascript/style in this post has been disabled (why?)

Matthew,
    I was just reading the xml files for the documentation. It seems the "role" property is being used but they are all set to "php."(At least in Zend.Controller.QuickStart) If these were set correctly anyone who so wished could just generate the markup by themselves. Is this something that has not been pushed do to the fact it is not implemented in the markup currently? And is planned at all for the future?

Matthew Weier O'Phinney wrote:

-- Christian South [hidden email] wrote
(on Thursday, 04 September 2008, 04:31 AM -0400):
  

    I don't know how likely this is but it would be nice for the code blocks
for php and html code in the documentation to be labeled as such. i.e. <code
class="html"> and <code class="php"> this would make it easier for anyone
trying to run the docs through a syntax highlighter or other plugin a little
easier. Like I said just throwing it out there.
    

Unfortunately, this isn't easy to achieve. While we can, and do, set the
"role" property on the <programlisting> tags, the DocBook HTML chunker
does not utilize this property when generating the HTML markup, and we
don't really want to start maintaining a fork of the XSLT stylesheets. :(

  

[weierophinney]

-- Christian South <[hidden email]> wrote
(on Saturday, 06 September 2008, 05:15 PM -0400):
>     I was just reading the xml files for the documentation. It seems the "role"
> property is being used but they are all set to "php."(At least in
> Zend.Controller.QuickStart) If these were set correctly anyone who so wished
> could just generate the markup by themselves. Is this something that has not
> been pushed do to the fact it is not implemented in the markup currently? And
> is planned at all for the future?

Actually, other sections define the role appropriately -- I know I've
written some 'role="html"' and 'role="ini"' lines myself.

The problem is with the HTML chunker XSLT -- it only sets a
programlisting class, and ignores the role attribute entirely. We could
certainly fork the XSLT, but this then puts the onus on maintenance to
us, which I'm not sure we're prepared to handle at this time.

> Matthew Weier O'Phinney wrote:
>
>     -- Christian South <[hidden email]> wrote
>     (on Thursday, 04 September 2008, 04:31 AM -0400):
>
>
>             I don't know how likely this is but it would be nice for the code blocks
>         for php and html code in the documentation to be labeled as such. i.e. <code
>         class="html"> and <code class="php"> this would make it easier for anyone
>         trying to run the docs through a syntax highlighter or other plugin a little
>         easier. Like I said just throwing it out there.
>
>
>
>     Unfortunately, this isn't easy to achieve. While we can, and do, set the
>     "role" property on the <programlisting> tags, the DocBook HTML chunker
>     does not utilize this property when generating the HTML markup, and we
>     don't really want to start maintaining a fork of the XSLT stylesheets. :(
>
>
>
>
>

--
Matthew Weier O'Phinney
Software Architect       | [hidden email]
Zend Framework           | http://framework.zend.com/

[Christian South]

Some javascript/style in this post has been disabled (why?)

Matthew Weier O'Phinney wrote:

Actually, other sections define the role appropriately -- I know I've
written some 'role="html"' and 'role="ini"' lines myself.

The problem is with the HTML chunker XSLT -- it only sets a
programlisting class, and ignores the role attribute entirely. We could
certainly fork the XSLT, but this then puts the onus on maintenance to
us, which I'm not sure we're prepared to handle at this time.
  

I don't expect everyone at Zend and on the Doc Team to change they way they do everything just because of my request. I appreciate you clearing this up. Maybe I'll do some research into the HTML chunker and see if I can't generate my own docs using the existing XML docs.

Thanks Again

[mikaelkael]

Hi,

I recently proposed a CHM version of the documentation based on the work
of Thomas with syntax highlighting.
Here you can find the CHM:
http://mikaelkael.fr/index.php?post/2008/08/21/Zend-Framework-CHM-Francais
Here I wrote explanations to create your own CHM:
http://mikaelkael.fr/index.php?pages/Zend-Framework-CHM-Compilation 
(with the script for highlighting)

Mickael.

Christian South a écrit :

> Matthew Weier O'Phinney wrote:
>> Actually, other sections define the role appropriately -- I know I've
>> written some 'role="html"' and 'role="ini"' lines myself.
>>
>> The problem is with the HTML chunker XSLT -- it only sets a
>> programlisting class, and ignores the role attribute entirely. We could
>> certainly fork the XSLT, but this then puts the onus on maintenance to
>> us, which I'm not sure we're prepared to handle at this time.
>>  
>
> I don't expect everyone at Zend and on the Doc Team to change they way
> they do everything just because of my request. I appreciate you
> clearing this up. Maybe I'll do some research into the HTML chunker
> and see if I can't generate my own docs using the existing XML docs.
>
> Thanks Again
>