/ 
Tk-Markdown-0.08
River stage one • 1 direct dependent • 3 total dependents
/ Tk::Markdown

NAME

Tk::Markdown - display Markdown in a Text

SYNOPSIS

use Tk;
use Tk::Markdown;

my $mw = Tk::MainWindow->new();
my $mdt = $mw->Markdown();

my $markdown = q~# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6

* list 1
** list 2
*** list 3
**** list 4
***** list 5
****** list 6

    Source shown in monofont
    another line of source code here
~;

$mdt->insert('0.0', $markdown);

DESCRIPTION

Tk::Markdown is a widget to render Markdown in a Tk::Text widget.

METHODS

insert

Whenever insert is called on the Markdown widget, some translation is done on the text in order to display it nicely as Markdown. Tables are reformatted (if the line starts with a bar) and headers are tagged with different fonts.

This module has very basic support for Markdown and there is still plenty to do, e.g. links, images, etc.

defaultStyles

Called internally. You can access the styles like this:

use Data::Dumper;
print Dumper $o->{styles};

To set styles, use $o->setStyles

setStyles

The argument is a hash of styles. The keys are predefined names, currently:

body
h1
h2
h3
h4
h5
h6
code
list

And the values are listrefs, in which the first element is the -foreground color, and the remainder are options for the Tk::Font object. For example:

$o->setStyles(
    'h1' => [ qw/ red -family Times -weight bold -size 32 / ],
)

FormatMarkdown

This is called internally. It prettifies Markdown prior to insertion.

<% Perl code here %> is interpreted here. So if you want to have Perl code that results in formatted Markdown, you'll need to put it inside <% %> (as opposed to the <? ?> that will get run by Tk::MarkdownTk)

FormatMarkdownTable

This is called internally. It prettifies Markdown tables.

PaintMarkdown

This is called internally. It applies the styles.

clipEvents

This copied directly from Tk::ROText.

ClassInit

This is copied directly from Tk::ROText.

Populate

This is copied and modified from Tk::ROText. The modification is the addition of a call to setDefaultStyles. That's all.

Tk::Widget::ScrlMarkdown

Copied and adapted from Tk::ROText.

SEE ALSO

Tk::MarkdownTk, Tk::Text

AUTHOR

Jimi Wills.

Currently maintained by Alexander Becker.

BUGS

Known issue: Tables do not work.

Please report any bugs or feature requests via GitHub: https://github.com/asb-capfan/Tk-Markdown

SUPPORT

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

perldoc Tk::Markdown

You can also look for information at:

LICENSE AND COPYRIGHT

Copyright 2013 JimiWills.

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.