'''Experienced''', maintainer, Administrators, sysops
5,027
edits
Changes
Jump to navigation
Jump to search
Line 7:
Line 7: − + Line 16:
Line 16: − + Line 32:
Line 32: + − + + + + + Line 39:
Line 44: − + − + − + Line 130:
Line 135: − + Line 143:
Line 148: + + + + + + + + + − + − + + Line 325:
Line 340: − + Line 344:
Line 359: − + − + − + Line 380:
Line 395: + + + + + + + + + + + + Line 385:
Line 412: − + + + + + + + + + − Note that this particular folio has a Cover plus seven pages and a PDF download button. In admin mode (shown) there is a link (icon) to edit the media in TNG. The cover page is simple html that includes an inserted graphic, but can be a more elaborate PHP script or an image.+ Line 409:
Line 444: − + − * [http://www.lee-bulleid.au Van Peer Project] This Mod is a must have. Should be part of TNG.!!
→Compatibility with Existing Folios
| mod_last_update = see Revision History
| mod_last_update = see Revision History
| download_link =
| download_link =
<div style="display:inline-block;width:95%;">[https://bisbeefamily.com/ccount/click.php?id=258&user={{#replace:{{CURRENTLOGGEDUSER}}}}&page={{PAGENAMEE}} version 13.0.0.30.zip]<div style="float:right;">{{Tv120|float=left}}{{Tv130|float=left}}{{Tv140|float=left}}</div></div>
<div style="display:inline-block;width:95%;">[https://bisbeefamily.com/ccount/click.php?id=262&user={{#replace:{{CURRENTLOGGEDUSER}}}}&page={{PAGENAMEE}} version 13.0.0.32.zip]<div style="float:right;">{{Tv120|float=left}}{{Tv130|float=left}}{{Tv140|float=left}}</div></div>
<!--
<!--
<div style="display:inline-block;width:95%;">[https://bisbeefamily.com/ccount/click.php?id=249&user={{#replace:{{CURRENTLOGGEDUSER}}}}&page={{PAGENAMEE}} version 13.0.0.25.zip]<div style="float:right;">{{Tv120|float=left}}{{Tv130|float=left}}{{Tv140|float=left}}</div></div>
<div style="display:inline-block;width:95%;">[https://bisbeefamily.com/ccount/click.php?id=249&user={{#replace:{{CURRENTLOGGEDUSER}}}}&page={{PAGENAMEE}} version 13.0.0.25.zip]<div style="float:right;">{{Tv120|float=left}}{{Tv130|float=left}}{{Tv140|float=left}}</div></div>
| mod_support = [https://bisbeefamily.com/support.php?mod={{PAGENAMEE}} Support for {{PAGENAMEE}}]
| mod_support = [https://bisbeefamily.com/support.php?mod={{PAGENAMEE}} Support for {{PAGENAMEE}}]
| mod_contact = As above
| mod_contact = As above
| mod_version = 13.0.0.30
| mod_version = 13.0.0.32
| use_mod_manager = Yes
| use_mod_manager = Yes
| manual_install = No
| manual_install = No
-->
-->
<br clear='both'/>
<br clear='both'/>
==Introduction==
==Introduction==
<span style='color:#990000;'><b>Updated June 22, 2023</b></span>. This mod's author has recently begun to use Showfolio to publish some very large books on several live websites. '''Some of these books have had over 2000 pages''', but because of Showfolio's nature, all individual pages display quickly. A side benefit as compared with PDF books is they cannot be downloaded in their entirety. If someone wants to download or screen-shoot 2000 pages a page at a time, we can't really stop them, but this is the next best thing. Folios can be individually set to display to the public or for logged in members only.
<span style='color:#990000;'><b>Updated July 15, 2023</b>. The image magnifier is now selectable by visitors. Beginning with this release, folio control files must be named folio.php. Index.php and init.php are no longer supported. If you have a large investment in one of these other control file names, please contact me and I will help you convert them</span>.
[[file:sf010.jpg|frameless|right|450px]]
This mod's author has recently begun to use Showfolio to publish some very large books on several live websites. '''Some of these books have had over 2000 pages''', but because of Showfolio's nature, all individual pages display quickly. A side benefit as compared with PDF books is they cannot be downloaded in their entirety. If someone wants to download or screen-shoot 2000 pages a page at a time, we can't really stop them, but this is the next best thing. Folios can be individually set to display to the public or for logged in members only.
Each folio has an administrative option to download a PDF file containing the contents of the folio. For example, a newsletter whose pages consist of individual JPG files, can contain a link to download a PDF version of the newsletter.
Each folio has an administrative option to download a PDF file containing the contents of the folio. For example, a newsletter whose pages consist of individual JPG files, can contain a link to download a PDF version of the newsletter.
The mod includes a utility that allows for storage of PDF documents in the private area of the site above the document root that is not accessible to a browser, but will download them upon request from an authorized visitor -- a member who is logged in to the site.
The mod includes a utility that allows for storage of PDF documents in the private area of the site above the document root that is not accessible to a browser, but will download them upon request from an authorized visitor -- a member who is logged in to the site.
With large publications, the '''''tab map''''' is very handy for synchronizing tab labels with page files. As explained below, a tab map inserted into the folio.php control file provides a concise way to create page tabs with individual labels or ranges of page numbers, either plain or prefixed, as might be the case with an Index section where each page might start with an "i" (i3, i4, i5, etc.) The map for that would be something like: "Cover, [1-109], Index, i[1-16]".
With large publications, the '''''tab map''''' is very handy for synchronizing tab labels with page file titles or numbers. As explained below, a tab map inserted into the folio.php control file provides a concise way to create page tabs with individual labels or ranges of page numbers, either plain or prefixed, as might be the case with an Index section where each page might start with an "i" (i3, i4, i5, etc.) The map for that would be something like: "Cover, [1-109], Index, i[1-16]".
== Compatibility ==
== Compatibility ==
{| class="wikitable"
{| class="wikitable"
|+ Mod Tested With TNG Versions
|+ Mod Tested With TNG Versions
! Version !! v1003-1013 !! v11 all !! v12 all !! v13 all !! v14.0
! Version !! v1003-1013 !! v11 all !! v12 all !! v13 all !! v14 all
|-
|-
| 13.0.0.30
| 13.0.0.32
| style="background-color:white;" |
| style="background-color:white;" |
| style="background-color:white;" |
| style="background-color:white;" |
==Compatibility with Existing Folios==
==Compatibility with Existing Folios==
If you are already invested in folios, we recommend you first install and run this on a test site. You should be able to run your existing folios as they are, with no changes to them. If you wish, you can convert your existing folios to the Showfolio Mod standard (see [[#Converting Folios to Showfolio]]). The mod developer has been running the showfolio mod on his production site (now TNGv13.0.3) and on several test sites going back to TNGv9.1.0 with no particular problems.
If you are already invested in folios, we recommend you first install and run this on a test site. You should be able to run your existing folios as they are, with no changes to them. If you wish, you can convert your existing folios to the Showfolio Mod standard (see [[#Converting Folios to Showfolio]]). The mod developer has been running the showfolio mod on his production site (now TNGv14.0.1) and on several test sites going back to TNGv9.1.0 with no particular problems.
Disclaimer: As a practical matter Showfolio Mod has not been run on every single version of TNG since TNGv9.0. We analyzed those we were not able to test directly and find no reason to believe Showfolio Mod is not %100 compatible with all of them. '''If you experience any problems in this regard, please let us know'''.
Disclaimer: As a practical matter Showfolio Mod has not been run on every single version of TNG since TNGv9.0. We analyzed those we were not able to test directly and find no reason to believe Showfolio Mod is not %100 compatible with all of them. '''If you experience any problems in this regard, please let us know'''.
|-
|-
! scope="col" width="110" |Version !! scope="col" width="90" | Date Released !! Showfolio — What's New
! scope="col" width="110" |Version !! scope="col" width="90" | Date Released !! Showfolio — What's New
|- valign="top"
| align="center"|version 13.0.0.32<br />|| <center>11 Feb 2024</center> ||
* Bugfix -- extract options from folio.php
* Bugfix -- make logged links to folio pages work properly
|- valign="top"
| align="center"|version 13.0.0.31<br />|| <center>15 July 2023</center> ||
* Bugfix -- missing PDF Download link
|- valign="top"
|- valign="top"
| align="center"|version 13.0.0.30<br />|| <center>4 Jul 2023</center> ||
| align="center"|version 13.0.0.30<br />|| <center>4 Jul 2023</center> ||
* Magnifier is now turned on or off by user at the top of image pages by clicking the magnifier glass icon. Show magnifier is no longer a showfolio option.
* Magnifier is now turned on or off by user at the top of image pages by clicking the magnifier glass icon. Show magnifier is no longer a showfolio option.
* Tab search "reads" the tab labels and finds the first one that matches the input. For example, "194" will match a label -- "1940 Census" or a label "194", whichever comes first in the tab lineup.
* Tab search "reads" the tab labels and finds the first one that matches the input. For example, "194" will match a label -- "1940 Census" or a label "194", whichever comes first in the tab lineup. Changed label from "Enter Page #" to "Enter Tab" to be more accurate.
* Showfolio Mod allows media from the folio to also be registered in the database as independent media items. It filters these from listings so they do not show as separate folios.
* Showfolio Mod allows media from the folio to also be registered in the database as independent media items. It filters these from listings so they do not show as separate folios.
* When a folio is first displayed, all relevant information is gathered and stored in the Session. Subsequent page requests use this data. An new URL query string value -- ff=1 -- has been added to force a session refresh of all data for testing purposes.
* When a folio is first displayed, all relevant information is gathered and stored in the Session. Subsequent page requests use this data. A new URL query string value -- &ff=1 -- has been added to force a session refresh of all data. You might need this, for example, after changing a Showfolio option like page centering, to see the effect.
* Very old versions allowed folio control files to be named folio.php, index.php or init.php. Beginning with this version release, only folio.php is supported.
|- valign="top"
|- valign="top"
===Set Local Options===
===Set Local Options===
Options in the control file only pertain to the current folio. No options are required -- they will all default to the global values set with mod manager or the setup page for the add-on version. A control file must be present, but it can be empty if no customizations are required.
Options in the folio.php control file only pertain to the current folio. No options are required -- they will all default to the global values set with mod manager or the setup page for the add-on version. A control file must be present, but it can be empty if no customizations are required.
Here are some options you can (but don't have to) use in the control file to customize the current folio:
Here are some options you can (but don't have to) use in the control file to customize the current folio:
$buttonLabel="cover";
$buttonLabel="cover";
|| Treat the first page as a cover page for the folio and provide a button label for it. You might want a cover page, for example, if you want to summarize the contents of the folio.<br />
|| Treat the first page as a cover page for the folio and provide a button label for it. You might want a cover page, for example, if you want to summarize the contents of the folio.<br />
If $buttonLabel can be found in the cust_text.php file in your chosen language as an index into the $text array (for example, $text['cover']="Contents"), the value provided there ("Contents") will be used. If not, the label itself will be used ("cover). This allows you to "internationalize" it in as many languages as you support.
If $buttonLabel can be found in the cust_text.php file in your chosen language as an index into the $text array (for example, $text['cover']="Contents"), the value provided there ("Contents") will be used. If not, the label itself will be used ("cover"). This allows you to "internationalize" it in as many languages as you support.
|- valign="top"
|- valign="top"
| $pdflink = "filename.pdf";
| $pdflink = "filename.pdf";
|| Places PDF download links at top and bottom of folio pages and downloads the file from the folio folder.
|| Places PDF download links at top and bottom of folio pages and downloads the file from the folio folder. <b style='color:red;'>IMPORTANT! This HTML link must be relative to the folio control folder -- folio.php.</b> Since PDF is not an allowed Folio page file, you can place it right in the Folio if you wish. Best practice would be to place it in a subfolder of the folio, so the link might look something like 'inc/mydoc.php'. <b>The same subfolder would also be a good place for any image files that are displayed in html pages. Because they are in a subfolder, they will not display separately as folio pages.</b>
|- valign="top"
|- valign="top"
| $pdffetch = "filename.pdf";
| $pdffetch = "filename.pdf";
|| Adds PDF download links to top and bottom of folio pages. Fetches PDF files from a private area of the website so they cannot be downloaded using a browser url. Server path to files must be defined in customconfig.php. For example, $pdfpath="/home6/subserv2/pdf/";
|| Adds PDF download links to top and bottom of folio pages. Fetches PDF files from a private area of the website so they cannot be downloaded using a browser url. <b style='color:red;'>Server path to private PDF file directory must be defined in customconfig.php.</b> <b>For example, $pdfpath="/home6/subserv2/pdf/";</b> Notice the trailing forward slash.
|- valign="top"
|- valign="top"
Please consult your TNG documentation for instructions on creating a TNG media collection.
Please consult your TNG documentation for instructions on creating a TNG media collection.
<b style='color:navy;'>Organizing this way appeals to the tidy mind, but makes it very tedious to enter new media into the TNG system</b>. Personal Photos, census returns, marriage records, death certificates, are all entered into separate collections with their own maintained structures.
Folios can greatly simplify this aspect of adding new media. For instance, you can create a collection and call it, say, "Exhibits".
Under Exhibits you can create folios associated with persons, using their personID as folio names, then register the folios as TNG media and associate them with the appropriate person.
Thereafter, place all new media in the person's folio, available for immediate inspection by site visitors. You can maintain a tab map for custom labels such as '1950 Census' if you like, or you can just allow folios to number them sequentially according to the order of their page file names.
There is a way you can link a media document that exists in one folio, into another folio's pages. For example, a headstone with both husband and wife's name can be physically placed in both folios, or can be placed in one folio and just linked as a page in the other. Actually it's quicker to duplicate them -- efficiency vs convenience.
If you need to register a document contained in the folio and associate it with an event such as 'Birth', go ahead and do it using the "Exhibits" collection and folio name/doc.jpg as the medium. For example, 'exhibits/p004352/bc4352.jpg. Note that I've prefixed and padded the PID so that it will alpha-sort properly. I use prefix 'bc' for birth certificates and the file is forever linked with personID 4352. This is a strictly personal choice. There are many other ways to do things.
==Folio Screenshot==
==Folio Screenshot==
Example of a working folio.
Example of a working folio.
[[Image:Sf004.jpg]]
[[Image:Sf004.jpg|720px]]
Note that this particular folio has tab mapped labels. In a large folio, it is convenient to use the Enter Tab window to jump to a far tab you want. If you enter a number, Showfolio first looks to see if there is a mapped label beginning with that number. If none found, it searches for an exact match with an indexed page number.
A cover page can be inserted at the beginning of the folio to provide a description/transcription of the folio contents, and/or show links to other interesting information on the site or externally on sites such as Find A Grave.
In admin mode (shown) there is a link (icon) to edit the media in TNG.
A PDf download link can be set in the folio.php control file to provide visitors with a PDF version of the folio, or any other associated PDF you want. Even if the site is open to all, you can specify that the download for this folio is available only to logged in members.
Although these options are easily edited directly into the folio.php control file, the companion admin_showfolio Mod helps set them up for you and is much quicker.
== Obligatory Disclaimer ==
== Obligatory Disclaimer ==
The following private sites have installed Showfolio Mod and contain folios which are only viewable with a login.
The following private sites have installed Showfolio Mod and contain folios which are only viewable with a login.
* [https://alineofmalkins.com/ A Line of Malkins' in New Zealand - Nu Tirani] WP/TNG v14.0.2 Mod v13.0.0.25 -- Excellent Mod
* [https://alineofmalkins.com/ A Line of Malkins' in New Zealand - Nu Tirani] WP/TNG v14.0.2 Mod v13.0.0.31 -- Excellent Mod
[[Category:Media]]
[[Category:Media]]
