Installation & requirements
Requirements
Before continuing, you should read and understand the Read me page.
But if you don’t like reading instructions, you can go directly to the download page.
Multidoc was developed on Textpattern version 4.0.8, and may not have been tested on prior versions. Ongoing development is under Textpattern version 4.2.0.
The two plugins on which it is based, soo_multidoc and the soo_txp_obj library, were developed under PHP version 5.2.6 and require PHP version 5 or higher. You can find your server’s PHP version in the Txp Diagnostics tab. Most web hosts support PHP 5 but it may not be your default configuration.
Multidoc needs one of your precious custom fields for its very own.
Upgrading to v1.0.b.2
This is a minor update to provide compatibility with the new soo_plugin_pref preference management system. v1.0.b.2 is no longer compatible with the clunky old soo_plugin_prefs. This version requires Txp version 4.2.0 or greater.
Upgrading to v1.0.b.1
This version is mainly an adaptation to a major rewrite of the underlying soo_txp_obj library. It requires the new version (also called 1.0.b.1) of the library. Any other plugins using this library (e.g., soo_image) must be upgraded at the same time.
Functionally, this version should be identical to the previous version. However, given the nature of the changes to soo_txp_obj, it is a good idea to test the upgrade in a development environment before deploying to a live site, keeping full backups in case you need to revert quickly.
Installation
In your Txp admin, go to Advanced Preferences and find the custom field section. Type Multidoc (or whatever name you prefer) into an open custom field slot. (If the default names custom1 and custom2 are there and you aren’t using these fields for something else, feel free to clear them and use one of them for Multidoc.) Then scroll down to the bottom of the page and Save.
There are two required plugins and one optional plugin, all available on the download page. Install and activated soo_txp_obj first, then install and activate soo_multidoc. If you already have soo_plugin_pref or soo_txp_obj installed, you don’t need to reinstall unless a newer version is available; note that soo_plugin_pref is not the same as the old soo_plugin_prefs.
There are three preference settings you can change to suit your setup if you have soo_plugin_pref installed. Click the Options link in the plugin list for soo_multidoc. If you have named your custom field something other than “Multidoc”, change that here. If you have a development domain, enter it to help with tracking down errors (see Support for details); enter just the domain, e.g. development.example.com with no “http://” or closing slash. The third preference is whether or not Multidoc interior pages (i.e., pages other than article Start pages) should appear in article lists (e.g. section front pages or category-based article lists; this does not affect Txp search results). If you made changes, click Save.
That’s it for installation. Now you’re ready to begin assembling your first Multidoc collection: Arranging content
Posted 2009-01-26 (modified 2010-07-12)
