<<

NAME

Web::Pro::Interact - the user-level interface between the df script and the Web::* modules.

SYNOPSIS

   use Web::Pro::Interact;

DESCRIPTION

A collection of proceedural routines that are run directly by the df script (which does very little processing of it's own). These are essentially the user-level commands that make use of the Web::* modules. This is oriented directly towards working on DF pages ("doomfiles"), even more so than the Web::* modules are. The input format is almost always Rawtext, and the input location is as specified in Web::Definitions as $DF_RAWTEXT. The output format is almost always Html, in the $DF_LOC location, also as specified in Web::Definitions.

These locations can be overridden for testing purposes: a reference to the df scripts hash of options is passed in as the final argument.

EXPORT

None by default.

dummy_testes - echoes arguments to stderr

process_rawtext - given a rawtext filename, converts it to html and splices it into the DF project after the node named in the second argument.

check_links - searches the DF project for broken internal links. This works on $DF_LOC by default (as defined in Web::Definitions), but this can be overriden with the "-h" option. Note: the "-r" option is not meaningful for this method.

push_out - updates the website with the version in the working location (via rsync, etc)

REFERENCE

The %opts hash passed in from df should (as of this writing) have four fields:

  d - debug
  v - verbose
  r - rawtext location (to override default $DF_RAWTEXT)
  h - html location (to override default $DF_LOC) 

SEE ALSO

Project Documentation

AUTHOR

Joseph Brenner, <doom@kzsu.stanford.edu>

COPYRIGHT AND LICENSE

Copyright (C) 2004 by Joseph Brenner

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.2 or, at your option, any later version of Perl 5 you may have available.

BUGS

None reported... yet.

<<