doc and reality

Creating and modifying plugins.
Post Reply
Timbalu
Regular
Posts: 4598
Joined: Sun May 02, 2004 3:04 pm

doc and reality

Post 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?
Regards,
Ian

Serendipity Styx Edition and additional_plugins @ https://ophian.github.io/ @ https://github.com/ophian
garvinhicking
Core Developer
Posts: 30022
Joined: Tue Sep 16, 2003 9:45 pm
Location: Cologne, Germany
Contact:

Re: doc and reality

Post 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
# Garvin Hicking (s9y Developer)
# Did I help you? Consider making me happy: http://wishes.garv.in/
# or use my PayPal account "paypal {at} supergarv (dot) de"
# My "other" hobby: http://flickr.garv.in/
Timbalu
Regular
Posts: 4598
Joined: Sun May 02, 2004 3:04 pm

Re: doc and reality

Post 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.... :roll:
Regards,
Ian

Serendipity Styx Edition and additional_plugins @ https://ophian.github.io/ @ https://github.com/ophian
garvinhicking
Core Developer
Posts: 30022
Joined: Tue Sep 16, 2003 9:45 pm
Location: Cologne, Germany
Contact:

Re: doc and reality

Post by garvinhicking »

Hi!

Ich habs mal überarbeitet, danke!

Grüße,
Garvin
# Garvin Hicking (s9y Developer)
# Did I help you? Consider making me happy: http://wishes.garv.in/
# or use my PayPal account "paypal {at} supergarv (dot) de"
# My "other" hobby: http://flickr.garv.in/
Post Reply