Part of the Khronos Group
OpenGL.org

The Industry's Foundation for High Performance Graphics

from games to virtual reality, mobile phones to supercomputers

Results 1 to 3 of 3

Thread: GL reference pages updated to Docbook 5 / HTML 5

  1. #1
    Administrator Contributor
    Join Date
    Jan 2002
    Location
    Mt. View, CA
    Posts
    97

    GL reference pages updated to Docbook 5 / HTML 5

    I've udpated the GL API and GLSL reference pages to Docbook 5 source and HTML5 output, so we can join the 2010s. They are now using MathJax for rendering equations on browsers that don't support MathML (e.g. everything except Firefox, basically). There's an improved (hopefully) sidebar navigation interface and some CSS changes to be more similar to the OpenCL reference pages. I might tweak the CSS a bit as the font sizes are larger than the old pages.

    Because many people probably arrive at the man pages via search engine links, and because IE8 and earlier browsers don't deal well with HTML5, the old pages are now redirection links which point to the current index page but also allow escaping to cached copies of the XHTML Transitional output. Eventually these will be purged (I think IE <= 8 users are less than 10% of opengl.org site visits these days). Hopefully the search engines will start linking to the HTML5 pages soon, but that's outside our control.

    If you have problems or other feedback, please report it here. Assuming no immediate issues crop up, I'll be repeating this exercise for the OpenGL ES reference pages in a day or so. The build instructions on the Wiki are now way out of date and will also be updated soon (quick version: you need the latest docbook-xsl-ns 1.78.1 stylesheets installed).

    If you're using the Docbook sources and don't want to migrate to Docbook 5 yet, the old sources are still available in docbook4/ subdirectories in Subversion, but they will not be updated going forward.
    Jon Leech
    Khronos API Registrar
    ARB Ecosystem TSG Chair
    GL/EGL/GLES Spec Editor
    ...and suchlike

  2. #2
    Senior Member OpenGL Pro
    Join Date
    Apr 2010
    Location
    Germany
    Posts
    1,129
    Thank you for the effort, Jon!

    One thing I just notice: while vectors and stuff (or formulae in general) seem to be rendered correctly when used inline. However, if displayed inside a table they seem to be just plain text which is very hard to read. THis is very obvious for glBlendFunc and glBlendEquation, for instance.

    Using Firefox 26.0 in Ubuntu 12.04.

  3. #3
    Member Regular Contributor
    Join Date
    Oct 2006
    Posts
    353
    Quote Originally Posted by Jon Leech (oddhack) View Post
    If you have problems or other feedback, please report it here. Assuming no immediate issues crop up, I'll be repeating this exercise for the OpenGL ES reference pages in a day or so. The build instructions on the Wiki are now way out of date and will also be updated soon (quick version: you need the latest docbook-xsl-ns 1.78.1 stylesheets installed).
    Thanks for this, it's working great.

    Is there a chance that you can share the docbook sources for OpenGL ES, as you do for regular OpenGL? We are using the sources as inline documentation in OpenTK (C# OpenGL bindings) and it would be awesome to do the same for OpenGL ES.

    (Or are the OpenGL ES sources already available? I have only been able to find OpenGL docbook sources at:
    https://cvs.khronos.org/svn/repos/og...sdk/docs/man4/
    )
    [The Open Toolkit library: C# OpenGL 4.4, OpenGL ES 3.1, OpenAL 1.1 for Mono/.Net]

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •