This tag is for questions about documenting the code. Questions asking for tutorials or other off-site resources are off-topic for us.

learn more… | top users | synonyms

1
vote
0answers
32 views

Codesniffer validation of @mainpage

When I add an @mainpage block to a .module file this file doesn't validate when I run phpcs. I always get ERROR | [ ] Missing short description in doc comment Does anybody know how to fix this? ...
1
vote
0answers
17 views

Resources for Webform Internals? [closed]

I am looking for resources that explain how Webform works on the inside: the relevant tables, how the structured arrays work, API and the like. Has anyone come across such a thing? Books, tutorials, ...
1
vote
0answers
168 views

Advanced search syntax “cheat sheet” or end-user documentation/reference for Apache Solr? [closed]

Using the Apache Solr Search module, is there any documentation focused on end-users, especially related to advanced search query syntax? Or is all the advanced syntax exposed only as an API and not ...
0
votes
1answer
47 views

Suggestions for Adding Documentation to a Drupal Application

I've built a pretty robust application using Drupal and currently have documentation available for the end users via a simple link to a pdf document. I wondered if anyone had suggestions on how to ...
13
votes
0answers
270 views

Definitive list of render array properties [closed]

So, I've been working on getting into Drupal 7, and render arrays are presenting a massive challenge for me. All the documentation I can find says that the Forms API documentation is compatible with ...
2
votes
0answers
195 views

Where can I get MySQL structure documentation for drupal? [closed]

I want to understand the way things are structured in mysql database. Where can I get documentation on the meaning of various table columns in database?
5
votes
7answers
375 views

Where is Drush documentation? [closed]

On the official Drush page (https://drupal.org/project/drush) there is no documentation for installing Drush through PEAR. That page points you to the github repos that points you to the README that ...
1
vote
1answer
103 views

How to use the TableForm module? [closed]

How does one use the TableForm module? There doesn't seem to be any documentation and I can't seem to find any reference to it anywhere in my D7 site after I've enabled it (and the included example ...
2
votes
2answers
202 views

Table Description Documentation [closed]

Is there a document that briefly describes Drupal 7 tables, their general use, common issues, growth patterns, and the effect of truncating? I'm not understand why my database grew from 11MB last ...
1
vote
1answer
170 views

End-user Documentation Generation

Is there a way to automatically generate end-user documentation (likely in a stubbed or skeletal format) for content types that you have setup? Perhaps there is a module that does this?
4
votes
1answer
96 views

How were api.drupal.org and drupalcontrib.org built? [closed]

I have always found them useful and I may be looking to build something similar from another code base. I am guessing that there is something like a migrate from doxygen. But I would assume that ...
1
vote
1answer
164 views

Documenting development process [closed]

I want to document development process, so people who will later support the site would be able to easily understand, for example, why this particular view is made in this particular way, how it works ...
4
votes
2answers
1k views

Where can I find complete documentation of hook_field_info?

When I looked into the API documentation page of hook_field_info, it seems to be quite complete. But I could not see the complete details of the return array ingredients. Why cannot I find the ...
0
votes
2answers
1k views

How to Style the OM Maximenu using an AT Base Theme in Drupal 7 [closed]

I am trying to install the Om Maximenu while keeping the AT Base Theme's menu styling. I have followed the following instruction: Main Menu - You have the option to make this as your main menu. ...
0
votes
1answer
35 views

Where else can I look for info on missing feature between versions? [closed]

I needed to find which tables my installed version of the module draggableviews was installing, because the draggableviews Issue queue says so. I find this post on the command drush schema-describe ...
2
votes
1answer
51 views

How do I update the documentation on someone elses module?

I want to update the documentation on the Agenda module on Drupal to provide a bit more clarity on how to get it set up. I have contacted the author and he said great! How do I do this on drupal.org?...
2
votes
4answers
2k views

A module for generating a report on Drupal 7 website structure and more

I would like to generate a report (website, pdf, etc.) which contains all structural information concerning my Drupal website. This would be very useful for many things: site documentation, site ...
1
vote
1answer
197 views

Drupal Table Documentation

I haven't been able to find good documentation on this subject, but is there documentation out there that explains what each table in a core Drupal installation is for and how Drupal interacts with it?...
1
vote
2answers
241 views

Is there a Drupal Wiki documentation site?

Like on other Drupal support sites, there are many questions and very few answers here. The community appears to divide into two Drupal groups, coders and users. I am a user trying to make a website ...
1
vote
2answers
2k views

How do I find out the content type within template.php?

I'm using THEME_page_alter to give my site a meta description, and is working fine. However I can't find the variable which defines the content type - I need to use it as an argument to give different ...
3
votes
2answers
386 views

Illustrated Drupal 7 Documentation for end users

I am making documentation for my client, with sections such as "How to add contents with inline images and videos", "How to create pages" etc. Is there existing reusable and easily understandable ...
2
votes
0answers
408 views

Embed videos using the YoxView module

How is it possible to embed videos using the YoxView module in Drupal 7? Alas, this module doesn't seem to have documentation on how to use it. It seems ALL possible on the YoxView Official Website. ...
1
vote
2answers
458 views

Mapping web design concepts to Drupal concepts [closed]

I'm looking for resources on 'intermediate' Drupal education. Most of what I've found is either too beginner (Here's how to make a web page with your name and a picture of your cat on it!) or too ...
6
votes
3answers
3k views

What are the different types of hooks?

In an old blog post, Larry Garfield refers to "registry-style" hooks and hook_nodeapi type hooks. When it comes to breaking down the different types of hooks, there doesn't seem to be any ...
1
vote
1answer
109 views

What is the default value for $operator in condition()?

Looking at the documentation for QueryConditionInterface::condition(), the default value for $operation is reported to be NULL, while Conditional clauses reports the default value is '='. What is the ...
1
vote
1answer
323 views

Is there a good editor's guide?

I am starting to let some editors onto my site, and I have been asked to write some documentation. I am very aware: that extensively documenting Drupal administration is a time consuming task that ...
2
votes
1answer
3k views

Views theming basics

I'm starting with Drupal 7 and Views 3, and I want to learn how to modify the templates of my own views. This sentence in the Views project page worries me since I cannot use Views 2 with Drupal 7: ...
3
votes
2answers
1k views

Where can I find a guide to convert an existing site layout to a Drupal theme?

I plan to gradually transfer a website to Drupal; the first step is to convert the existing layout to a Drupal theme, but unfortunately the official documentation for doing this has not yet been ...
3
votes
4answers
6k views

What does “sanitized” mean (in api documentation)?

Hi I see the word "sanitized" quite often in Drupal API documentation. For example, this page: theme_username($variables) $variables An associative array containing: account: The user ...
2
votes
1answer
135 views

Documentation for the API exposed from Pressflow

Reading How do Pressflow Drupal sites handle user Cookies?, I discovered that Pressflow 6 has a function that is not present in Drupal 6, but that is defined in Drupal 7; although, the code for that ...