debian man page for template::plugin::yaml

Query: template::plugin::yaml

OS: debian

Section: 3pm

Format: Original Unix Latex Style Formatted with HTML and a Horizontal Scroll Bar

Template::Plugin::YAML(3pm)				User Contributed Perl Documentation			       Template::Plugin::YAML(3pm)

NAME
Template::Plugin::YAML - Plugin interface to YAML
SYNOPSIS
[% USE YAML %] [% YAML.dump(variable) %] [% YAML.dump_html(variable) %] [% value = YAML.undump(yaml_string) %] [% YAML.dumpfile(filename, variable) %] [% value = YAML.undumpfile(filename) %]
DESCRIPTION
This is a simple Template Toolkit Plugin Interface to the YAML module. A YAML object will be instantiated via the following directive: [% USE YAML %] As a standard plugin, you can also specify its name in lower case: [% USE yaml %]
METHODS
These are the methods supported by the YAML object. dump( @variables ) Generates a raw text dump of the data structure(s) passed [% USE Dumper %] [% yaml.dump(myvar) %] [% yaml.dump(myvar, yourvar) %] dump_html( @variables ) Generates a dump of the data structures, as per "dump", but with the characters <, > and & converted to their equivalent HTML entities, spaces converted to &nbsp; and newlines converted to <br>. [% USE yaml %] [% yaml.dump_html(myvar) %] undump( $string ) Converts a YAML-encoded string into the equivalent data structure. Here's a way to deep-copy a complex structure by completely serializing the data. [% USE yaml; yaml_string = yaml.dump(complex_data_structure); complex_copy = yaml.undump(yaml_string); %] dumpfile( $file, @variables ) Converts the data to YAML encoding, and dumps it to the specified filepath. [% USE yaml; yaml.dumpfile(".storage", my_data) %] undumpfile( $file ) Loads the YAML-encoded data from the specified filepath [% USE yaml; my_data = yaml.undumpfile(".storage") %]
AUTHORS
Richard Clamp <richardc@unixbeard.net>, with undump, undumpfile, and dumpfile implementation by Randal L. Schwartz <merlyn@stonehenge.com> based on Simon Matthews' Template::Plugin::Dumper
COPYRIGHT
Copyright 2003, 2008 Richard Clamp All Rights Reserved. This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
SEE ALSO
Template::Plugin::Dumper perl v5.10.0 2008-12-15 Template::Plugin::YAML(3pm)
Related Man Pages
template::plugin::dumper(3) - suse
template::plugin::dumper(3) - centos
cpan::meta::yaml(3pm) - debian
locale::maketext::extract::plugin::yaml(3pm) - debian
test::yaml::valid(3pm) - debian
Similar Topics in the Unix Linux Community
yeaGTD 18 (Default branch)
yeaGTD 35 (Default branch)
problems iterating in RUBY while extracting info from YAML, Pls help!
Parsing file, yaml file? Extracting specific sections
[TIP] Processing YAML files with yq