Improving access to the grammars

Hi,

I opened issue #138 when I realized that clicking on links to
the ‘ixml.ixml’ and ‘ixml.xml’ grammars on the invisiblexml.org site has
unpredictable results:

* Clicking on ixml.xml displays the raw XML in some browsers, but
  displays
 
    version 2022-06-07 Optional spacing Required spacing all characters
    except line breaks; quotes must be doubled all characters except line
    breaks; quotes must be doubled

  on Safari.

* Clicking on ixml.ixml downloads the file instead of displaying it,
  even though it’d be just as reasonable to want to look at the grammar
  in the browser.

There was some follow-up discussion in the issue comments that revealed
a diversity of opinion on desired behavior.

From my perspective, the combination of unpredictability and the awful
user experience with Safari, are compelling reasons to do something
better.

I propose that we introduce interstitial HTML pages:

1. Better, consistent user experience
2. Ability to have an explicit “please download this” link
3. We can still have links to the raw files for thems that wants them

I’ve put together examples at https://ndw.github.io/ixml/

You can click on the links from that version of the home page, or go
directly to the pages:

  https://ndw.github.io/ixml/1.0/ixml-ixml.html[*]
  https://ndw.github.io/ixml/1.0/ixml-xml.html

If we like the results, I’ll have to tinker just a little bit to make
the build automatic for new drafts. Since the 1.0 spec is immutable, I
just did it by hand.

                                        Be seeing you,
                                          norm

[*] The version of Prism JS that can do syntax highlighting of iXML
is here https://github.com/ndw/prism

--
Norm Tovey-Walsh
Saxonica

Received on Thursday, 4 August 2022 15:23:05 UTC