Difference between revisions of "Persistent Bookmarks"

From TNG_Wiki
Jump to: navigation, search
(Sites using this mod)
Line 196: Line 196:
 
| TNG 9.0.2
 
| TNG 9.0.2
 
| EN
 
| EN
 +
|-
 +
! [http://mfo.me.uk  Mitchell Families Online]
 +
| Roger Mitchell
 +
|
 +
| V9.0.0.2
 +
| TNG 9.0.3
 +
| EN (GB)
 
|}
 
|}
  

Revision as of 14:59, 26 September 2012

Persistent Bookmarks
Summary Stores bookmarks in the database making them available on any computer or browser.
Validation The mod is XHTML compliant.Valid-xhtml10.png
Mod Updated {{{mod_last_update}}}
Download link  
TNG 9.0
persistent_bookmarks_v9.0.0.2.zip
 
TNG 8.0
persistent_bookmarks_v8.1.5.zip
Dutch language file
French language file
Spanish language file
See download statistics
Download stats {{{download_stats}}}
Author(s) Bart 'Roebie' Degryse
Homepage Persistent Bookmarks
Mod Support TNG forum
Contact Developer
Latest Mod 9.0.0.2 for TNG v9
8.1.5 for TNG v8
Min TNG V 8.1.3
Max TNG V 9.0.3
Files modified
admin_backup.php
admin_genconfig.php
admin_maketable_permbkmk.php (new file)
admin_modmanager.php
admin_optimize.php
admin_removetable_permbkmk.php (new file)
admin_restore.php
admin_utilities.php
ajx_addbookmark.php
ajx_delete.php
ajx_deletebookmark.php
bookmarks.php
cust_text.php
customconfig.php
tabledefs.php
Related Mods
Notes


Purpose of the mod

This mod will store the bookmarks in a database making them available on any computer or browser. As storing these bookmarks happens per user this mod will only work for logged in users. The current way of storing bookmarks in cookies remains untouched and fully functional.


Developer

This mod was developed by Bart 'Roebie' Degryse


Requirements

  • A working TNG installation.
  • A backup of all affected files (see the list in the summary in the upper right corner of the page)
  • An installed current version of the Mod Manager (is already included in TNG v9)


First Time Installation

  1. Download the appropriate zip file as shown in the summary in the upper right corner of the page. NOTE that I host these zip files on my own server. That way I can count the number of downloads for each mod I made and estimate the relevance of such mod.
  2. Extract the config file from the downloaded zip file into the mods folder.
  3. Follow the normal automated installation for Mod Manager, as shown in the example Mod Manager - Installing Config Files to install the mod.
  4. Go to Admin >> Setup >> Configuration >> General Settings >> Table Names. Name the new bookmarks table to your liking (default is tng_bookmarks) and press the Create... button. A success or error message will appear. On success the message will disappear after a few seconds and the button will be replaced with a Rename... button.
  5. You can rename the table later on at any time by changing it's name and pressing the Rename... button. You won't loose any existing data!


Upgrading

  1. Take a note of the current name of the bookmarks table. You can find this at Admin >> Setup >> Configuration >> General Settings >> Table Names.
  2. Follow the normal automated uninstall procedure, as shown in the example Mod_Manager_-_Installing_Config_Files#Remove_Mod_Steps to remove the old version of the mod.
  3. Download the zip file with the newer version from the summary in the upper right corner of the page. NOTE that I host these zip files on my own server. That way I can count the number of downloads for each mod I made and estimate the relevance of such mod.
  4. Extract the config file from the downloaded zip file into the mods folder.
  5. Follow the normal automated installation for Mod Manager, as shown in the example Mod Manager - Installing Config Files to install the mod.
  6. Go to Admin >> Setup >> Configuration >> General Settings >> Table Names. Name the new bookmarks table exactly the same as before (see step 1) and press the Create... button. A success or error message will appear. On success the message will disappear after a few seconds and the button will be replaced with a Rename... button. This way all your bookmarks data will be retained.
  7. You can rename the table later on at any time by changing it's name and pressing the Rename... button. Again, you won't loose any existing data!


Other Languages

Those who use other languages in addition to English can find appropriate mods to add Dutch, French or Spanish custom text additions in the summary in the upper right corner of this page. Follow the same procedure as explained above to install them.

Note: To use the multiple languages, in addition to installing the appropriate language file (or manually adding the $text['permbkmk'] variable to cust_text.php), you must Edit the mod parameters and set the first parameter to false. Once you've done that the text from the second parameter will be used for languages for which you haven't installed an appropriate language file (or manually added the required variable).

If you want to add another language please send me the translation (either the texts or as a full language mod) and your name (so I can give you credit) by sending me a personal message from the TNG forum.


Feature List

  • Each visitor has his bookmarks available on any browser or computer. He only has to log in to see them.
  • No limit to the number of bookmarks a visitor can store.
  • The current cookie bookmark system remains untouched and fully functional for visitors that don't or can't log in.
  • The bookmark table can be optimized, backed up or restored just like any other table.
  • The bookmark table's structure will be backup up together with all other tables. Note that restoring such backup after explicitely deleting the table and uninstalling the mod will restore the bookmarks table. So you should probably make a new table structure backup after uninstalling the mod.
  • Deleting a user will also delete any bookmarks (s)he might have stored.
  • New Fixed or language dependent label for the persistent bookmarks list.
  • New Rename table button in General Settings
  • New Remove table button in Mod Manager


Visualization of this mod

The following images show the visual effects of installing the mod.

Setup >> Configuration >> General Settings

Under the 'Table Names' header on the General Settings page you'll find an extra textbox and button where you can name and create the table for storing the bookmarks.

With the mod installed
Setup >> Configuration >> General Settings

When you click the Create... button the table is created. Next to the button a success or failure message will appear. After a little while the success message will disappear again and the Create... button will be replaced with a Rename... button.

Creating the bookmarks table
Utilities >> Back up, Restore & Optimize Table Data

The mod adds the bookmarks table to the list of tables you can optimize, backup or restore.

With the mod installed
Bookmarks

With the mod installed the bookmarks page first shows those bookmarks that are stored in the database (if any). Unter that you'll still find the bookmarks stored in the cookies (if any).

These two groups are totally independent from each other. Thus you can delete from one group without affecting the other group

When you're not logged in you'll only see the cookie bookmarks.

Starting with version 9.0.0.1 and 8.1.4 the first list on the bookmarks page - the bookmarks that are stored in the database - has a label too.

Bookmarks page with or without the mod
Admin >> Mod Manager >> Edit

You can use the mod's parameters to set the text for the label of the persistent bookmarks list on the bookmarks page. This can be a fixed text (default) or language dependent labels in the cust_text.php file can be used.

Use parameters to set the persistent bookmarks label
Admin >> Mod Manager

Starting with version 9.0.0.1 and 8.1.4 the Description column of this mod has a Remove button to remove the bookmarks table from the database. After clicking the button a success or failure message will appear next to the button. On success the button will disappear and a few seconds later the whole note on removing the bookmarks table will disappear.

Removing the bookmarks table


Uninstalling the mod

If you want to fully uninstall this mod remember to delete the bookmarks table after uninstalling the mod. At this moment the mod has no option to do that for you. So you will have to do it directly on the database server by using phpMyAdmin (available on most hosted servers) or alike.
Starting with version 9.0.0.1 and 8.1.4 the mod now has an option to delete the bookmarks table. Pressing the Remove button in the Description column of the mod on the Mod Manager page before uninstalling the mod itself will do the trick.


In the event of a problem

  • Try using the Mod Manager Remove capability
  • Contact me through the TNG forum.
  • Contact me by email. My email address is in the description column of this mod on the Mod Manager page
  • Copy the backup of the affected files back to your TNG directory


Revision History

Version Release Date Contents
v9.0.0.2
v8.1.5
25 May 2012 Renamed the two new files so that other mods can follow their concept more easily
Small change in the edit parameters concept + change of the descriptions to make it more understandable
Added the default text for the second edit parameter to the English and English-UTF8 cust_text.php
v9.0.0.1
v8.1.4
21 May 2012 Fixed or language dependent label for the persistent bookmarks list
Rename table button in General Settings
Remove table button in Mod Manager
v9.0.0.0 28 April 2012 Initial config file release
v8.1.3 28 April 2012 Initial config file release
Starting with TNG v9.0.0.0 the logfile mentions the username of deleted users instead of their id. This mod introduces this feature also in TNG v8.1.3 since it needs to fetch that username anyway for its own use two (!) lines earlier.


Sites using this mod

If you download and install this mod, please add your TNG site to the table below:

URL User Note Mod-Version TNG-Version User-language
no public site Bart 'Roebie' Degryse Mod developer V9.0.0.2 TNG 9.0.3 NL/EN/ES/FR
Our Roy and Boucher Family Ken Roy Tested the mod for Bart V9.0.0.2 TNG 9.0.2 EN, FR
Our Family Histories Bryan S. Larson V9.0.0.2 TNG 9.0.3 EN
Teige-Steinrötter-family Oname.gif false-Mod-Version (no public site) V9.0.0.2 TNG 9.0.2 D,(NL),(GB)
Kemp(e) Family History Andrew Kemp V9.0.0.2 TNG 9.0.2 EN
Mitchell Families Online Roger Mitchell V9.0.0.2 TNG 9.0.3 EN (GB)