[documentation] Cleaning up the about section of the Drupal
handbook
puregin
puregin at puregin.org
Mon Feb 13 01:11:05 UTC 2006
On 11-Feb-2006, at 8:37 AM, Kieran Lal wrote:
> Hi, we had a chance to get some feedback on the about section of
> the handbook at DrupalCon. I'd like to see some small editing of
> these about pages and their child pages. If you are willing to
> help edit these pages please respond on thread.
>
-1.) OK, so I'm not adding these items linearly. Sorry. Anyway,
this is important, so it goes first... there was discussion at the
OSCMS Drupal documentation session about standardizing terminology.
One of the words brought up was 'handbook'. Are we going to start
replacing this term with 'document/documentation/....?'
0.) I have fixed many of the broken image links in the About Drupal
handbook.
1.) Since there is now so much more activity with the Drupal
documentation, I am going to update the PDF versions or the handbooks
daily, rather than weekly. These can be found at
http://www.puregin.org/Drupal-handbooks
For what it's worth, I will also include the outline for each book
(generated as a text file).
2.) Dries has installed the Export DXML module on
scratch.drupal.org. I have used this to successfully export all of
the books into XML format. I was able to fix 97 typos and other
errors, over 86 pages in the 'About Drupal' book, in under an hour,
using the spell-checker for my editor. I'm working on tools to
automatically fix up HTML for entire books.
The next step is re-importing the changes. Clearly this needs to be
very well tested before we apply it to Drupal.org. I'm in the
process of testing this code, expanding some functionality, and
improving usability. Once this is done, I'd like to install on
scratch.drupal.org to test this 'live'. At that point I'll ask for
some volunteers to help me with testing. If all goes well, we should
have these tools available on drupal.org once it rolls over to 4.7!
I hope that these tools will make life easier for Steven Peck,
Kieran, and others who are doing bulk editing tasks.
Questions, comments, offers of assistance... please contact me via
drupal.org. (http://drupal.org/user/9170)
Djun
More information about the documentation
mailing list