{
    "content": [
        {
            "type": "text",
            "text": "# Pod::ParseLink (perldoc)\n\n## NAME\n\nPod::ParseLink - Parse an L<> formatting code in POD text\n\n## SYNOPSIS\n\nuse Pod::ParseLink;\nmy $link = getlink();\nmy ($text, $inferred, $name, $section, $type) = parselink($link);\n\n## DESCRIPTION\n\nThis module only provides a single function, parselink(), which takes the text of an L<>\nformatting code and parses it. It returns the anchor text for the link (if any was given), the\nanchor text possibly inferred from the name and section, the name or URL, the section if any,\nand the type of link. The type will be one of \"url\", \"pod\", or \"man\", indicating a URL, a link\nto a POD page, or a link to a Unix manual page.\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **AUTHOR**\n- **COPYRIGHT AND LICENSE**\n- **SEE ALSO**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "Pod::ParseLink",
        "section": "",
        "mode": "perldoc",
        "summary": "Pod::ParseLink - Parse an L<> formatting code in POD text",
        "synopsis": "use Pod::ParseLink;\nmy $link = getlink();\nmy ($text, $inferred, $name, $section, $type) = parselink($link);",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 4,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 37,
                "subsections": []
            },
            {
                "name": "AUTHOR",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "COPYRIGHT AND LICENSE",
                "lines": 5,
                "subsections": []
            },
            {
                "name": "SEE ALSO",
                "lines": 5,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "Pod::ParseLink - Parse an L<> formatting code in POD text\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "use Pod::ParseLink;\nmy $link = getlink();\nmy ($text, $inferred, $name, $section, $type) = parselink($link);\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "This module only provides a single function, parselink(), which takes the text of an L<>\nformatting code and parses it. It returns the anchor text for the link (if any was given), the\nanchor text possibly inferred from the name and section, the name or URL, the section if any,\nand the type of link. The type will be one of \"url\", \"pod\", or \"man\", indicating a URL, a link\nto a POD page, or a link to a Unix manual page.\n\nParsing is implemented per perlpodspec. For backward compatibility, links where there is no\nsection and name contains spaces, or links where the entirety of the link (except for the anchor\ntext if given) is enclosed in double-quotes are interpreted as links to a section (L</section>).\n\nThe inferred anchor text is implemented per perlpodspec:\n\nL<name>         =>  L<name|name>\nL</section>     =>  L<\"section\"|/section>\nL<name/section> =>  L<\"section\" in name|name/section>\n\nThe name may contain embedded E<> and Z<> formatting codes, and the section, anchor text, and\ninferred anchor text may contain any formatting codes. Any double quotes around the section are\nremoved as part of the parsing, as is any leading or trailing whitespace.\n\nIf the text of the L<> escape is entirely enclosed in double quotes, it's interpreted as a link\nto a section for backward compatibility.\n\nNo attempt is made to resolve formatting codes. This must be done after calling parselink()\n(since E<> formatting codes can be used to escape characters that would otherwise be significant\nto the parser and resolving them before parsing would result in an incorrect parse of a\nformatting code like:\n\nL<verticalE<verbar>barE<sol>slash>\n\nwhich should be interpreted as a link to the \"vertical|bar/slash\" POD page and not as a link to\nthe \"slash\" section of the \"bar\" POD page with an anchor text of \"vertical\". Note that not only\nthe anchor text will need to have formatting codes expanded, but so will the target of the link\n(to deal with E<> and Z<> formatting codes), and special handling of the section may be\nnecessary depending on whether the translator wants to consider markup in sections to be\nsignificant when resolving links. See perlpodspec for more information.\n",
                "subsections": []
            },
            "AUTHOR": {
                "content": "Russ Allbery <rra@cpan.org>\n",
                "subsections": []
            },
            "COPYRIGHT AND LICENSE": {
                "content": "Copyright 2001, 2008, 2009, 2014, 2018-2019 Russ Allbery <rra@cpan.org>\n\nThis program is free software; you may redistribute it and/or modify it under the same terms as\nPerl itself.\n",
                "subsections": []
            },
            "SEE ALSO": {
                "content": "Pod::Parser\n\nThe current version of this module is always available from its web site at\n<https://www.eyrie.org/~eagle/software/podlators/>.\n",
                "subsections": []
            }
        }
    }
}