{
    "content": [
        {
            "type": "text",
            "text": "# Locale::Maketext::Extract::Plugin::YAML (perldoc)\n\n## NAME\n\nLocale::Maketext::Extract::Plugin::YAML - YAML format parser\n\n## SYNOPSIS\n\n$plugin = Locale::Maketext::Extract::Plugin::YAML->new(\n$lexicon            # A Locale::Maketext::Extract object\n@filetypes         # Optionally specify a list of recognised file types\n)\n$plugin->extract($filename,$filecontents);\n\n## DESCRIPTION\n\nExtracts strings to localise from YAML files.\n\n## Sections\n\n- **NAME**\n- **VERSION**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **SHORT PLUGIN NAME**\n- **VALID FORMATS**\n- **KNOWN FILE TYPES**\n- **REQUIRES**\n- **NOTES**\n- **SEE ALSO**\n- **AUTHORS**\n- **COPYRIGHT**\n- **COPYRIGHT AND LICENSE**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "Locale::Maketext::Extract::Plugin::YAML",
        "section": "",
        "mode": "perldoc",
        "summary": "Locale::Maketext::Extract::Plugin::YAML - YAML format parser",
        "synopsis": "$plugin = Locale::Maketext::Extract::Plugin::YAML->new(\n$lexicon            # A Locale::Maketext::Extract object\n@filetypes         # Optionally specify a list of recognised file types\n)\n$plugin->extract($filename,$filecontents);",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "VERSION",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 7,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SHORT PLUGIN NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "VALID FORMATS",
                "lines": 29,
                "subsections": []
            },
            {
                "name": "KNOWN FILE TYPES",
                "lines": 4,
                "subsections": []
            },
            {
                "name": "REQUIRES",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "NOTES",
                "lines": 7,
                "subsections": []
            },
            {
                "name": "SEE ALSO",
                "lines": 13,
                "subsections": []
            },
            {
                "name": "AUTHORS",
                "lines": 4,
                "subsections": []
            },
            {
                "name": "COPYRIGHT",
                "lines": 20,
                "subsections": []
            },
            {
                "name": "COPYRIGHT AND LICENSE",
                "lines": 6,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "Locale::Maketext::Extract::Plugin::YAML - YAML format parser\n",
                "subsections": []
            },
            "VERSION": {
                "content": "version 1.00\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "$plugin = Locale::Maketext::Extract::Plugin::YAML->new(\n$lexicon            # A Locale::Maketext::Extract object\n@filetypes         # Optionally specify a list of recognised file types\n)\n\n$plugin->extract($filename,$filecontents);\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "Extracts strings to localise from YAML files.\n",
                "subsections": []
            },
            "SHORT PLUGIN NAME": {
                "content": "yaml\n",
                "subsections": []
            },
            "VALID FORMATS": {
                "content": "Valid formats are:\n\n*\nkey: \"string\"\n\n*\nkey: 'string'\n\n*\nkey: 'string with embedded 'quotes''\n\n*\nkey: |-\n'my folded\nstring\nto translate'\n\nNote, the left hand side of the folded string must line up with the \"\", otherwise YAML adds\nspaces at the beginning of each line.\n\n*\nkey: |-\n'my block\nstring\nto translate\n'\nNote, you must use the trailing C<-> so that YAMl doesn't add a carriage\nreturn after your final quote.\n",
                "subsections": []
            },
            "KNOWN FILE TYPES": {
                "content": ".yaml\n.yml\n.conf\n",
                "subsections": []
            },
            "REQUIRES": {
                "content": "YAML\n",
                "subsections": []
            },
            "NOTES": {
                "content": "The docs for the YAML module describes it as alpha code. It is not as tolerant of errors as\nYAML::Syck. However, because it is pure Perl, it is easy to hook into.\n\nI have seen it enter endless loops, so if xgettext.pl hangs, try running it again with\n\"--verbose --verbose\" (twice) enabled, so that you can see if the fault lies with YAML. If it\ndoes, either correct the YAML source file, or use the filetypes to exclude that file.\n",
                "subsections": []
            },
            "SEE ALSO": {
                "content": "xgettext.pl\nfor extracting translatable strings from common template systems and perl source files.\n\nYAML\nLocale::Maketext::Lexicon\nLocale::Maketext::Extract::Plugin::Base\nLocale::Maketext::Extract::Plugin::FormFu\nLocale::Maketext::Extract::Plugin::Perl\nLocale::Maketext::Extract::Plugin::TT2\nLocale::Maketext::Extract::Plugin::Mason\nLocale::Maketext::Extract::Plugin::TextTemplate\nLocale::Maketext::Extract::Plugin::Generic\n",
                "subsections": []
            },
            "AUTHORS": {
                "content": "*   Clinton Gormley <drtech@cpan.org>\n\n*   Audrey Tang <cpan@audreyt.org>\n",
                "subsections": []
            },
            "COPYRIGHT": {
                "content": "Copyright 2002-2013 by Audrey Tang <cpan@audreyt.org>.\n\nThis software is released under the MIT license cited below.\n\nThe \"MIT\" License\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software\nand associated documentation files (the \"Software\"), to deal in the Software without\nrestriction, including without limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the\nSoftware is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or\nsubstantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING\nBUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\nNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,\nDAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n",
                "subsections": []
            },
            "COPYRIGHT AND LICENSE": {
                "content": "This software is Copyright (c) 2014 by Audrey Tang.\n\nThis is free software, licensed under:\n\nThe MIT (X11) License\n",
                "subsections": []
            }
        }
    }
}