Macros

Flask-Discussion exposes a set of Jinja macros for use in Flask application templates. Note that macros for each system will require specific configuration values.

Helper macro

The helper macro renders the appropriate comment system depending on your configuration. Internally, it calls the system-specific macros in a transparent way. This is useful in case you want to support several comment systems by just modifying the configuration of your application instead of its code.

Available in the flask_discussion/helper.html template.

helper.render_comments()

Render the comment system specified in the DISCUSSION_SYSTEM configuration key. If no valid value is provided, an error will be shown.

Note that this macro accepts any keyword argument and forwards the appropriate values to the system-specific macro called underneath. Therefore, if you intend to support several systems, you should specify all the values that would be required.

Example usage:

{% import "flask_discussion/helper.html" as discussion %}

<html>
    <body>
        {# Specify values used by several comment systems #}
        {{ discussion.render_comments(title="Page title", identifier="my-page", url="http://mypage.com") }}
    </body>
</html>

Disqus macros

These macros integrate Disqus comments into an application.

Available in the flask_discussion/disqus.html template.

disqus.render_comments(identifier, url, title)

Render Disqus comments using the provided parameters and embed the JS client.

Parameters

  • identifier – Unique page identifier (e.g. blog post ID)

  • url – URL of the page

  • title – Title of the page

Example usage:

{% import "flask_discussion/disqus.html" as disqus %}

<html>
    <body>
        {{ disqus.render_comments("my-page", "http://mypage.com", "Page title") }}
    </body>
</html>
disqus.render_comment_count()

Render Disqus comment count.

This should be called before the closing </body> tag. Make sure to include #disqus_thread in the href attribute of the link for which to show the comment count.

Example usage:

{% import "flask_discussion/disqus.html" as disqus %}

<html>
    <body>
        <a href="http://mypage.com#disqus_thread">Comments</a>
        {{ disqus.render_comment_count() }}
    </body>
</html>

Isso macros

These macros integrate Isso comments into an application.

Available in the flask_discussion/isso.html template.

isso.embed_client()

Embed Isso script.

This can either be used to globally include the script (e.g. in the head of the page) or called as part of the isso.render_comments() macro.

Example usage:

{% import "flask_discussion/isso.html" as isso %}

<html>
    <body>
        <a href="http://mypage.com">Visit my page</a>

        {{ isso.embed_client() }}
    </body>
</html>
isso.render_comments(identifier="", title="", include_script=true)

Render Isso comments.

Parameters

  • identifier – Optional identifier of the page

  • title – Optional title of the page

  • include_script – Set to false to not call the isso.embed_client() macro (e.g. for cases in which the client is embeded globally).

Example usage:

{% import "flask_discussion/isso.html" as isso %}

<html>
    <body>
        {{ isso.render_comments("my-page", "Page title") }}
    </body>
</html>
isso.render_comment_count()

Render Isso comment count.

This cannot be use at the same time as the full Isso client. Make sure to include #isso_thread in the href attribute of the link for which to show the comment count.

Example usage:

{% import "flask_discussion/isso.html" as isso %}

<html>
    <body>
        <a href="http://mypage.com#isso_thread">Comments</a>
        {{ isso.render_comment_count() }}
    </body>
</html>

Remark42 macros

These macros integrate Remark42 comments into an application.

Available in the flask_discussion/remark42.html template.

remark42.render_comments(url, title="", components=["embed"])

Render Remark42 comments.

Parameters

  • url – URL of the page

  • title – Optional title of the page (will default to browser window title)

  • components –

    Specifies which components to load. Available components are:

    • ”embed”: basic component widget

    • ”last-comments”: last comments widget

    • ”counter”: counter widget

Example usage:

{% import "flask_discussion/remark42.html" as remark42 %}

<html>
    <body>
        {{ remark42.render_comments("http://my-page.com", "Page title") }}
    </body>
</html>
remark42.render_last_comments(max_comments=15)

Render last comments of the site.

Parameters

max_comments – Maximum number of last comments to show (defaults to 15).

Example usage:

{% import "flask_discussion/remark42.html" as remark42 %}

<html>
    <body>
        {{ remark42.render_last_comments() }}
    </body>
</html>
remark42.render_comment_count(url)

Render Remark42 comment count widget.

Parameters

url – URL of the page

Example usage:

{% import "flask_discussion/remark42.html" as remark42 %}

<html>
    <body>
        {{ remark42.render_comment_count("http://my-page.com") }}
    </body>
</html>