You are here

Home » API reference » Clean Markup 7

README.txt in Clean Markup 7

Same filename and directory in other branches
  1. 7.3 README.txt
  2. 7.2 README.txt
CONTENTS OF THIS FILE
---------------------

* Overview
* Features
* Requirements
* Installation
* Known problems
* Version history
* Future plans
* Credits
* Recommended modules
* Similar projects

OVERVIEW
--------

This module aims to clean up, enhance and facilitate the customization of
markup for Drupal core and several popular contrib modules such as Panels.

FEATURES
--------

As of version 1.x:

Blocks:
    From the block configuration page, you can:
    * Disable or set the HTML5 element to use as the block wrapper,
    * Enable or disable an inner div,
    * Add classes to the outer block element,
    * Set the HTML5 element to wrap the title,
    * Toggle whether the block title is displayed visually,
    * Disable or set the HTML5 element to wrap the content.

REQUIREMENTS
------------

Clean markup API:
    no dependencies.
Clean block markup:
    Block (in core) and Clean markup API

INSTALLATION
------------

1. Download and install the clean_markup project.

   Install as usual, see https://drupal.org/node/895232 for further information.

2. In order for a user to change the clean markup settings, they will need to
   have *both* the "Administer blocks" and the "Administer clean markup block
   settings" permissions.

   See https://drupal.org/node/1576512 for further information.

3. The clean markup settings can be changed from the block's settings page.

   See https://drupal.org/node/1576532 for further information.

KNOWN PROBLEMS
--------------

We don't know of any problems at this time, so if you find one, please let us
know by adding an issue!

VERSION HISTORY
---------------

The 1.x branch contains only the Clean Block Markup module. Updates made to
other branches that affect Clean Block Markup are being backported to this
branch if possible.

FUTURE PLANS
------------

The 2.x branch contains both the Clean Block Markup and the Clean Panel Markup
modules.

The 3.x branch is currently in development, and contains the Clean Block
Markup, Clean Panel Markup and Clean Views Markup blocks.

We may also write something for Display Suite.

CREDITS
-------

Concept by rhache. Coding by rhache and mparker17.

RECOMMENDED MODULES
-------------------

If you want to clean up the markup of nodes, comments, taxonomy terms or users,
check out Display Suite.

If you want to clean up the markup of fields, check out Fences.

If you want a really clean base theme, check out Mothership.

SIMILAR PROJECTS
----------------

We aren't aware of any projects similar to this one.

File

README.txt
View source 
  1. 

  2. CONTENTS OF THIS FILE

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

  4. 

  5. * Overview

  6. * Features

  7. * Requirements

  8. * Installation

  9. * Known problems

  10. * Version history

  11. * Future plans

  12. * Credits

  13. * Recommended modules

  14. * Similar projects

  15. 

  16. OVERVIEW

  17. --------

  18. 

  19. This module aims to clean up, enhance and facilitate the customization of

  20. markup for Drupal core and several popular contrib modules such as Panels.

  21. 

  22. FEATURES

  23. --------

  24. 

  25. As of version 1.x:

  26. 

  27. Blocks:

  28.     From the block configuration page, you can:

  29.     * Disable or set the HTML5 element to use as the block wrapper,

  30.     * Enable or disable an inner div,

  31.     * Add classes to the outer block element,

  32.     * Set the HTML5 element to wrap the title,

  33.     * Toggle whether the block title is displayed visually,

  34.     * Disable or set the HTML5 element to wrap the content.

  35. 

  36. REQUIREMENTS

  37. ------------

  38. 

  39. Clean markup API:

  40.     no dependencies.

  41. Clean block markup:

  42.     Block (in core) and Clean markup API

  43. 

  44. INSTALLATION

  45. ------------

  46. 

  47. 1. Download and install the clean_markup project.

  48. 

  49.    Install as usual, see https://drupal.org/node/895232 for further information.

  50. 

  51. 2. In order for a user to change the clean markup settings, they will need to

  52.    have *both* the "Administer blocks" and the "Administer clean markup block

  53.    settings" permissions.

  54. 

  55.    See https://drupal.org/node/1576512 for further information.

  56. 

  57. 3. The clean markup settings can be changed from the block's settings page.

  58. 

  59.    See https://drupal.org/node/1576532 for further information.

  60. 

  61. KNOWN PROBLEMS

  62. --------------

  63. 

  64. We don't know of any problems at this time, so if you find one, please let us

  65. know by adding an issue!

  66. 

  67. VERSION HISTORY

  68. ---------------

  69. 

  70. The 1.x branch contains only the Clean Block Markup module. Updates made to

  71. other branches that affect Clean Block Markup are being backported to this

  72. branch if possible.

  73. 

  74. FUTURE PLANS

  75. ------------

  76. 

  77. The 2.x branch contains both the Clean Block Markup and the Clean Panel Markup

  78. modules.

  79. 

  80. The 3.x branch is currently in development, and contains the Clean Block

  81. Markup, Clean Panel Markup and Clean Views Markup blocks.

  82. 

  83. We may also write something for Display Suite.

  84. 

  85. CREDITS

  86. -------

  87. 

  88. Concept by rhache. Coding by rhache and mparker17.

  89. 

  90. RECOMMENDED MODULES

  91. -------------------

  92. 

  93. If you want to clean up the markup of nodes, comments, taxonomy terms or users,

  94. check out Display Suite.

  95. 

  96. If you want to clean up the markup of fields, check out Fences.

  97. 

  98. If you want a really clean base theme, check out Mothership.

  99. 

  100. SIMILAR PROJECTS

  101. ----------------

  102. 

  103. We aren't aware of any projects similar to this one.