Difference between revisions of "Comments"

From TNG_Wiki
Jump to: navigation, search
(Added to Credits)
(Non-vital textcorrections)
Line 29: Line 29:
 
* familygroup.php (if not living or private)
 
* familygroup.php (if not living or private)
 
* placesearch.php
 
* placesearch.php
* showmedia.php
+
* showmedia.php (if not living or private)
 
for loggedin users to add comments to the subject.<br/>
 
for loggedin users to add comments to the subject.<br/>
 
A new page is added that lists all pages with comments - link in the '''Info menu'''.<br/>
 
A new page is added that lists all pages with comments - link in the '''Info menu'''.<br/>
Line 39: Line 39:
 
== Visualization of this mod ==
 
== Visualization of this mod ==
  
<p>If there are comments, this is what the '''not logged in''' visitor sees.<br/>[[File:Comments0.jpg]]</p>
+
<p>If there are comments, this is what the '''not logged in''' visitor sees.<br/>[[File:Comments0.jpg]]</p><br/>
<p>User '''hoppehoppe''' is logged in<br/>[[File:Comments1.jpg]]</p>
+
<p>User '''hoppehoppe''' is logged in<br/>[[File:Comments1.jpg]]</p><br/>
<p>User '''hoppehoppe''' writes a comment. '''Note how to include a link'''<br/>[[File:Comments2.jpg]]</p>
+
<p>User '''hoppehoppe''' writes a comment. '''Note how to include a link'''<br/>[[File:Comments2.jpg]]</p><br/>
<p>The result. The link is active.<br/>'''The author of the last comment''' may edit it while it is the last.<br/>[[File:Comments3.jpg]]</p>
+
<p>The result. The link is active.<br/>'''The author of the last comment''' may edit it while it is the last.<br/>[[File:Comments3.jpg]]</p><br/>
<p>The Administrator may delete any comment.<br/>[[File:Comments4.jpg]]</p>
+
<p>The Administrator may delete any comment.<br/>[[File:Comments4.jpg]]</p><br/>
<p>The '''Info menu link''' shows when a new comment is added to the listpage.<br/>[[File:Comments5.jpg]]</p>
+
<p>The '''Info menu link''' shows when a new comment is added to the listpage.<br/>[[File:Comments5.jpg]]</p><br/>
 
<p>The list of pages with comments.<br/>There are '''New''' comments since the user visited this page the last time.<br/>[[File:Comments6.jpg]]</p>
 
<p>The list of pages with comments.<br/>There are '''New''' comments since the user visited this page the last time.<br/>[[File:Comments6.jpg]]</p>
  
Line 51: Line 51:
  
 
This mod was developed by Erik Hoppe.<br/>See all my mods at my '''''[[User:XerxX|Wiki user page]]'''''.
 
This mod was developed by Erik Hoppe.<br/>See all my mods at my '''''[[User:XerxX|Wiki user page]]'''''.
 
  
 
== Credits ==
 
== Credits ==
Line 61: Line 60:
 
== Requirements ==
 
== Requirements ==
  
{{TNG 11.1|and after}}
+
{{TNG 11.1.2|and after}}
 
* A working TNG installation.
 
* A working TNG installation.
 
* A backup of all affected files (see the list below)
 
* A backup of all affected files (see the list below)
Line 139: Line 138:
 
'''Explanation''' for the limits in the last two texts:<br/>
 
'''Explanation''' for the limits in the last two texts:<br/>
 
<b>If your .cfg serves only one character set and you save it in that same set, this is not a problem for you.</b><br/>
 
<b>If your .cfg serves only one character set and you save it in that same set, this is not a problem for you.</b><br/>
The .cfg serves two character sets (UTF-8 and ANSI), therefore HTML-entities have to be used for umlauted and accented letters<br/>
+
The distributed .cfg serves two character sets (UTF-8 and ANSI), therefore HTML-entities have to be used for umlauted and accented letters<br/>
 
&amp;auml; = ä, &amp;eacute; = é etc, otherwise strange characters will be displayed in one of the two character sets.<br/>
 
&amp;auml; = ä, &amp;eacute; = é etc, otherwise strange characters will be displayed in one of the two character sets.<br/>
 
JavaScript boxes and Page Title (browser tab text) displays text as received so HTML-entities can't be used.<br/>
 
JavaScript boxes and Page Title (browser tab text) displays text as received so HTML-entities can't be used.<br/>
Line 147: Line 146:
  
 
If  you want to completely '''Remove''' (uninstall) this mod and all its tables, you should  
 
If  you want to completely '''Remove''' (uninstall) this mod and all its tables, you should  
# click the '''Delete''' button to delete the config file from the mods folder and then
+
# click the '''Uninstall''' button.
 
# click the '''Remove Comments Database Tables''' buttons.
 
# click the '''Remove Comments Database Tables''' buttons.
 +
# click the '''Delete''' button to delete the config file and its folder from the mods folder.
  
  
Line 166: Line 166:
  
 
== Sites using this mod ==
 
== Sites using this mod ==
'''As the selection is only visible for logged in users, I can't show anything but the screenshot above.
+
'''If you download and install this mod, you can support it by adding your TNG site to this table:'''
 
 
'''If you download and install this mod, please add your TNG site to the table below:'''
 
  
 
{| border="0" cellspacing="1" cellpadding="2" class="wikitable"
 
{| border="0" cellspacing="1" cellpadding="2" class="wikitable"

Revision as of 12:28, 20 September 2018

Restricted Downloads of Comments are restricted to logged in users. If you do not have a user account on the TNG Wiki use the Request Account link to request a user account Restricted


Comments
Summary Adds an event for commenting
Validation
Mod Updated 14 Sep 2018
Download link for
TNG 12.0
Comments 12.0.1.0
for
TNG 11.0
Comments 11.1.2.0
Download stats Downloads
Author(s) Erik Hoppe
Homepage Comments (this page)
Mod Support My Mod Support
Contact Developer My Mod Support
Latest Mod 11.1.2.0 - 12.0.1.0
Min TNG V 11.1.2
Max TNG V 12.x
Files modified
Related Mods
Notes
Author of TNG Colouring Book
Mods by me: At my user page.


Purpose of the mod

An event Comments is added to

  • getperson.php (if not living or private)
  • familygroup.php (if not living or private)
  • placesearch.php
  • showmedia.php (if not living or private)

for loggedin users to add comments to the subject.
A new page is added that lists all pages with comments - link in the Info menu.
The Info menu link signals when a new comment is added to the list.
Database tables are handled in Utilities as usual (back-up, restore etc)
Currently supports English, French and Swedish.


Visualization of this mod

If there are comments, this is what the not logged in visitor sees.
Comments0.jpg


User hoppehoppe is logged in
Comments1.jpg


User hoppehoppe writes a comment. Note how to include a link
Comments2.jpg


The result. The link is active.
The author of the last comment may edit it while it is the last.
Comments3.jpg


The Administrator may delete any comment.
Comments4.jpg


The Info menu link shows when a new comment is added to the listpage.
Comments5.jpg


The list of pages with comments.
There are New comments since the user visited this page the last time.
Comments6.jpg


Developer

This mod was developed by Erik Hoppe.
See all my mods at my Wiki user page.

Credits

Credits go to manofmull, dlcole, Ken and Katryne for your invaluable tests, help, suggestions, advice and patience. Thanks!
Special thanks to Katryne for the French translation.


Requirements

TNG version: 11.1.2
  • A working TNG installation.
  • A backup of all affected files (see the list below)
  • An installed current version of the Mod Manager (is already included in TNG v10)


Installation

  1. Click on the download link, shown in the summary in the upper right corner of the page.
  2. Un-zip the file and open the folder. You will find a .cfg file and a new folder inside.
  3. Move/copy/FTP the .cfg file and the accompanying folder to the mods folder of your TNG system.
  4. Follow the normal automated installation for Mod Manager, as shown in the example Mod Manager - Installing Config Files to install the mod.
  5. Remember to click the Create Comments Database Tables button to finish the installation.


In the event of a problem


Modmanager Edit Options

  • Comments may be read by the public.
  • Admin does not receive mail for new comment.


Custom Text Additions

The config file includes the English language custom text.
There are French and Swedish translations if they are present in your TNG system.
For other languages you can modify the config file to add the custom text or manually add to whatever language you like.

(English custom text for reference)


$text['commentWrote'] = " wrote";
$text['commentMsg'] = "Comments";
$text['commentNotext'] = "There are no comments yet...";
$text['commentClick'] = "Write a comment!";
$text['commentUse'] = "Please don't use for changes/corrections (use the Suggest tab instead).";
$text['commentAddNew'] = "A new comment from";
$text['commentChars'] = "<b>You can NOT use the characters ";
$text['commentOr'] = " or ";
$text['commentNoreplace'] = "</b> They are deleted and not replaced.";
$text['commentPostbutt'] = "Add your comment!";
$text['commentError1'] = "No comment!";
$text['commentHeader'] = "Pages with comment(s)";
$text['commentPersID'] = "ID";
$text['commentPersPlace'] = "Name (link = new win/tab)";
$text['commentSubmitter'] = "By";
$text['commentAdded'] = "Added";
$text['commentNumb'] = "#";
$text['commentsDelete'] = "Delete";
$admtext['commentsvisits'] = "Comments read";
$admtext['commentPage'] = "Comments";
$text['commentPage'] = "Comments"; // admtext is not global
$text['commentNew'] = "New";
$text['commentNewChar'] = "<b>  !</b>";
$text['commentNewMail'] = "New Comment posted";
$text['commentDatabase'] = "Database";
$text['commentMail'] = "Mail";
$text['commentErrorinsert'] = " error on Insert Comment";
$text['commentErrorupdate'] = " error on Update Comment";
$text['commentErrordelete'] = " error on Delete Comment";
$text['commentAlertadmin'] = "Please alert the Administrator. Thank You.";
$text['commentRegarding'] = "Regarding ";
$text['commentReldel'] = "Reload page to Delete";

$text['commentPagetitle'] = "List of Comments";
// NOTE: Use _only_ PLAIN A-Z here! No accented or umlauted letters. (Used in the browser tab)

$text['commentDelcom'] = "Do you really want to DELETE this comment?\\n\\nWARNING! This can not be undone!";
// NOTE: Use _only_ PLAIN A-Z here! No accented or umlauted letters. (Used in a JavaScript-box)

Explanation for the limits in the last two texts:
If your .cfg serves only one character set and you save it in that same set, this is not a problem for you.
The distributed .cfg serves two character sets (UTF-8 and ANSI), therefore HTML-entities have to be used for umlauted and accented letters
&auml; = ä, &eacute; = é etc, otherwise strange characters will be displayed in one of the two character sets.
JavaScript boxes and Page Title (browser tab text) displays text as received so HTML-entities can't be used.


Uninstalling the mod

If you want to completely Remove (uninstall) this mod and all its tables, you should

  1. click the Uninstall button.
  2. click the Remove Comments Database Tables buttons.
  3. click the Delete button to delete the config file and its folder from the mods folder.


Revision History

Version Date Description
v11.1.2.0
v12.0.1.0
14 Sep 2018 Introduction


Sites using this mod

If you download and install this mod, you can support it by adding your TNG site to this table:

URL User Note Mod-Version TNG-Version User-language
Andersson, Hoppe, Sahlin, Thorell Erik Hoppe Mod author Private version 11.1.2 SE, GB, DE
Cole / Tanner Family Tree David Cole Public/Private see here see here English

TNG Modules Impacted

The following TNG Modules are modified, and should be backed up prior to installing this mod:

  • getperson.php
  • familygroup.php
  • placesearch.php
  • showmedia.php
  • personlib.php
  • genlib.php
  • customconfig.php
  • admin_genconfig.php
  • admin_utilities.php
  • admin_backup.php
  • admin_optimize.php
  • admin_restore.php

The custom texts will be added to these files, which should also be backed up prior to installing this mod:

  • languages/English/cust_text.php
  • languages/English-UTF8/cust_text.php
  • languages/French/cust_text.php - if present
  • languages/French-UTF8/cust_text.php - if present
  • languages/Swedish/cust_text.php - if present
  • languages/Swedish-UTF8/cust_text.php - if present