/ 
Text-Spintax-0.06
River stage zero No dependents
/ Text::Spintax

NAME

Text::Spintax - A parser and renderer for spintax formatted text.

VERSION

Version 0.06

SYNOPSIS

use Text::Spintax;

my $node = Text::Spintax->new->parse("This {is|was|will be} some {varied|random} text");
$node->equal_path_weight;
my $text = $node->render;

DESCRIPTION

Text::Spintax implements a parser and renderer for spintax formatted text. Spintax is a commonly used method for generating "randomized" text. For example,

This {is|was} a test

would be rendered as

* This is a test
* This was a test

Spintax can be nested indefinitely, for example:

This is nested {{very|quite} deeply|deep}.

would be rendered as

* This is nested very deeply.
* This is nested quite deeply.
* This is nested deep.

The number of possible combinations is easy to calculate, but the proportion of renders has two options. The initial Text::Spintax::RenderNode has weight 1 for all nodes, meaning that for the previous example the probabilities of each render would be

25% This is nested very deeply.
25% This is nested quite deeply.
50% This is nested deep.

If you want every possible outcome to be equally likely, then call equal_path_weight on the Text::Spintax::RenderNode object and you'll get this outcome:

33% This is nested very deeply.
33% This is nested quite deeply.
33% This is nested deep.

SUBROUTINES/METHODS

new

Returns a Text::Spintax object

parse

Parses the spintax and returns a Text::Spintax::Node that is suitable for rendering.  Returns undef if the spintax couldn't be parsed.

AUTHOR

Dale Evans, <daleevans@github> http://devans.mycanadapayday.com

BUGS

Please report any bugs or feature requests to bug-text-spintax at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Text-Spintax. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Text::Spintax

You can also look for information at:

ACKNOWLEDGEMENTS

Francois Desarmenien <francois@fdesar.net> for writing Parse::YAPP Philippe Verdret for writing Parse::Lex

LICENSE AND COPYRIGHT

Copyright 2013 Dale Evans.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The Parse::Yapp module and its related modules and shell scripts are copyright (c) 1998-2001 Francois Desarmenien, France. All rights reserved.

You may use and distribute them under the terms of either the GNU General Public License or the Artistic License, as specified in the Perl README file.