- "Ask the Expert" or Advice Column
- "Must Have" Modules
- A Challenge
- Books Overview
- Changing Garland - A Practical Example
- Comparison of Links and Web Links modules
- Create Simple Tables
- Creating a "Biographies" page
- Developing a Module on a Windows System
- Generic Table Display
- How to page a custom DB query
- List Users From a Single Role in a Block
- My Modules
- Announcements: Special Notices for Your Site
- Attendance Matrix
- Content Type Template
- FAQ_Ask
- Get Content Type
- Glossary
- Gotcha - Contact Spam Catcher
- Helpers
- Indexpage: summary of node type information
- Longer Node Titles
- Node Type Filter
- Quotes
- RealName: Using Profile fields to set a user's displayed name
- Register_Country
- Site Documentation Module
- Site Notes: Hidden Design or How To notes in Your Database
- Spam Tokens
- Spam Tune
- Taxonomy Browser
- Taxonomy Delegate
- Taxonomy Image: Associate Images with Taxonomy Terms
- Taxonomy List: Displaying Lists of Terms
- SBS Web Site Notes
- Searching for a New Hosting Company
- Taxonomy Tidbits
- Theming a Specific Content Type
Site Documentation Module
Submitted on Thu, 05/10/2007 - 18:07.
This all started with a post on the DO forums asking "I was wondering if there are any modules that output the entire DrupalDrupal
An open-source content management system that is used on this site and is taking over the world. setup and document the modules and configurations." That got me started thinking... Very dangerous for a blonde!
The Site DocumentationA Drupal contributed module by Nancy Wichmann for gathering information about the installation. ModuleAn add-on, or extension, to Drupal to provide additional functionality; written in PHP.
Why Do I Need It?
Unfortunately DrupalDrupal
An open-source content management system that is used on this site and is taking over the world. does not include the powers of immortality or invincibility. You may someday get hit by a truck, or even just decide that you no longer want to maintain the siteA logically grouped set of content - also web site.. So someone else may have to take over.
Where do they start? I know you documented the siteA logically grouped set of content - also web site. really well, but the next person doesn't want to read those 14 binders of documentation you left behind. They can always go through all the administration screens and look for the information, but that can take a lot of time and even those pages don't tell you everything. Some things you're only going to get by looking directly into the databaseA collection of data related to an application..
This is what the Site DocumentationA Drupal contributed module by Nancy Wichmann for gathering information about the installation. moduleAn add-on, or extension, to Drupal to provide additional functionality; written in PHP. is designed to do. In addition, it will detect some problems that may exist in your installation, and optionally correct some of them.
What Does It Do?
To simplify it a bit, the Site DocumentationA Drupal contributed module by Nancy Wichmann for gathering information about the installation. moduleAn add-on, or extension, to Drupal to provide additional functionality; written in PHP. picks up information from various places within the DrupalDrupal
An open-source content management system that is used on this site and is taking over the world. environment. Some of the information comes from internal arrays, some is derived from system calls, and some comes directly from the databaseA collection of data related to an application. tables. As one might imagine, this gathering does not come without a price; you can expect a spike in databaseA collection of data related to an application. and CPU activity while this moduleAn add-on, or extension, to Drupal to provide additional functionality; written in PHP. runs. Therefore, one should be careful how often and when it is run.
The Site DocumentationA Drupal contributed module by Nancy Wichmann for gathering information about the installation. moduleAn add-on, or extension, to Drupal to provide additional functionality; written in PHP. presents the following summarized information:
- Basic Drupal
Drupal
An open-source content management system that is used on this site and is taking over the world. summary - lists some basic information about your DrupalDrupal
An open-source content management system that is used on this site and is taking over the world. installation. - DatabaseA collection of data related to an application. summary - list all tables and pertinent information.
- Sequences Summary - displays the last id of various table entries.
- Node Summary - lists how many of all content types are in the databaseA collection of data related to an application., along with status information.
- Node Access Summary - checks the node_access table to see if all nodes are represented, and includes the ability to see which nodes are in which realms. (Unlike Devel Nodes Access, this does not require any other modules like Views.)
- Content types - detailed list of content type settings.
- Vocabularies - shows all the defined vocabularies (taxonomies) and all the terms within them, along with usage counts and other settings.
- Modules - lists all modules that are known to the Drupal
Drupal
An open-source content management system that is used on this site and is taking over the world. system, even if not enabled. This list is much like that of the Modules Admin page (I borrowed some of that code), and includes dependencies. - Themes - lists all the available themes, whether enabled or not.
- ThemeFor web sites, this refers to the "look and feel" of the site. It is also used to describe the code to produce that look._Engine - shows which themeFor web sites, this refers to the "look and feel" of the site. It is also used to describe the code to produce that look. engines are available.
- System Variables - lists all variables defined by all modules, along with their content.
- Blocks - shows a complete list of the blocks that are defined, whether enabled or not. It will also check to see if the themeFor web sites, this refers to the "look and feel" of the site. It is also used to describe the code to produce that look. that owns them exists any longer; if not, a warning message may be issued.
- Boxes - this shows additional information for manually created blocks.
- Roles and Permissions - lists all user roles along with their access permissions, blocks that are restricted to the role, and may include all users assigned to the role.
- Contacts - displays all email contacts for the siteA logically grouped set of content - also web site..
- Profile Fields - shows custom user profile fields used on this siteA logically grouped set of content - also web site..
- URL Aliases - shows URL Aliases that are defined along with broken and duplicate links. The alias numbers and node IDs are hyper linked to ease corrections.
- A few other little "goodies" - these are documented below.
I had discovered some time ago, that the "blocks" table can have rows defined for themes that were tested and discarded. This moduleAn add-on, or extension, to Drupal to provide additional functionality; written in PHP. allows you to delete them if you would like. If any are found, a warning message will be issued, and if you don't choose to delete them, there will be a SQLStructured Query Language - a language for accessing a database. statement at the end that you can copy and paste into phpMyAdmin.
In my testing, I discovered that I had rows in my "term-nodes" table that belonged to nodes that no longer existed. So I added a check and a delete option that you may choose to run. If you check and don't delete, there will be a SQLStructured Query Language - a language for accessing a database. statement at the end that you can copy and paste into phpMyAdmin.
Another problem that cropped up in my creating this moduleAn add-on, or extension, to Drupal to provide additional functionality; written in PHP. was a long-running / never-ending Cron job. This moduleAn add-on, or extension, to Drupal to provide additional functionality; written in PHP. will now highlight that and gives you an option to fix it.
How Can I Get It?
This moduleAn add-on, or extension, to Drupal to provide additional functionality; written in PHP. has been accepted as a contributed moduleAn add-on, or extension, to Drupal to provide additional functionality; written in PHP.. It is available here. Please post all support requests, bug reports, and feature suggestions on the project issue page.



Drupal site documentation for Drupal 6?
Hallo,
your modul is great, so can you say if it will be aviable for Drupal
Drupal
An open-source content management system that is used on this site and is taking over the world. 6?Best
Thomas
Yes
Yes, it will be. You should post a feature request in the project's issue queue though.