Wiki pages to be included in a release

This list only provided for convenience. See checkwiki.py​ for the official list of wiki pages to be included in releases.

The following table lists the pages that are to be included with 0.11, and the name of the person who proof-read and possibly updated/corrected that page.

Page	Proof-read	Comments
CamelCase	cboos
InterMapTxt	cboos
InterTrac	cboos
InterWiki	cboos
PageTemplates	cboos	removed the useless sample template - please don't add it back
RecentChanges	cboos	upgrade t.e.o wiki after 0.11
TitleIndex	cboos	upgrade t.e.o wiki after 0.11
TracAccessibility
TracAdmin
TracBackup
TracBrowser
TracCgi
TracChangeset
TracEnvironment
TracFastCgi
TracFineGrainedPermissions
TracGuide
TracIni
TracInstall
TracInterfaceCustomization		The section about AdSense was removed from the checked in version of this page. We should take care to not add it back inadvertently.
TracImport		Has an attachment :-/ Should we check this in to the contrib dir? - no
TracLinks
TracLogging
TracModPython
TracModWSGI		since 0.11 - not yet added
TracNavigation	added in r6591	since 0.11
TracNotification
TracPermissions
TracPlugins
TracQuery
TracReports
TracRevisionLog
TracRoadmap
TracRss
TracSearch
TracStandalone
TracSupport
TracSyntaxColoring		(Didn't check the support languages table in detail)
TracTickets
TracTicketsCustomFields
TracTimeline
TracUnicode
TracUpgrade
TracWiki
TracWorkflow		since 0.11
WikiDeletePage
WikiFormatting
WikiHtml	cboos	TODO remove the -- NOTE: activate once t.e.o. is running 0.11 -- line in the checked in version and on t.e.o after the upgrade
WikiMacros
WikiNewPage
WikiPageNames
WikiProcessors
WikiRestructuredText
WikiRestructuredTextLinks		apparently there's a bug with attachment links…
WikiStart

Notes

• We need a page describing the fine-grained permissions, probably by merging the FineGrainedPermissions page and the TracDev/SecurityBranch - see now TracFineGrainedPermissions

• Speaking about TracPermissions, the 0.10 documentation had been updated to include screenshots, as visible in ​version 51. What should we do with this? Integrate them in the shipped documentation? I'm vaguely -0 about this. Some screenshots here and there might help, but those ones don't look terribly useful.

• A reference to TracMigrate has been added to a lots of places. That page doesn't seem useful enough to be part of the standard documentation. Opinions?

• OTOH, it seems quite worthy to integrate wiki:TracModWSGI. Opinions?

Status

Currently preparing the 0.11 release

How to maintain the default wiki pages in sync?

As some content is only pertinent on t.e.o and not in the packaged docs, downloading new content from t.e.o will lead to repeated merge, so we need a system that can handle them efficiently.

Here's how to set up such an environment using ​Mercurial:

Initial Setup

$ svn checkout http://svn.edgewall.org/repos/trac/branches/0.11-stable/ guide-0.11
$ cd guide-0.11
$ hg init
$ cp /tmp/trac.hgignore .hgignore
$ hg addremove
$ hg commit -m "Start sync with branch 0.11-stable [T70xx]"
$ (cd trac/wiki/default-pages; python ../../../contrib/checkwiki.py -d)
$ hg branch wiki-guide   # (1)
$ hg commit -m "Those are the un-processed changes from t.e.o wiki"
$ hg update -C 1         # (2)
$ hg branch repo-guide   # (3)
$ hg merge wiki-guide

Notes:

1. mark the future commit to be on named branch "wiki-guide", the symbolic name for the branch tracking the raw changes made by contributors in the t.e.o wiki
2. switch back to revision 1, the one which was in sync with the branch
3. mark the future commit to be on named branch "repo-guide", the symbolic name for the branch tracking the changes we will commit in the svn branch

Now at this point, carefully review the changes and revert everything you don't want to see merged in the repository. This is the tedious part, but once you've taken a decision to not merge some changes, you won't be asked to take this decision over and over again in future merges.

Once you're happy with how the changes look like, commit them:

Commit Changes

$ hg ci -m "Merged contributions (2008-05-08)"
$ svn ci -m "TracGuide [milestone:0.11]: sync changes from the wiki (2008-05-08)"

While there's a timestamp anyway associated to the changeset, I find it convenient to put the date prominently in the commit message as well.

Now, the interesting things begin. Next time you decide to sync, things will be quite easy:

Repeat Merge

$ cd guide-0.11
$ hg update -C wiki-guide
$ (cd trac/wiki/default-pages; python ../../../contrib/checkwiki.py -d)
$ hg ci -m "Downloaded changes 2008-05-09"
$ hg update -C repo-guide
$ hg merge wiki-guide

At this point, you will have only the new changes in your repository. Review them. If there's a need to "forget" some changes that only make sense on t.e.o, you can use hg revert trac/wiki/default-pages/TracTickets. If there's a typo or a wrong information, then take this occasion to fix it in the Wiki itself, then restart the above procedure (back on the "wiki-guide" branch, get new changes you just did on t.e.o, commit, switch to "repo-guide" and merge again).

Once you're happy, commit the changes both locally on the "repo-guide" integration branch and on the 0.11-stable branch.