{
    "mode": "perldoc",
    "parameter": "Text::WikiFormat::Blocks",
    "section": "",
    "url": "https://www.chedong.com/phpMan.php/perldoc/Text%3A%3AWikiFormat%3A%3ABlocks/json",
    "generated": "2026-06-13T05:51:14Z",
    "synopsis": "None. Use Text::WikiFormat as the public interface, unless you want to create your own block\ntype.",
    "sections": {
        "NAME": {
            "content": "Text::WikiFormat::Blocks - blocktypes for Text::WikiFormat\n",
            "subsections": []
        },
        "SYNOPSIS": {
            "content": "None. Use Text::WikiFormat as the public interface, unless you want to create your own block\ntype.\n",
            "subsections": []
        },
        "DESCRIPTION": {
            "content": "This module merely creates subclasses of Text::WikiFormat::Block, which is the interesting code.\nA block is a collection of related lines, such as a code block (text to display verbatim in a\nmonospaced font), a header, an unordered list, an ordered list, and a paragraph (text to display\nin a proportional font).\n\nEvery block extends \"Text::WikiFormat::Block\".\n",
            "subsections": []
        },
        "METHODS": {
            "content": "The following methods exist:\n\n*   \"new( %args )\"\n\nCreates and returns a new block. The valid arguments are:\n\n*   \"text\"\n\nThe text of the line found in the block.\n\n*   \"args\"\n\nThe arguments captured by the block-identifying regular expression.\n\n*   \"level\"\n\nThe level of indentation for the block (usually only useful for list blocks).\n\n*   \"tags\"\n\nThe tags in effect for the current type of wiki formatting.\n\n*   \"opts\"\n\nThe options in effect for the current type of wiki formatting.\n\nUse the accessors of the same names to retrieve the values of the attributes.\n\n*   \"addtext( @linesoftext )\"\n\nAdds a list of lines of text to the current text for the block. This is very useful when you\nencounter a block and want to merge it with the previous block of the same type\n\n*   \"addargs( @arguments )\"\n\nAdds further arguments to the block; useful when merging blocks.\n\n*   \"formattedtext()\"\n\nReturns text formatted appropriately for this block. Blocks don't have to have formatters,\nbut they may.\n\n*   \"formatter( $lineoftext )\"\n\nFormats the $line using \"Text::WikiFormat::formatline()\". You can add your own formatter\nhere; this is worth overriding.\n\n*   \"merge( $nextblock )\"\n\nMerges the current block with $nextblock (the next block encountered) if they're of the\nsame type and are at the same level. This adds the text and args of $nextblock to the\ncurrent block. It's your responsibility to remove $nextblock from whatever your code\niterates over.\n\n*   \"nests()\"\n\nReturns true if this block should nest (as in lists and unordered lists) for the active wiki\nformatting.\n\n*   \"nest( $nextblock )\"\n\nNests $nextblock under this block if the both nest and if $nextblock has a level greater\nthan the current block. This actually adds $nextblock as a text item within the current\nblock. Beware.\n",
            "subsections": []
        },
        "AUTHOR": {
            "content": "chromatic, \"chromatic at wgz dot org\"\n",
            "subsections": []
        },
        "BUGS": {
            "content": "No known bugs.\n",
            "subsections": []
        },
        "COPYRIGHT": {
            "content": "Copyright (c) 2006, chromatic. Some rights reserved.\n\nThis module is free software; you can use, redistribute, and modify it under the same terms as\nPerl 5.8.x.\n",
            "subsections": []
        }
    },
    "summary": "Text::WikiFormat::Blocks - blocktypes for Text::WikiFormat",
    "flags": [],
    "examples": [],
    "see_also": []
}