[drupal-docs] Stylesheet

[Ron Mahon]

Please consider 
A list of dependencies I.E. database tables. special cron process. etc.
Capability problems.
Works well with .........
Screen shots
I defy any one to tread thru the taxonomy maze with out installing the
various modules just to see what the do and how the relate to each other.
Ron
 
 
 

  _____  

From: Anisa [mailto:mystavash at animecards.org] 
Sent: Friday, April 01, 2005 2:20 AM
To: drupal-docs at drupal.org
Subject: Re: [drupal-docs] Stylesheet


If by media, you mean things like the video mentioned earlier, I put that at
the end as other sources of reference.  If by that you mean screen shots, I
think those would just go along side the text, but need to be tested out
before figuring out a proper style.

I was only thinking of the actual handbook page, so I didn't consider
comments.  By comments, do you mean, perhaps, like a log entry?

Also I would like to see a standard way of referring paths... there's this:
When describing how to get to a specific user interface option (e.g. the add
vocabulary option in the categories section of the administer screen)
demarcate the path needed to access the option using this format:
destination (<i>path &gt; to &gt; item &gt; destination</i>)
Which will yield text that looks like this:
destination (path > to > item > destination)

But, what about local tasks (usually displayed as tabs) and sections in a
file?

Anisa.

Kieran Lal wrote:


I think a template for documentation is a great idea. 

The only thing I would add would be a place for media to be added and a
place for comments to be added that would be hidden. 

Cheers, 
Kieran 
On Mar 29, 2005, at 6:45 AM, Anisa wrote: 



This is just a suggestion for how a page might go...  feel free to comment
change whatever.  The end result should be something we can keep consistent
across all handbook pages and is useful/understandable to the end user. 

======================= 
Modules >> Installation 
Target: This page is aimed at anyone who is running a Drupal site (Drupal
site admins), who has downloaded a module and wants to install it. 
Topics covered: How to install a module. 
You need to know: How to open a tarball, how to upload files to your Drupal
site (either by FTP or...whatever else there is ;p) 

Related topics: How to make a module, uninstalling a module, themeing a
module. 

Background information: Blah blah as short and blessedly brief as possible. 

Step by step instructions. 
1. This is a sentence.  Screenshots and example code should be included as
much as possible. 
2. This is a techy word: XKLJHIUYS (should include link to glossary entry) 
3... 

Troubleshooting/common questions: I don't see my module in the module list,
Error: invalid xyz, Can't open install file, how to make my module the front
page? 

Other sources of help: Link to any available videos, alternative
documentation. 

======================================== 

Criticism welcome.  My feelings won't be hurt.  ;) 

By the way, why does marking something as code reduce the font to that
horrible to read size? It's like half normal text. 
Anisa. 
-- 
[ drupal-docs | http://lists.drupal.org/listinfo/drupal-docs ] 





-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://drupal3.drupal.org/pipermail/documentation/attachments/20050401/5065a0de/attachment.htm