webschuur.com

Sympal Scripts Premature manual

It is a bit strange to write a manual before the features in that manual are all implemented, but I think it is an interesting workflow, to start off with documentation, because it gives me (developer) and my audience (potential users) a clear view of what Sympal Scripts will do. And it shows a clear todo for me too. Below are the common usage parameters and usage concepts. In reality some of the commands can take a lot of advanced parameters in addition to the listed command parameters.

Usage:

install.php        Install new features in a multisite, or a new site.
 --type [site|module|theme]        Site installs a new multisite. Module installs a new module
 --variables site=example.com user=Joe email=joe@example.com etc.
                             A name=value list of variables needed for installation of the module or site. Provide none to see a list of required values.
 --fixtures directory-name   Use the fixtures in the directory directory-name to preconfigure the site.
 --dry-run                   Don't write anything, just output information
 --verbose                   Be more verbose



generate.php       Generate code in a multisite. To get you rolling faster.
 --type [scaffold|node|block|view|theme|...]
                             Provide the type of code that will be generated, can be any type for wich a template is available.
 --variables name=foo value=bar
                             A name=value list of variables needed for generation of the module. Provide none to see a list of required values.
 --list                      Shows the available types that can be generated.

sympal.php         Sympal script utilities
 --configure                 Initialise and/or (re-)configure the sympal environment.
 --install                   Grab the latest sympal version.
 --update [0.1|0.5|1.0.2|1.0.3|trunk]
                             Upgrade sympal and the codebase to a new version. If value is omitted, it upgrades to the latest stable release. Use with care, because it will NOT upgrade your sites and their data, possibly leaving you with broken sites and angry clients.

administrate.php   General administrative tasks on a multiste.
 --type [reset_su_pw|...]        (Re)sets the SuperUser password.
 --variables name=foo value=bar A name=value list of variables needed for the specified administrative task. Provide none to see a list of required values.
 --list                      Shows a list of avaialable administration tasks.

information.php    Show information from a site or the system.
 --site www.example.com      Show details from this site only. If omitted information about the system will be displayed.
 --list                      Return a list of all available sites, handy for scripting.
 --settings                  Show the general scripts settings.
 --environment               Show information about your environment, such as apache details, Drupal version, php version etc.

stage.php
 --site www.example.com      The site that will be staged.
 --stage [dev|test|live]     What stage to move the site to.

extract.php        Create fixtures from a site.
 --site www.example.com      The site to extract.
 --fixtures  directory-name  Write the fixtures to the directory directory-name.

backup.php         Create a backup. Not the same as fixtures, because fixtures contain far less information.
 --site www.example.com      The site to backup.
 --all                       Backup all sites, instead of only one.
 --full                      Backup all data. (same as --database --files --codebase).
 --database                  Dump the database.
 --files                     Backup the uploaded files.
 --codebase                  Backup the codebase with it (when the user wishes to leave, for example).

cron.php           Invoke a cron-run on a Drupal site.
 --site www.example.com     Call Drupals cron.php for the provided site. It must be available as multisite.
 --all                      Run the cron of all multisite sites found under /sites
 --drupal_dir               Where your drupal codebase is located. Optional

drupal.php         Include the full Drupal code in your PHP session.
 --site www.example.com     Includes the Drupal site www.example.com, for your own scripting fun.

And then the million € question: what is implemented? Not even half! And even that uses other, or not yet so structured parameters or consistent filenames.

• Installation: Can install modules and sites, the parameters are very inconsistent (though complete). Needs work to make it consistent.
• Sympal: Completely and utter vapour. NULL, Nil, Foo, void().
• Administrate: Can only reset the superuser password at the moment.
• Cron: Finished. Works as stated.
• Drupal: Finished. You can include a Drupal site in any PHP script, or call it for a certain site on the commandline with the parameter —site.
• Extract: In development.
• Stage: In development.
• Information: Not existing at all. Not even started :)
• Backup: In development.