Managing FOP Documentation |  print-friendly |
General Information
All raw documentation content is managed in the FOP CVS repository. Updates should be committed to the repository, then the repository files are used to generate usable output. The remaining discussions on this page assume that the CVS repository is the starting place for processing. The path to the documentation is xml-fop/src/documentation/content/xdocs.
Basic documents are stored in XML files, and use DTDs provided by Apache Forrest.
Design Principles
These principles are not written in stone, but reflect the current philosophy, and are documented here primarily to help achieve consistency. These principles should be changed if better or more practical ones are found, but they should probably be discussed and changed by common consent.
Where
- To the extent possible, keep user content separate from developer content, primarily so the user doesn't have to filter out technical information.
- To the extent possible, try to document a topic exactly once, in the place the user is most likely to look for it, then link to that from other locations as appropriate. This is somewhat contrary to the principle above, which should be applied as a higher priority.
When
The documentation and the product are in a constant state of change, and there is some difficulty in deciding what product state the website content should reflect. The current thinking is that the website should reflect the current state of the repository code branch from which releases are made. Features or other documentation that applies to unreleased code should be marked in such a way within the content that the user can determine whether and how it applies to the version they are using. For example, "Feature xyz is first available in Release n.nn.n".
Other approaches were considered, but all seemed to have significantly higher costs both to the users and the developers. From the user's standpoint, the choice is either that they potentially have to look multiple places to get the information they need (which was rejected), or they have to filter out an occasional feature that is in code available subsequent to their release (which was accepted).
Website
Background
The FOP web site and documentation are generated using Apache Forrest.
The following table summarizes the flow of data to the FOP website in chronological order:
| Process | Output | State | View(s) |
|---|---|---|---|
| Developer commits code to FOP repository. | FOP source repository (cvs) at icarus.apache.org/home/cvs/xml-fop | Raw XML and other content | ViewCVS |
| Forrestbot "refresh". Automatically done every six hours. Can be manually refreshed by authorized users at the Forrestbot Web Interface. | Physical location unknown and unimportant to us | web-ready | Content can be viewed here. |
| Forrestbot "publish". Always done manually at the Forrestbot Web Interface. | FOP web repository (cvs) at icarus.apache.org/home/cvs/xml-site/targets/fop | web-ready | ViewCVS |
| Automatic Live Site Update every six hours (midnight, 6am, noon, 6pm Pacific time). | FOP live web site, somewhere on daedalus.apache.org | web-ready | FOP Web Site |
Forrestbot "refresh" Step-by-Step
To manually use the Forrestbot "refresh", simply follow these steps:
- Make sure your changes are committed to the FOP source repository.
- Open http://forrestbot.cocoondev.org in your browser.
- Login.
- In the "Select a module" box, select "xml-fop".
- Click the "refresh" button to have the interim site built. On-screen instructions tell you how to view the log as the build progresses.
Forrestbot "publish" Step-by-Step
To "publish" the Forrestbot output to the FOP Web repository:
- Make sure you are satisfied with the "refreshed" site.
- Open http://forrestbot.cocoondev.org in your browser.
- Login.
- In the "Select a module" box, select "xml-fop".
- Click the "publish" button. On-screen instructions tell you how to view the log as the build progresses.
- Wait for the next 6-hour live-site update cycle and check your changes.
Live Site Update
If there are problems with the live site update (the process of copying the web site contents from the FOP web repository to the live site:
- The CVS update logs can be viewed at http://www.apache.org/~rubys/updatesite.logx, where "x" is a number from 1-4, these four files being the updates done over the past 24 hours. Review the most recent log file for clues.
- The script is maintained by Sam Ruby (rubys@apache.org). Contact him for further help.
Using a Local Forrest
There are some situations where you may want to have a local Forrest installation. For example, you do not want to tie up server resources testing major changes, such as sitemap building, that may require many edit/build/test/debug cycles. After you are done testing, use the forrestbot to "refresh" and "publish" the site.
To use a local Forrest:
- checkout the xml-forrest module (same repository as xml-fop)
- checkout the xml-site/targets/fop module (same repository as xml-fop)
- you will also need access to a current xml-fop sandbox (you probably already have one)
- cd to xml-forrest
- run: build.sh(bat) dist to build forrest
- set environment variable FORREST_HOME=~/xml-forrest/build/dist/shbat where ~ is the directory in which xml-forrest is installed (see http://xml.apache.org/forrest/your-project.html for details)
- set environment variable PATH=$PATH:$FORREST_HOME/bin
- cd to xml-fop directory
- run forrest(.bat), which will build the web-site documents in xml-fop/build/site.
Updating the FOP Web Repository Manually (Deprecated)
- Copy (or sym-link) the documents generated by Forrest (in xml-fop/build/site) to xml-site/targets/fop on your local machine.
- Commit xml-site/targets/fop.
Deleting Documentation Files
The one place where manual updates of the web cvs repository are required is when a document is retired. At this point, it will no longer be generated. However, it will still exist in the web cvs repository. You will need to use a cvs client to remove the files, then commit the changes to keep them from continuing to exist on the live site.
