CDR Tickets

BZDATETIME::2012-05-30 17:18:02
BZCOMMENTOR::Volker Englisch
BZCOMMENT::1

(In reply to comment #0)
> The existing documentation describes a process that has since been partially
> replaced with a new approach.
>
> We need documentation describing the new approach, including:
>
> Create a new filter.
> Install it on a server.
> View it.
> Compare instances on two servers.
> Update it.
> Promote it from development to test and production.

I've created documentation for our three new filter tools CreateNewFilter.py, InstallFilter.py, and UpdateFilter.py. This documentation is part of the system documentation named "Creating and Updating Filters on the Server":
http://bach.nci.nih.gov/cgi-bin/cdr/Filter.py?DocId=CDR0000256463&Filter=name:Documentation+Help+Screens+Filter

Viewing and comparing filters has not changed and the documentation for this is still valid. However, I've removed parts from this document that were outdated:
http://bach.nci.nih.gov/cgi-bin/cdr/Filter.py?DocId=CDR0000256859&Filter=name:Documentation+Help+Screens+Filter

This is ready for review.

BZDATETIME::2012-05-31 14:25:24
BZCOMMENTOR::Alan Meyer
BZCOMMENT::2

The revised filter documentation looks clear and complete to me.
Some very minor additions or changes that might be useful are:

In the "Creating and Updating Filters on the Server" document:

Add a note to "Installing a filter" and to "Editing a filter"
to indicate that the filenames passed to these programs
should reference a file in CdrDoc format, i.e., an XSLT
filter as a CDATA section wrapped with a CdrDoc wrapper.

Add a note about version control. In addition to creating a
version in the CDR it is also important to create a version
in the subversion repository. The filename in subversion
should match the production (Bach) CDRnnnnnnnnnn.xml filename
used in the CDR.

In the "Notes on filter sources", you might want to add me to
the Global change filters list, or perhaps just delete that
section since information about who is maintaining any filter
should be available both in the CDR document history and in
the subversion log, if not in the comment header on the
filter.

The documentation for Managing Filters looks fine to me. The
only conceivable change I can think of, and it's insignificant
is:

Change:

"Access the Administrative Subsystem from the CDR Toolbar, the
CDR menu ..."

To:

"Access the Administrative Subsystem from the XMetal CDR
Toolbar or CDR menu, ..."

BZDATETIME::2012-06-04 17:44:41
BZCOMMENTOR::Volker Englisch
BZCOMMENT::3

I've made those changes.

Please review and close this bug.

BZDATETIME::2012-06-21 21:03:22
BZCOMMENTOR::Alan Meyer
BZCOMMENT::4

Looks fine to me. I'm marking it verified-fixed.

BZDATETIME::2012-06-22 16:29:52
BZCOMMENTOR::Volker Englisch
BZCOMMENT::5

If you don't mind I'll go a step further and mark it as Closed.