Darren Duncan > Muldis-Rosetta-0.8.0 > Muldis::Rosetta::Engine::Example

Download:
Muldis-Rosetta-0.8.0.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
Report a bug
Module Version: 0.8.0   Source   Latest Release: Muldis-Rosetta-0.15.0

NAME ^

Muldis::Rosetta::Engine::Example - Self-contained reference implementation of a Muldis Rosetta Engine

VERSION ^

This document describes Muldis::Rosetta::Engine::Example version 0.8.0 for Perl 5.

It also describes the same-number versions for Perl 5 of Muldis::Rosetta::Engine::Example::Public::Machine, Muldis::Rosetta::Engine::Example::Public::Process, Muldis::Rosetta::Engine::Example::Public::Value.

SYNOPSIS ^

This documentation is pending.

DESCRIPTION ^

Muldis::Rosetta::Engine::Example, aka the Muldis Rosetta Example Engine, aka Example, is the self-contained and pure-Perl reference implementation of Muldis Rosetta. It is included in the Muldis Rosetta core distribution to allow the core to be completely testable on its own.

Example is coded intentionally in a simple fashion so that it is easy to maintain and and easy for developers to study. As a result, while it performs correctly and reliably, it also performs quite slowly; you should only use Example for testing, development, and study; you should not use it in production. (See the Muldis::Rosetta::SeeAlso file for a list of other Engines that are more suitable for production.)

This Muldis::Rosetta::Engine::Example file is the main file of the Example Engine, and it is what applications quasi-directly invoke; its Muldis::Rosetta::Engine::Example::Public::\w+ classes directly do/subclass the roles/classes in Muldis::Rosetta::Interface. The other Muldis::Rosetta::Engine::Example::\w+ files are used internally by this file, comprising the rest of the Example Engine, and are not intended to be used directly in user code.

This documentation is pending.

INTERFACE ^

Muldis::Rosetta::Engine::Example supports multiple command languages, all of which are official Muldis D dialects. You may supply commands to Example written in any of the following:

Tiny Plain Text Muldis D

See Muldis::D::Dialect::PTMD_Tiny for details.

The language name is specified either as a Perl character string whose value is Muldis_D:'http://muldis.com':'0.43.0':'PTMD_Tiny':{} or as a Perl array whose value is [ 'Muldis_D', 'http://muldis.com', '0.43.0', 'PTMD_Tiny', {} ]. No other version numbers are currently supported.

Tiny Perl Hosted Data Muldis D

See Muldis::D::Dialect::HDMD_Perl_Tiny for details.

The language name is specified either as a Perl character string whose value is Muldis_D:'http://muldis.com':'0.43.0':'HDMD_Perl_Tiny':{} or as a Perl array whose value is [ 'Muldis_D', 'http://muldis.com', '0.43.0', 'HDMD_Perl_Tiny', {} ]. No other version numbers are currently supported.

You may also supply or retrieve data through Example in any of the above.

DIAGNOSTICS ^

This documentation is pending.

CONFIGURATION AND ENVIRONMENT ^

This documentation is pending.

DEPENDENCIES ^

This file requires any version of Perl 5.x.y that is at least 5.8.1, and recommends one that is at least 5.10.0.

It also requires these Perl 5 packages that are bundled with any version of Perl 5.x.y that is at least 5.10.0, and are also on CPAN for separate installation by users of earlier Perl versions: version.

It also requires these Perl 5 classes that are in the current distribution: Muldis::Rosetta::Interface-0.8.0.

INCOMPATIBILITIES ^

None reported.

SEE ALSO ^

Go to Muldis::Rosetta for the majority of distribution-internal references, and Muldis::Rosetta::SeeAlso for the majority of distribution-external references.

BUGS AND LIMITATIONS ^

This documentation is pending.

AUTHOR ^

Darren Duncan (perl@DarrenDuncan.net)

LICENSE AND COPYRIGHT ^

This file is part of the Muldis Rosetta framework.

Muldis Rosetta is Copyright © 2002-2008, Darren Duncan.

See the LICENSE AND COPYRIGHT of Muldis::Rosetta for details.

TRADEMARK POLICY ^

The TRADEMARK POLICY in Muldis::Rosetta applies to this file too.

ACKNOWLEDGEMENTS ^

The ACKNOWLEDGEMENTS in Muldis::Rosetta apply to this file too.