Page 1 of 1
doc and reality
Posted: Fri Feb 18, 2011 12:13 pm
by Timbalu
Just a short question.
In the Best Practice / Coding Style Doc section it says under Coding Style for Plugins_
* If you want to write documentation for a plugin, write HTML markup (without <html> and <body> tags!) and save it all in a documentation_XX.html file. XX is the code for the specific language. Save UTF-8 versions of the file in the UTF-8 subdirectory. (NOTE: This is Work in Progress and is not yet supported by Serendipity, but will be in the future!)
Is this (the without <html> and <body> tags) still true? Why?
Re: doc and reality
Posted: Fri Feb 18, 2011 3:20 pm
by garvinhicking
Hi!
I think the body/head thing is not really true anymore; I think we directly link to the documentation files. The idea first was to embedd the documentation inside the s9y interface, but I think this has never been achieved.
I would need to have a look at current plugins to see how they implemented it...
Regards,
Garvin
Re: doc and reality
Posted: Fri Feb 18, 2011 3:58 pm
by Timbalu
garvinhicking wrote:I think the body/head thing is not really true anymore; I think we directly link to the documentation files. The idea first was to embedd the documentation inside the s9y interface, but I think this has never been achieved.
Yes, it is a direct link only AFAIK and as I just stumbled across that doc entry, I felt unsure if I have missed something in the meanwhile.
So this is just another hint to some general cleanup of the docs in future....
Re: doc and reality
Posted: Mon Feb 21, 2011 10:19 am
by garvinhicking
Hi!
Ich habs mal überarbeitet, danke!
Grüße,
Garvin