ntg-context - mailing list for ConTeXt users
 help / color / mirror / Atom feed
From: Thangalin <thangalin@gmail.com>
To: mailing list for ConTeXt users <ntg-context@ntg.nl>
Subject: ConTeXt Garden Examples Maintenance
Date: Fri, 16 May 2014 22:43:10 -0700	[thread overview]
Message-ID: <CAANrE7q3mc5swVuoro2Lv7mVkFm8zBKDyW=jJQGUSWaTjdZx+g@mail.gmail.com> (raw)

Hi,

The ConText Garden wiki has numerous short example sprinkled
throughout its pages. I presume that they are hard-coded in the page.
if the example breaks (due to a ConTeXt bug or backwards-incompatible
enhancement), I imagine there is no notification.

What do you think about creating a repository of examples that are
included by embedding a website address instead of direct text? For
example:

1. User visits wiki.
2. User edits a page (e.g., Command/setuphead).
3. User names and uploads a .tex document.
4. System generates unique hyperlink for .tex document.
5. System generates and includes embed code into wiki page, such as:

<context href="http://wiki.contextgarden.net/context/examples/file.tex" />
<context href="/context/examples/file.tex" />

Also, source="yes" and mode="mkiv" should be the default. Then, if the
person editing the page wants to include the output, the full example
might resemble:

  <context href="/context/examples/file.tex">
  This produces:
  <context output="yes" href="/context/examples/file.tex">

Having the complete examples separated allows the snippets to be
tested automatically. Broken .tex examples (unless explicitly flagged)
would result in notifications being sent to the page maintainer(s). A
broken example could be flagged as:

  <context notify="no" href="/context/examples/file.tex">

Another advantage is that all the examples could be downloaded and
possibly referenced in other media.

Kindest regards.
___________________________________________________________________________________
If your question is of interest to others as well, please add an entry to the Wiki!

maillist : ntg-context@ntg.nl / http://www.ntg.nl/mailman/listinfo/ntg-context
webpage  : http://www.pragma-ade.nl / http://tex.aanhet.net
archive  : http://foundry.supelec.fr/projects/contextrev/
wiki     : http://contextgarden.net
___________________________________________________________________________________


             reply	other threads:[~2014-05-17  5:43 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-05-17  5:43 Thangalin [this message]
2014-05-17 11:45 ` Hans Hagen

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to='CAANrE7q3mc5swVuoro2Lv7mVkFm8zBKDyW=jJQGUSWaTjdZx+g@mail.gmail.com' \
    --to=thangalin@gmail.com \
    --cc=ntg-context@ntg.nl \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).