Skip to content
This repository has been archived by the owner on Jun 6, 2019. It is now read-only.

Examples database #24

Open
Klortho opened this issue Oct 1, 2015 · 0 comments
Open

Examples database #24

Klortho opened this issue Oct 1, 2015 · 0 comments

Comments

@Klortho
Copy link
Member

Klortho commented Oct 1, 2015

These are some ideas for requirements for a database of examples.

  • Mulberry's tag libraries have an elaborate scheme for using full, valid XML files as examples, and then eliding them for display on individual pages. Maybe we could re-use that?
  • OTOH, it would be nice if the examples could remain unsullied (their scheme adds a bunch of PIs, which would be hard to maintain).
  • We need a method to render:
    • Relevant portions of the document, with ellipses for elided parts
    • Pretty-printed, syntax highlighted
    • Also highlight the relevant keyword or section
    • The recommendations document should specify how the example is to be rendered, in a data-driven way
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant