Posted on: 10/12/11 04:01am
By: ivy
Where is the best directory for plugin's document?
1. documents for admin user
<public_html>/admin/<Plugin name>/docs/japanese/*****.html
(for admin panel and configuration help)
2. help for user
<public_html>//<Plugin name>/help/japanese/*****.html
Right?
Re: Plugin directory - docs and help
Posted on: 10/13/11 09:25am
By: Laugh
There is no real standard. Maybe we should make one...
We also have the directory <public_html>/help/ which some plugins use
Tom
??: Plugin directory - docs and help
Posted on: 10/13/11 10:23am
By: ivy
There is no real standard. Maybe we should make one...
Please.
We also have the directory <public_html>/help/ which some plugins use
core plugin use /docs/(language)/.
Can other plugins use this directory, too?
Re: Plugin directory - docs and help
Posted on: 10/13/11 04:22pm
By: Laugh
Quote by: ivy
core plugin use /docs/(language)/.
Can other plugins use this directory, too?
I would rather not. I would actually like to unbundle the core plugins from Geeklog (at some point). I would still keep them as part of the Geeklog install but make them completely independant of Geeklog (there are only a few things left to do).
Do you think we can keep all the online documents for a plugin under public_html/plugin_name/docs/language/ or should the admin docs be in the admin directory (ie public_html/admin/plugin_name/docs/language/)?
Does anyone else have a preference?
I wonder also if we should use the language code for the language directory? This way Geeklog could automatically point the user to the docs in the language the user is using to view the site.
??: Plugin directory - docs and help
Posted on: 10/17/11 08:45pm
By: Tsuchi
public_html / (plugin_name) / docs / language / (plugin_name). html
( or public_html /admin/plugins/ (plugin_name) / docs / language / (plugin_name). html)
Want to relation the following files:
public_html / docs / docstyle.css
public_html / docs / language / docstyle.css
public_html / docs / images /
??: Plugin directory - docs and help
Posted on: 10/18/11 07:29am
By: Tsuchi
my preference is
the admin docs be in the admin directory (ie public_html /admin/plugins/ (plugin_name) / docs / language / (plugin_name). html)
Text Formatted Code
<link rel="stylesheet" type="text/css" href="../../../../../docs/docstyle.css " title="Dev Stylesheet">
<link rel="stylesheet" type="text/css" href="../../../../../docs/japanese/docstyle.css " title="Dev Stylesheet">
Re: Plugin directory - docs and help
Posted on: 10/18/11 10:23am
By: Laugh
How about this then:
1. documents for admin user
<public_html>/admin/<Plugin name>/docs/japanese/*****.html
(for admin panel and configuration help)
2. documents/help for user
<public_html>/<Plugin name>/docs/japanese/******.html
I switched the help directory to docs that Ivy suggested just to keep things uniform. We should also always include an index.html file in these directories as a starting point.
Tom
??: Plugin directory - docs and help
Posted on: 10/18/11 12:09pm
By: ivy
Tom,
Thanks!
It's nice,