Scroll Mod Information

--- Scroll Mod Information ---

To install the mod follow the procedures on the TNG WIKI: Installing Config Files

The scroll mod folder should not contain any subfolders, only files. Using the admin console, go to the TNG folder on you website.
Confirm the scroll_mod_v15.0.0.3.cfg file and scrollmod_v15.0.0.3 folder are in the mods folder.
Log in to TNG and go to the admin page and select Mod Manager.
If the scroll mod cfg file is present the line should display "OK to install" if there are no conflicts with other mods.
Note you will not see the scroll mod folder from the mod manager window but, if the folder is missing, "Cannot install" will be displayed.

Locate the line containing Scroll Mod and click "OK to install". When the line expands select INSTALL.

After scroll mod is installed, the scrollmod zip file can be stored on your local drive and the mod contents in the temp folder deleted.

After installing Scroll Mod, REFRESH (Windows Ctrl+F5 | Mac command+R) the page to reload the style sheets (css files).
Otherwise the buttons may be large and/or in the wrong position.

When pages have vertical overflow, two or four buttons appear depending on the page height that scroll vertically.
On pages with horizontal overflow but no vertical overflow, two to four buttons appear that scroll horizontally.
If a page has vertical and horizontal overflow, four to eight buttons appear.
The number of buttons shown depends on the amount of overflow. So when content requires more than one click, additional buttons scroll the total height and/or width.
If the page has no overflow, buttons do not appear.

Scroll mod requires the scrollconfig.php file, located in the TNG root folder, to control which pages display buttons. You do not need to change or edit anything in this file to use Scroll Mod.
This file is provided for admins that prefer showing scroll buttons on certain pages and/or prevent scrolling other pages.
This is a "protected" file so it is not deleted when the mod is uninstalled or upgraded. The file contains two different arrays:
$scroll_none - Scroll buttons DO NOT appear on any files listed in this array. There are no options for using this array.
$scroll_select - Files listed in this array are scrolled if content overflows and mod option 3, listed below, is enabled.
The $scroll_none array has priority so a file is active in both arrays, if will not display scroll buttons.

The arrays must be edited manually using a source code editor. DO NOT use a word processor or text editor that adds an EOL character.
If an EOL character is present or you make a syntax error in the array, a PHP error will result in displaying a blank page.
If this occurs manually delete the scrollconfig.php file, from the TNG root folder, uninstall then reinstall the mod.

Mod options are as follows:
Option 1 - Scroll Vertical Distance
Enter the vertical scroll distance as a number between 10 and 100.
Decimals can be to control the scroll distance more accurately. The number entered is converted to percent and multiplied by the units calculated from the clients display.
This allows a consistent experience for different screen resolutions. Keep in mind if you enter 100 the page will scroll the screen height so content at either the bottom or top of the page will scroll out of view.
If you enter a number smaller than 10 or greater than 100, the last valid setting is used.

Option 2 - Scroll Horizontal Distance
Enter the horizontal scroll distance as a number between 10 and 100.
Decimals can be to control the scroll distance more accurately. The number entered is converted to percent and multiplied by the units calculated from the clients display.
This allows a consistent experience for different screen resolutions. Keep in mind if you enter 100 the page will scroll the screen width so content at either the right or left of the page will scroll out of view.
If you enter a number smaller than 10 or greater than 100, the last valid setting is used.

Option 3 - Vertical Button Position
Adjusts the scroll buttons position vertical distance from the bottom of the screen in pixels.

Option 4 - Horizontal Button Position
Adjusts the scroll buttons position horizonal distance from the right edge the content page in pixels.

Option 5 - Position buttons using display width
The default setting positions the scroll buttons based on the content area of the page. However, a few templates do not have a div or id to use for this purpose.
In those cases the display width is used. When true the horizontal position is always based on the diplay width.

Option 6 - Scroll Charts and Select Pages
Use this option to control pages that display scroll buttons.
The $scroll_none array prevents buttons from displaying scroll buttons on any of the active files. This array has priority over the $scroll_select array.
The $scroll_select array displays button on any of the active files.
If the file is active in both arrays, it will NOT display scroll buttons.

Option 7 - Hide Scroll Buttons on Home Page
Enable this option (1) to hide the scroll buttons on the home page.
If the active template has a scroll to top button, it will be hidden on pages that show scroll buttons.
However, if scroll buttons are disabled on a page, the scroll to top button will appear.

To customize colors or change the button size, refer to the scrollpage-info.css file in this folder for the classes and rules to add to the mytngstyle.css file.v Scroll buttons will not appear on mobile devices unless the device uses a non standard identifier.
Horizontal scroll buttons are not displayed on templates 2, 5, 6 and 7 unless the template mod is installed.

To partially scroll a chart, double click to scroll one page height or width. The length of time between clicks determines how far the partial scroll moves the page. This is useful for positioning large charts.

Scroll mod uses the browser's scroll feature to scroll overflowing content. The TNG drag feature does not scroll but uses CSS transitions to move content within the div or id.
If you drag part of a chart out of view, scroll mod cannot move it back. Use the TNG 1:1 icon to move it back into view.
If you add a mod or page that overflows horizontally but does not use an existing class or id name, scroll buttons may not scroll horizontally.

Scroll mod loads from the TNG footer. Scroll buttons will not appear on custom pages that does not use the TNG footer.

To completely remove the mod, select uninstall. If the scroll mod folder remains, manually delete the folder. Go to the TNG root folder and manually delete the scrollconfig.php file.