You are here

Home » API reference » Text Size 6

README.txt in Text Size 6

Same filename and directory in other branches
  1. 5 README.txt
  2. 7 README.txt
Drupal Text Size Module
-----------------------
Author - Christian Zwahlen info@zwahlendesign.ch
Requires - Drupal 6, jQuery plugin (http://drupal.org/project/jquery_plugin)
License - GPL (see LICENSE.txt)

Description
-----------
This module display a adjustable text size changer or a zoom function on the page for a better web accessibility.

The zoom function is comparable to the text zoom function in Firefox 3, but this module resize also variable media objects, variable pixel images and vector images.

Advantages compared with browser zoom
-------------------------------------
1. Adjustable (increases/decreases step, minimum, maximum, standard and variable or three fixed values).
2. Resize region definable (for example a div with a ID "content": <div id="content">).
3. Browser independent.
4. One click function. No tutorial required.
5. Same handling in any browser (shortcuts).
6. Resize text, variable images and media objects (media objects or pixel images with "em" or "%" and SVG images).
7. Select menu availabe.
8. Display current text size (zoom size).

Features
--------
* WCAG and BITV conform.
* No Javascript and Cookies required. jQuery support.
* No CSS required.
* Minimum and maximum textsize.
* Text size values 1-1000% available (increases/decreases step 1-99%, text size normal 2-999%, minimum text size 1-998%, maximum text size 3-1000%).
* Resize region definable with a ID or a class.
* Caching mode: "Normal" and "Aggressive" compatible.
* Uniform markin of menu, based on the open source browser Firefox 2.0 (www.mozilla.com/en-US/firefox/) (Increase Ctrl++, Decrease Ctrl+-, Normal Ctrl+0).
* Themable. See: textsize-html.tpl.php, textsize-image.tpl.php or textsize-form.tpl.php.
* By default, compatible to the Drupal standard Theme: "Garland".
* No "!important" in the CSS available (less code).
* No JavaScript support available.

Installation
------------
1. Unpack and move the textsize modul to the Drupal directory "sites/all/modules/".
2. Download and install the "jQuery plugin" module (http://drupal.org/project/jquery_plugin).
3. Go to "Administer", "Site building", "Modules" ("admin/build/modules") and enable the modules "jQuery plugin" and "Text Size".
4. Run the database update script "update.php" if required.

Settings
--------
1. Go to "Administer", "User management", "Permissions" ("admin/user/permissions") and set the different roles.
2. Go to "Administer", "Site building", "Blocks" ("admin/build/block") and make the block "Text Size" visibile.
3. Go to "Administer", "Site configuration", "Text Size configuration" ("admin/settings/textsize") and change the settings if you want.
4. Go to "Administer", "Site building", "Translate interface", "Import" ("admin/build/translate/import") and import your language file (for German "sites/all/modules/textsize/translations/de.po") if it is necessary.

Theming
-------
Create Themes:
1.  Copy the files/directorys in your theme:
  1. textsize-text.tpl.php
  2. textsize-image.tpl.php
  3. textsize-form.tpl.php
  4. textsize.css
  5. images
2. Edit the PHP and CSS code in the files. Example: Image links, not in a list: Change the following elements: <ul>/</ul> to: <p>/</p>
  <li></li> to: <span class="display_hidden"> | </span>.
  WCAG/BITV 10.5: Adjacent hyperlinks have to be separated by printable characters surrounded by spaces. Warning: Not for: WCAG/BITV 13.6! Links are not in a list.
3. Edit the PHP templates (tpl.php) and textsize.css file. Example: "Image links, not in a list: Change the following elements: <ul>/</ul> to: <p>/</p>
  <li></li> to: <span class="display_hidden"> | </span>.
  WCAG/BITV 10.5: Adjacent hyperlinks have to be separated by printable characters surrounded by spaces. Warning: Not for: WCAG/BITV 13.6! Links are not in a list.
4. Edit the images. Create your own icons. The source file is in the directory: "/images/source/textsize.xcf". PNG images are for new browsers and GIF images for old browsers (Internet Explorer 6).

Download Themes: Edited templates are available from the developers website: http://www.zwahlendesign.ch/textsize.

Translations
------------
German
Importieren Sie die Datei "sites/all/modules/textsize/translations/de.po". unter "admin/build/translate/import" in die Deutsche Sprache, wenn es nötig ist.

Other languages
Open the file "sites/all/modules/textsize/translations/textsize.pot". in poEdit (http://www.poedit.net) or KBabel (http://kbabel.kde.org), translate the module in your language and save the file in "sites/all/modules/textsize/translations/" with a file suffix ".po".

More Information
----------------
More help and information on: "Administer", "Help", "Text Size" ("admin/help/textsize").

File

README.txt
View source 
  1. 

  2. Drupal Text Size Module

  3. -----------------------

  4. Author - Christian Zwahlen info@zwahlendesign.ch

  5. Requires - Drupal 6, jQuery plugin (http://drupal.org/project/jquery_plugin)

  6. License - GPL (see LICENSE.txt)

  7. 

  8. Description

  9. -----------

  10. This module display a adjustable text size changer or a zoom function on the page for a better web accessibility.

  11. 

  12. The zoom function is comparable to the text zoom function in Firefox 3, but this module resize also variable media objects, variable pixel images and vector images.

  13. 

  14. Advantages compared with browser zoom

  15. -------------------------------------

  16. 1. Adjustable (increases/decreases step, minimum, maximum, standard and variable or three fixed values).

  17. 2. Resize region definable (for example a div with a ID "content": 
    ).

  18. 3. Browser independent.

  19. 4. One click function. No tutorial required.

  20. 5. Same handling in any browser (shortcuts).

  21. 6. Resize text, variable images and media objects (media objects or pixel images with "em" or "%" and SVG images).

  22. 7. Select menu availabe.

  23. 8. Display current text size (zoom size).

  24. 

  25. Features

  26. --------

  27. * WCAG and BITV conform.

  28. * No Javascript and Cookies required. jQuery support.

  29. * No CSS required.

  30. * Minimum and maximum textsize.

  31. * Text size values 1-1000% available (increases/decreases step 1-99%, text size normal 2-999%, minimum text size 1-998%, maximum text size 3-1000%).

  32. * Resize region definable with a ID or a class.

  33. * Caching mode: "Normal" and "Aggressive" compatible.

  34. * Uniform markin of menu, based on the open source browser Firefox 2.0 (www.mozilla.com/en-US/firefox/) (Increase Ctrl++, Decrease Ctrl+-, Normal Ctrl+0).

  35. * Themable. See: textsize-html.tpl.php, textsize-image.tpl.php or textsize-form.tpl.php.

  36. * By default, compatible to the Drupal standard Theme: "Garland".

  37. * No "!important" in the CSS available (less code).

  38. * No JavaScript support available.

  39. 

  40. Installation

  41. ------------

  42. 1. Unpack and move the textsize modul to the Drupal directory "sites/all/modules/".

  43. 2. Download and install the "jQuery plugin" module (http://drupal.org/project/jquery_plugin).

  44. 3. Go to "Administer", "Site building", "Modules" ("admin/build/modules") and enable the modules "jQuery plugin" and "Text Size".

  45. 4. Run the database update script "update.php" if required.

  46. 

  47. Settings

  48. --------

  49. 1. Go to "Administer", "User management", "Permissions" ("admin/user/permissions") and set the different roles.

  50. 2. Go to "Administer", "Site building", "Blocks" ("admin/build/block") and make the block "Text Size" visibile.

  51. 3. Go to "Administer", "Site configuration", "Text Size configuration" ("admin/settings/textsize") and change the settings if you want.

  52. 4. Go to "Administer", "Site building", "Translate interface", "Import" ("admin/build/translate/import") and import your language file (for German "sites/all/modules/textsize/translations/de.po") if it is necessary.

  53. 

  54. Theming

  55. -------

  56. Create Themes:

  57. 1.  Copy the files/directorys in your theme:

  58.   1. textsize-text.tpl.php

  59.   2. textsize-image.tpl.php

  60.   3. textsize-form.tpl.php

  61.   4. textsize.css

  62.   5. images

  63. 2. Edit the PHP and CSS code in the files. Example: Image links, not in a list: Change the following elements: 
      /
     to: 
    /
    

  64.   
  65.  to:  | .

  66.   WCAG/BITV 10.5: Adjacent hyperlinks have to be separated by printable characters surrounded by spaces. Warning: Not for: WCAG/BITV 13.6! Links are not in a list.

  67. 3. Edit the PHP templates (tpl.php) and textsize.css file. Example: "Image links, not in a list: Change the following elements: 
      /
     to: 
    /
    

  68.   
  69.  to:  | .

  70.   WCAG/BITV 10.5: Adjacent hyperlinks have to be separated by printable characters surrounded by spaces. Warning: Not for: WCAG/BITV 13.6! Links are not in a list.

  71. 4. Edit the images. Create your own icons. The source file is in the directory: "/images/source/textsize.xcf". PNG images are for new browsers and GIF images for old browsers (Internet Explorer 6).

  72. 

  73. Download Themes: Edited templates are available from the developers website: http://www.zwahlendesign.ch/textsize.

  74. 

  75. Translations

  76. ------------

  77. German

  78. Importieren Sie die Datei "sites/all/modules/textsize/translations/de.po". unter "admin/build/translate/import" in die Deutsche Sprache, wenn es nötig ist.

  79. 

  80. Other languages

  81. Open the file "sites/all/modules/textsize/translations/textsize.pot". in poEdit (http://www.poedit.net) or KBabel (http://kbabel.kde.org), translate the module in your language and save the file in "sites/all/modules/textsize/translations/" with a file suffix ".po".

  82. 

  83. More Information

  84. ----------------

  85. More help and information on: "Administer", "Help", "Text Size" ("admin/help/textsize").