Guestbook

Xtgem Guestbook function

You can add a guest book to your xtgem site
(One per site like the blog function)
Only the sites logged in admin can reply to posts in the guestbook
no other users will see the reply links
Spam reports and post deletions are done using the "Guestbook comments" link in the "Comments" tab of your sites control panel
There is a setting in "site options" for commenting restrictions in the guestbook with the same options as blog comments

None (guest posting allowed)
Email input required (as far as I know all this does is add the email field it does nothing with the data)
Logged in users only (only registered and logged in users can comment)

The guestbook uses the same classes pagination and markup as blog comments
Logged in xtgem users will post using their community name and avatar (or gravatar if no profile image is set and they have one linked to their email address) with a link to their profile

The main settings are :
Guestbook entries per page (How many entries to show on each page)
Comment sorting (newest first or oldest first)
Allow html (Allows a very limited amount of html to be used in entries)
Format (The format for the time stamp selecting ago uses a Time ago format)
The timezone is set automatically to the visitors timezone or their countries main timezone as a fallback
Using the Code editor you can also set
comments_disable_links="1" (Links in the comments will be displayed as text only )
badwords="comma,separated,list,of,banned,words" (banned words are replaced with *****)

In the "more options" you can set your own text for :

Guestbook
This Guestbook has no comments - be the first one !
Post a comment
Name
Comment
post
You are posting as
Please login in order to post comments
Login
Signup
Please confirm your email before posting
Report spam
Hidden comment

There are also options for Show all comments and Reply
although these are only visible to the sites admin
The report spam links in the guest book automatically analyse the post and if it is above a certain threshold the post will be hidden
The report spam links in the building tool comments/guestbook will cause the comment to be hidden

Advanced Users

There is a subsidiary function that returns the number of comments in the guestbook
The count for this guestbook is 94

Guestbook in Xtscript

Guestbooks cam be manipulated by the use of Xtscript.
The guestbook can be assigned to a xtscript variable and then modified by any of the commands and functions of Xtscript.

Twig Template

There is a Twig PHP template template engine file available for the XtGem guestbook function
this must be copied to a plain text file name xtguestbook.twig In a folder named _xtgem_templates in the root directory (main file browser) of your site.
Most of the data variables and array structures are preset by the PHP that actually creates the guestbook on your page
But you can extend and reconfigure it at will.
The documentation relevant to twig templates is available at Twig for Template Designers

XTguestbook twig file

Copy to
/_xtgem_templates/xtguestbook.twig

<div class="xt_blog">
    {% block guestbook_comments_list %}
        <div class="xt_blog_comments" id="xt_blog_comments">
            {% if data.in_comments_thread %}
                <br /><div><a href="{{ data.comments_thread_all }}" class="xt_button xt_link">&larr; {{ data.translations.t_show_all_comments }}</a></div><br />
            {% endif %}

<span class="xt_blog_comments_title">
                {% if data.comments %}
                    {{ data.translations.t_guestbook }}
                {% else %}
                    {{ data.translations.t_guestbook_empty }}
                {% endif %}
            </span>

{% macro comments_list (comments, ctx) %}
                {% for comment in comments %}
                    <div class="xt_blog_comment{% if comment.owner_of_comment %} xt_blog_comment_author_admin{% endif %}">
                        <span class="xt_blog_comment_date">[{{ comment.date }}]</span>
                        <span class="xt_blog_comment_author">
                            {% if comment.author_profile %}
                                <a href="{{ comment.author_profile.link }}"><img src="{{ comment.author_profile.avatars[16] }}" style="display:inline">{{ comment.author_profile.name }}</a>
                            {% else %}
                                {{ comment.nick|raw }}
                            {% endif %}:
                        </span>
                        {% if not ( ctx.data.in_comments_thread and comment.childs and (comment.childs_count > 0) ) %}
                            <div class="xt_blog_comment_actions">
                                {% if not comment.owner_of_comment %}
                                    {% if ctx.data.visitor_is_admin  and not comment.childs %}
                                        <a href="{{ comment.reply_link }}" class="xt_blog_comment_action_reply">{{ ctx.data.translations.t_reply }}</a>
                                    {% endif %}
                                    {% if ctx.data.reported_spam and ctx.data.reported_spam == comment.id %}
                                        <span class="xt_blog_comment_action_reported">{{ctx.data.translations.t_reported}}</span>
                                    {% else %}
                                        {% if ctx.data.is_logged_in and not comment.is_hidden and not data.comments_form.is_maintenance %}
                                            <a href="{{ comment.spam_link }}" class="xt_blog_comment_action_report_spam">{{ ctx.data.translations.t_report_spam }}</a>
                                        {% elseif not ctx.data.is_logged_in and not comment.is_hidden and not data.comments_form.is_maintenance %}
                                            <a href="{{ comment.login_link }}" class="xt_blog_comment_action_report_spam">{{ ctx.data.translations.t_report_spam }}</a>
                                        {% endif %}
                                    {% endif %}

{% endif %}
                            </div>
                        {% endif %}
                        {% if comment.is_hidden %}
                            <div class="xt_blog_comment_content">{{ ctx.data.translations.t_hidden_comment }}</div>
                        {% else %}
                            <div class="xt_blog_comment_content">{{ comment.message|raw }}</div>
                        {% endif %}

{% if comment.childs %}
                            <div class="xt_reply" style="margin: 5px 6px;">
                                {{ _self.comments_list(comment.childs, ctx) }}
                            </div>
                        {% endif %}
                    </div>
                {% endfor %}
            {% endmacro %}
            {{ _self.comments_list(data.comments, _context) }}

</div><br />
        {{ data.comments_pagination_html|raw }}
    {% endblock %}

{% block guestbook_comments_form %}
        {% if data.comments_form.is_maintenance %}
            {{ data.comments_form.maintenante_markup|raw }}
        {% elseif data.is_logged_in and not data.community_name %}
            <div class="xt_guestbook_write_a_comment">
                <span class="xt_guestbook_write_a_comment_title">{{ data.translations.t_provide_community_name }}</span>
                <form action="{{ data.community_name_submit_url }}" method="post" id="xt_guestbook_comment_form">
                    {% if data.in_comments_thread %}
                        <input type="hidden" name="__xtcomments_thread_id" value="{{ data.in_comments_thread }}" />
                    {% endif %}
                    <div class="xt_input">
                        <input type="text" name="community_name" value="{{data.community_name_tmp}}" /><br />
                    </div>
                    <div class="xt_submit">
                        <input class="xt_button" type="submit" value="{{ data.translations.t_submit }}" />
                    </div>
                </form>
            </div>
        {% else %}
            <div class="xt_blog_write_a_comment">
                <span class="xt_blog_write_a_comment_title">{{ data.translations.t_post_a_comment }}</span>
                {% if data.comments_form.comments_restriction == "logged_in" and not data.is_logged_in %}
                    <div>{{ data.translations.t_comments_login_required }}: <a href="{{ data.comments_form.login_link }}"> {{ data.translations.t_login }} </a> | <a href="{{ data.comments_form.signup_link }}"> {{ data.translations.t_signup }} </a></div>
                {% elseif data.comments_form.comments_restriction == "logged_in" and data.is_logged_in and not data.is_confirmed_email %}
                    <div>
                        <a href="{{ data.confirm_email_link }}?redir={{ data.comments_form.url_encoded }}" class="xt_blog_confirm_email">
                            {{ data.translations.t_confirm_email }}
                        </a>
                    </div>
                {% else %}
                    <form action="{{ data.comments_form.url }}" method="post" id="xt_blog_comment_form">

{% if data.entry.in_comments_thread %}
                            <input type="hidden" name="__xtcomments_thread_id" value="{{ data.entry.in_comments_thread }}" />
                        {% endif %}

{% if data.is_logged_in %}
                            <div class="xt_label">
                                <label>{{ data.translations.t_posting_as }}: <span class="xtblog_community_name">{{ data.community_name }}</span></label>
                            </div>
                        {% else %}
                            {% if data.comments_form.spam_comments_reserved_name %}
                                <div>{{ data.translations.t_reserved_name }}</div>
                            {% endif %}
                            {% if data.comments_form.poster %}
                                <input type="hidden" name="__xtcomments_nick" value="{{ data.comments_form.poster }}" />
                            {% else %}
                                <div class="xt_label">
                                    <label>{{ data.translations.t_name }} </label>
                                </div>
                                <div class="xt_input">
                                    <input type="text" name="__xtcomments_nick" value="{{ data.comments_form.spam_comments_nick }}" /><br />
                                </div>
                            {% endif %}
                        {% endif %}
                        {% if data.comments_form.comments_restriction == "email_required" and not data.is_logged_in %}

<div class="xt_label">
                                <label>{{ data.translations.t_email }} </label>
                            </div>
                            <div class="xt_input">
                                <input type="text" name="__xtcomments_email" value="{{ data.comments_form.spam_comments_email }}" /><br />
                            </div>
                        {% endif %}

<div class="xt_label">
                            <label>{{ data.translations.t_comment }} </label>
                        </div>
                        <div class="xt_textarea">
                            <textarea id="xtblog_comment_msg" name="__xtcomments_msg">{{ data.comments_form.spam_comments_msg }}</textarea>
                        </div>

{% if data.comments_form.spam_comments %}
                            Please enter the text you can see on the image below: <br />
                            <input type="hidden" name="hash" value="{{ data.comments_form.spam_hash }}" />
                            <img src="{{ data.comments_form.spam_captcha_url }}" alt="" /><br />
                            <div class="xt_label">
                                <label>Code: </label>
                            </div>
                            <div class="xt_input">
                                <input type="text" name="code" />
                            </div><br />
                        {% endif %}

<div class="xt_submit">
                            <input class="xt_button" name="submit" type="submit" value="{{ data.translations.t_post }}" />
                        </div>
                    </form>
                {% endif %}
            </div>
    	{% endif %}
    {% endblock %}
</div>

Xtgem Guestbook function

Example Guestbook (This sites)

Advanced Users

Guestbook in Xtscript

Twig Template

XTguestbook twig file

Also see