1,804
edits
Changes
Citation Master Basic Mod (view source)
Revision as of 00:02, 13 August 2014
, 00:02, 13 August 2014no edit summary
== The page is under construction. ==
{{TNGmod
| mod_name = Citation Master Basic
| mod_summary = Customize the format and content of citations (individual pages) and sources (browsing page).
| mod_validation =
| download_link = {{Tv922}}[http://wherndon.net/genealogy/mods/mod-cite-master_v9.2.2.0.zip v9.2.2.0]
| download_stats =
| mod_author = [[User:wrherndon|Bill Herndon]]
| mod_url = [[Citation Master Basic Mod]]
| mod_support = [http://www.tngforum.us/index.php?act=Msg&CODE=4&MID=10149 TNG forum]
| mod_contact =
| mod_version = 9.2.2.0 for TNG v9.2.2<br/>
| min_TNG_ver = 9.2.2
| max_TNG_ver = 9.2.2
| TNG_file_list = browsesources.php<br/>personlib.php
| related_mods =
| notes =
}}
{| style="margin-right:0.5 em;" align="right"
| __TOC__
|}
== Purpose ==
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 ==
[[User:wrherndon|Bill Herndon]]
== Requirements ==
* A working TNG installation
* An installed current version of the [[Mod Manager]] (is already included in TNG v9)
* Shell-level access to your TNG host (for editing the configuration file)
== Installation ==
* Download the .zip file to your mods directory and unpack it.
* Inside the the sub-directory, ''egenea_cite_master'', edit the configuration file ''egenea_cfg_citation.php'' to add format instruction sets for your own source types.
* Install the mod using the TNG Mod Manager
== Upgrading ==
* Disable the mod through the Mod Manager
* Back up your copy of ''egenea_cfg_citation.php''
* Install the new version of the mod
* Restore your copy of ''egenea_cfg_citation.php''
* Enable the mod through the Mod Manager
== Features ==
* Define the fields, order, typeface, surrounding punctuation, and separators that go into a displayed citation or source
* Create different format instruction sets for different sources (e.g., Census vs. Will)
* Override TNG's formatting behavior for individual citations and source browsing.
Citation Master Basic supports changes to the typeface of a source field, the punctuation
that surrounds the field, the separator that follows the field, and the punctuation that
follows the citation. (Typeface, surround, and separator are referred to later as ''categories''.)
=== Typefaces ===
Four typefaces are supported: 'plain', 'bold', 'italic', and 'uline' (i.e., underline).
=== Surrounds ===
Five types of surrounding punctuation are supported: 'parens' (i.e., parenthesis), 'quotes', 'brackets' (i.e., square brackets), 'braces' (i.e., curly braces), and 'angles' (i.e., angle brackets).
=== Separators ===
The supported field separators are: 'space', 'comma', 'colon', 'period', 'semi' (i.e., semi-colon), and 'dash'. With the exception of dashes, that have spaces both before and after, all other punctuation marks have a single appended space.
== Notes ==
* The format instructions and source specifications are valid PHP code, and so if
you make a mistake you'll probably encounter a syntax error when PHP attempts
to render your page.
* Only 1 format instruction for each category, for a given tag. Multiple typefaces for one tag--as in 'bold, italic'--are not currently supported. No instruction is ever required--there
is always a default behavior.
* Instruction order is important. Do you want your comma inside your quoted title? Then your separator instruction should come before your surround instruction.
You must have a source specification named "_default". If no other specification matches the source type, this specification is used. The default specification supplied in the example
configuration file corresponds to the requirements of the Chicago Manual of Style.
=== Formatting Instructions ===
This is a PHP array that associates GEDCOM tags with formatting instructions.
So, for example, the TITL (title) tag might be associated with the typeface 'bold'
and be followed by a 'comma' (a 'separator' instruction).
=== Source Specifications ===
These are PHP arrays that define source types (such as 'Census') and identify which
format instruction sets are applied One specification named '_default' must exist in
the configuration file to handle any source types that don't have specifications.
=== Visualization of this mod ===
More here soon...but for the moment check out an example of an individual's source
[http://wherndon.net/genealogy/getperson.php?personID=I116&tree=LindellHerndon#sources citations] or an example of the [http://wherndon.net/genealogy/browsesources.php source browser].
=== Example Formatting Instructions ===
See the additional configuration file supplied in the mod package, ''bills_cfg_citation.php''. This is my personal configuration file containing 4 distinct format instructions sets all of
which correspond to the IEEE citation style.
== Uninstalling the mod ==
<s>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.</s><br/>
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_-_Installing_Config_Files#Remove_Mod_Steps|Mod Manager Remove]] capability
* Contact me through the [http://www.tngforum.us/index.php?act=Msg&CODE=4&MID=10149 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 ==
{| border="1" cellspacing="5" cellpadding="2" width="100%" class="wikitable"
|-
! Version
! Release Date
! Contents
|- valign="top"
| v9.2.2.0
| 2014/08/09
| Initial release.
|-
|}
== Sites Using Citation Master Basic ==
If you download and install this mod, please add your TNG site to the table below:
{| border="0" cellspacing="1" cellpadding="2" class="wikitable"
|-
! URL
! User
! Note
! Mod-Version
! TNG-Version
|-
| [http://wherndon.net/genealogy Lindell-Herndon Genealogy]
| [[User:wrherndon|Bill Herndon]]
|
| 9.2.2.0
| 9.2.2
|-
|}
[[Category:Mods for TNG v10]]
[[Category:Mods for TNG v9]]
[[Category:Mods for TNG v8]]
[[Category:admin_backup.php mods]]
[[Category:admin_genconfig.php mods]]
[[Category:admin_modmanager.php mods]]
[[Category:admin_optimize.php mods]]
[[Category:admin_restore.php mods]]
[[Category:admin_utilities.php mods]]
[[Category:ajx_addbookmark.php mods]]
[[Category:ajx_delete.php mods]]
[[Category:ajx_deletebookmark.php mods]]
[[Category:bookmarks.php mods]]
[[Category:cust_text.php Dutch mods]]
[[Category:cust_text.php English mods]]
[[Category:cust_text.php French mods]]
[[Category:cust_text.php Spanish mods]]
[[Category:customconfig.php mods]]
[[Category:tabledefs.php mods]]