I'm not really fluent in english. So I would like somebody to check the doc and the help to correct bad english grammar and to make it more understandable.

Any help is wellcome
thanks

Dpdev

CommentFileSizeAuthor
#6 help_3.patch9.49 KBdvessel

Comments

pitpit’s picture

Assigned: pitpit » Unassigned

oups "unassign" for the moment

dvessel’s picture

Which part did you need help with? If it doesn't require a technical explanation then I can certainly try to help. The stuff I read seems fine, and maybe that's why I shouldn't touch it. ;) How can I correct something where I don't see a problem?

Tell me what the problem is and we'll see what happens.

pitpit’s picture

I was talking about the filter tips (when you submit something you can have help on usable tags, eg: http://drupal.org/filter/tips), every labels in geshifilter settings and in input format, and the documentation.

But If everything sounds good and clear for you, I may not be as bad in english as I thought ;)

dvessel’s picture

Assigned: Unassigned » dvessel

Okay, I'll try to clean it up. There doesn't seem to be a standard though on how it should be marked up. I have textile & smartypants and they litter the page with header tags.

I guess I'll just focus on how it's worded. I'm not sure on how to create patch files so I have to look that up also. Will post when it's ready.

pitpit’s picture

great !!!
thanks
here's HOWTO create a patch
dpdev

dvessel’s picture

StatusFileSize
new9.49 KB

Sorry I took so long. -had other duties I changed the structure of how the tips are presented. It's basically like this.

<h2>GeSHi</h2> 
-GeSHi one liner.
-information on current settings/what's available.
-list of language.
<h3>usage</h3>
-blockcode usage instruction
-example
-inline usage instructions
-example

I took it upon myself to make the output dependent on setting in geshi so it's a big mess on the back end. I'm sorry about this. Hopefully it isn't too bad. Remember, I'm not much of a coder. Just trying to learn but the presentation is pretty clean.

The examples usage instructions are not presented twice like before. I thought that was unnecessary. The type and start parameters get inserted into the single sample. So everything is as short as possible and gives the most important information I think.

Hope you commit. :)

dvessel’s picture

Status: Active » Needs review

Whoops, please review. Take care.

pitpit’s picture

I will have a look on it and will commit it
thanks for your work !!!

Dpdev

pitpit’s picture

waooo I just had a look on the patch. The result is really good but the code seems difficult to maintain and debug (specially the multiple imbricated t functions)... :)

dvessel’s picture

Heh, yeah.. sorry bout that. Being that bad, don't commit it. Not sure what would give the same output. Multiple if-else statements or should the code be as simple as the presentation? Don't mean to waste your time with such a simple matter.

I'll play around with it but if someone else with more experience wants to volunteer then please do so.

soxofaan’s picture

Version: 6.x-1.x-dev » 4.7.x-1.0
Assigned: dvessel » soxofaan
Status: Needs review » Closed (fixed)

I think this issue can be closed because the rewrite for Drupal 5 involved a lot of documentation (re)writing too.