The biweekly deliveries from the ON gate--the stuff that gets posted
externally--contain a source snapshot tarball. This tarball contains a
README with known issues and quickstart instructions, both of which are
pulled from ON community web pages.
Unfortunately, the website migration to XWiki this week broke the
mechanism that pulls in those pages. The script that generates the
README relied on HTML comments (included in the page content) to
separate the content from the site boilerplate (nav bars, etc). Because
the new site doesn't support HTML content, I need to find another
mechanism.
My current thinking is to continue using tags in the page content,
rather than trying to rely on the HTML that XWiki produces. These tags
will be visible to anyone who views the web page, but I'm hoping they'll
be unobtrusive enough that nobody will care much. I also want the tags
to be sufficiently self-documenting that people are unlikely to
delete them while updating the web pages. So, I'd like to propose
<begin README tag - do not delete>
<end README tag - do not delete>
as the tags (including the literal angle brackets).
If you think this is the wrong way to handle this, or if you'd like to
suggest a better set of tags, please speak up.
thanks,
mike