Tracing activeRenderer code
Last updated: 1/28/04; 1:07:27 AM by MB
The following is a list of what activeRenderer's code does at installation and uninstallation time, as well as when weblog template modifications are requested.
It is intended as a debugging aid in the (very unlikely now, but let's face it, still possible) event that aR does something unexpected to your weblog. All these steps are identified with comments in activeRenderer's code, the relevant part, folder and file names are in italic.
When Radio starts : activeRendererSuite.instal.
1: Instals a prefs.activeRenderer user preferences table in weblogData.root.
2: Instals a call to the activeRenderer rendering code in user.html.renderers (Radio.root).
3: Checks Radio's application Macros subfolder for any installation of pre-1.0 aR related macros and deletes those.
4: Instals calls to all aR macros in user.html.macros (Radio.root). Those macros currently are :
activeRendererHeader,
activeRendererFunctions,
espressoCup,
storyBox,
nodeFormat,
nodeState,
daySwitch,
opmlRender,
activeRoll,
activeRendererLogo,
rssBox.
5: Makes sure there is a mySubscriptions.opml file creates in the gems folder.
6: Instals all callbacks necessary to maintain an opml image of the aggregator:
postScan
subscribeService
unsubscribeService
7: Creates a complete activeRenderer folder in the www folder.
8: Creates a complete outlines folder in www.
9: Creates a complete opml folder in www.
10: Creates activeRenderer, outlines and opml folders for all categories upstreamed to a site different from the main weblog public site.
11: If it finds it and the autoUpstream preference is checked, copies the instant outline OPML file to www/outlines for immediate rendering.
12: Synchronizes bookmarks outline if bookmarks.keepSynched is checked.
13: Creates or updates myOutlines.opml if autoDir is checked.
14: Creates a specialized copy of mySubscriptions.opml in activeRenderer/local if it is missing.
15: Creates aggregator.opml in activeRenderer/local if it is missing and outlineAggregator is checked.
16: Downloads topicsRoll file from the W4 server into activeRenderer/local/w4.
NB: Up to this point, none of the templates involved in weblog publication have been modified.
17: Only if outlineWeblog is checked (it is not by default), modifies the main weblog's templates if needed.
17.1: Updates www/#homeTemplate.txt to insert calls to the activeRendererHeader and daySwitch macro.
If the displayLatest preference is false, the call to daySwitch is commented out.
The previous version is archived in www/activeRenderer/local/backup.
this is all part of activeRendererSuite.utils.checkHomeTemplate.
17.2: Updates www/#dayTemplate.txt if a newer version is available and the current #dayTemplate.txt is already an aR generated template.
The previous version is archived in www/activeRenderer/local/backup.
17.3: Updates www/#itemTemplate.txt if a newer version is available and the current #itemTemplate.txt is already an aR generated template.
The previous version is archived in www/activeRenderer/backup.
18: Updates the desktop website templates according to the activeMenu pref.
19: Instals the uninstallation code in scratchpad.activeRenderer (Radio.root).
20: Instals a user.rootUpdates.servers.activeRenderer update parameters table in Radio.root.
21: Instals a distribution repository if autoDist pref is set.
22: Updates activeRenderer if the tool is registered and if autoUpdate is checked.
Most iinstallation steps are logged into Radio's Event Log.
When you check the 'Outline publication dates' option in aR's preferences page : activeRendererSuite.ui.preferences.edit.
1: A call to the activeRendererHeader and daySwitch macros are inserted in the www/#homeTemplate.txt template if they are not already there.
If #homeTemplate.txt must be modified at all, the original version is first backed up to www/activeRenderer/local/backup.
The call to daySwitch is commented out if the displayLatest preference is false.
Steps 1 is part of activeRendererSuite.utils.checkHomeTemplate.
2: A number of global variable declarations are added to www/#prefs.txt if they are missing.
If #prefs.txt must be modified at all, the original version is first backed up to www/activeRenderer/local/backup.
Steps 2 is part of activeRendererSuite.utils.checkPrefs.
3: Any non outlined version of www/#dayTemplate.txt is backed up to www/activeRenderer/local/backup, then replaced by an outlined style version.
The new version is either the tool's default, or your customized version if it is found in www/activeRenderer/local/backup/custom.
When you check the 'Outline individual posts' preference (it's possible only if 'Outline publication dates' is already checked) : activeRendererSuite.ui.preferences.edit.
Any non outlined version of www/#itemTemplate.txt is backed up to www/activeRenderer/local/backup, then replaced by an outlined style version.
The new version is either the tool's default, or your customized version if it is found in www/activeRenderer/local/backup/custom.
When you uncheck the 'Outline individual posts' preference : activeRendererSuite.ui.preferences.edit.
1: If the current www/#itemTemplate.txt file is an outlined style version, and its version number is higher than aR's default, it is backed up to www/activeRenderer/local/backup/custom.
2: If a non outlined version of #itemTemplate.txt exists in www/activeRenderer/local/backup, it is copied to www and replaces the current version.
When you uncheck the 'Outline publication dates' option in aR's preferences page : activeRendererSuite.ui.preferences.edit.
1: If the current www/#dayTemplate.txt file is an outlined style version, and its version number is higher than aR's default, it is backed up to www/gems/activeRenderer/local/backup/custom.
2: If a non outlined version of #dayTemplate.txt exists in www/activeRenderer/local/backup, it is copied to www and replaces the current version.
3: Same thing happens for #itemTemplate.txt.
4: The 'Outline individual posts' option is automatically unckecked.
5: The daySwitch macro call in www/#homeTemplate.txt is commented out if it was not.
When you select the Tools / activeRenderer / Uninstal menu option, or if you deselect activeRenderer in Radio's local Tools page, or if you move the activeRenderer.root file out of Radio's Tools folder.
Restores the original, non outlined templates in www if any outline weblog style was in use and if the original non outlined templates are found in www/activeRenderer/local/backup.
When you move the activeRenderer.root file out of Radio's Tools folder: scratchpad.activeRenderer.uninstal and scratchpad.activeRenderer.cleanup.
1: Restores the original #prefs.txt from www/activeRenderer/local/backup to www if it finds it.
2: Moves the activeRenderer folder out of the www folder and into the Radio Userland/activeRendererUninstalled folder.
3: Deletes links to aR macros in user.html.macros (Radio.root)
4: Deletes link to activeRenderer's rendering code in user.html.renderer (Radio.root)
5: Deletes aR's update parameters table from user.rootUpdates.servers (Radio.root)
6: Removes aR's preferences table from prefs in webLogData.root.
7: Remove uninstallation code from scratchpad in Radio.root.
