WWP Directories

WWP directory structure

Directory	Function	Who can edit
under_construction	texts being captured and proofread	all
renovation	texts being renovated and proofread	all
on_deck/	texts proofed, ready to go online	staff
distribution/	texts published to subscribers	no one (move into improvement)
improvement/	texts with post-release corrections	all
special/	hand-tweaked copies of published texts	staff

The life cycle of WWP textbase files

1. When texts are being renovated or transcribed, they live in renovation/ or under_construction/. They stay there as long as they are being actively modified by encoders, reviewers, etc., and until they are deemed to be in a publishable state. Typically this means until the Textbase Editor or designee has completed the final checking round of second proofing.
2. When a text reaches a publishable state, i.e., after the second checking round, it is moved into on_deck/. This tells the Electronic Publications Editor (Paul) that the text is ready to be processed by the vast Electronic Luberication Empire. At this point, working within on_deck/, Paul does whatever extra checks, fixes, etc. he needs to do before the text is processed into its various specific publication forms. (He does not do any dynaWeb-specific alterations here.)
3. When these changes are all made, Paul moves the files into distribution/, leaving on_deck/ empty. On_deck/ thus functions purely as a transitional staging area, not a storage location. When it's got things in it, that means they need attention and mandate an update of distribution/ and the derived files. It is during this move that the derived files will be generated and placed into their respective homes. This is also the time when the publication date and version number are updated.
4. The contents of distribution/ are thus the complete set of XML files which we have vetted and now regard as in distributable form. These are the files from which our generated files have been derived and they are in a sense master copies. Once a file has been moved to distribution/, a copy of that file will remain in distribution/ unless we find out something about it which causes us to retract our imprimatur (e.g. it's based on a corrupt edition; it has a bad error in it which will take time to fix and which renders it utterly unfit for public consumption).
5. When we want to make an update to a file in distribution/, we copy it to improvement/ (leaving a copy for continued use in distribution/) and make any required changes, updates, corrections, etc. Once these are completed, the file is moved back into on_deck/, indicating that the files derived from it need to be regenerated. When the file in on_deck/ is processed, the new version replaces the previous version in distribution/ (and also any previous versions in the parallel/ directory structure).

Commands

When you issue these commands, it's easiest if you are in the directory where the file is currently located. The word "filename" below should be replaced with the complete filename of the file you're moving. Tab completion won't work, so you have to type the full name out.

To move files into on_deck/ from anywhere: M-! tb_event.perl --promote filename

To copy files from distribution/ into improvement/: M-! tb_event.perl --improve filename