Display bug in line numbering

[webmozart]

When a code block has more than one digit in its line numbers, the display in the docs currently breaks for Google Chrome 22.0.1229.94 under Ubuntu 12.10:

http://i47.tinypic.com/1zg89xf.png

(http://symfony.com/doc/current/components/dependency_injection/types.html)

The issue can be fixed by increasing the width of td.linenos from 35px to 36px. The min-width should probably be adjusted too.

With three digit line numbers, the display breaks again. The minimum width that works here for "999" is 44px.

On a related note: YAML and XML snippets are missing line numbers.

[wouterj]

I had this issue too some weeks ago. It is fixed in Chrome 24, which I use now, and I think in chrome 23 too. I use a windows PC.

[webmozart]

Ah ok. What about line numbers in YAML and XML on that page?

[wouterj]

I have highlighting issues as well. For instance, the php+html blocks aren't highlighted: http://symfony.com/doc/current/contributing/code/standards.html

[weaverryan]

I did a bunch of browser screens of this, and yea, it looks like it basically affects just Chrome 21 & Chrome 22 and some of the IE browsers. So, I'm not sure how much this really matters, but I do see that td.linenos seems to actually need 37px of space and we're giving it only 35px. Most browsers are smart enough to figure it out... just not a few.

@wouterj for php+html, I'm just not sure that it's a valid format - it's only used on one place, so I removed it at sha: 23d2961 - should fix the issue :).

[wouterj]

@weaverryan from what I can see, it is: https://github.com/fabpot/sphinx-php/blob/master/sensio/sphinx/configurationblock.py#L28

But Yaml highlighting doesn't work all times too.

[weaverryan]

It might just be a CSS issue for things like php+html, but there's really no reason to have both formats anyways. If you still see a few spots where highlighting isn't working, we should hunt those down and figure out why.

[webmozart]

So can we adjust the width of the line numbers? For Debian-based Linuxes, Chrome 22 currently seems to be the only option (I failed to install a newer one on Ubuntu 12.10).

[wouterj]

Another place where syntax highlighting is missing: http://symfony.com/doc/current/book/forms.html#form-theming (the second code block)

It uses the html+jinja format. From the above comment of @weaverryan, I concluded that it should be jinja+html. But I think it isn't the problem.

The first and second code block in this example uses the same formats, I can't find any difference between them. However, the first gets highlighting and the second doesn't.

[wouterj]

I have indexed all not working code blocks in the book: https://gist.github.com/WouterJ/5029110

From that, I think I can conclude the following: Code blocks are not highlighted if they contain invalid mark-up, or are not indented the way it should be done

For instance:

• Yaml code blocks with % and @ outside quotes aren't highlighted because these are reserved characters in Yaml. We should find all code blocks containing this invalid markup and put them inside quotes. For instance:

     .. code-block:: yaml
  
         # app/config/config.yml
         parameters:
             my_mailer.class:      Acme\HelloBundle\Mailer
             my_mailer.transport:  sendmail
  
         services:
             my_mailer:
                 class:        "%my_mailer.class%"
                 arguments:    [%my_mailer.transport%]

  should become:

     .. code-block:: yaml
  
         # app/config/config.yml
         parameters:
             my_mailer.class:      Acme\HelloBundle\Mailer
             my_mailer.transport:  sendmail
  
         services:
             my_mailer:
                 class:        "%my_mailer.class%"
                 arguments:    ["%my_mailer.transport%"]

• XML/HTML/Twig code blocks which use ... to fold some attributes causes the parser to not highlight it because that is invalid markup. We can do 2 things:

  Removing the ...

     .. code-block:: xml
  
         <!-- app/config/config.xml -->
         <framework:config>
             <!-- ... -->
             <framework:router resource="%kernel.root_dir%/config/routing.xml" />
         </framework:config>

  Put ... in a comment

     .. code-block:: xml
  
         <!-- app/config/config.xml -->
         <framework:config <!-- ... -->>
             <!-- ... -->
             <framework:router resource="%kernel.root_dir%/config/routing.xml" />
         </framework:config>

  or, what I like more:

     .. code-block:: xml
  
         <!-- app/config/config.xml -->
         <framework:config
             <!-- ... -->
         >
             <!-- ... -->
             <framework:router resource="%kernel.root_dir%/config/routing.xml" />
         </framework:config>

This means that this isn't a website issue, but a code issue. That means that this issues shouldn't get the website label, but should get labeled with easy pick or actionable (@weaverryan )

[stof]

note that <!-- ... --> cannot be used inside the tag attributes for XML as you cannot start a tag there.

[wouterj]

@stof thank you, that means we should remove the ... completely (but I don't like that). @weaverryan do you have some other suggestions?