Welcome to Geeklog Thursday, October 01 2020 @ 09:42 am EDT

Geeklog Forums

Plugin directory - docs and help


Status: offline

ivy

Forum User
Full Member
Registered: 25/11/04
Posts: 313
Location:Tokyo Japan
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?
Geeklog Japan https://www.geeklog.jp
 Quote

Status: offline

Laugh

Site Admin
Admin
Registered: 27/09/05
Posts: 1401
There is no real standard. Maybe we should make one...

We also have the directory <public_html>/help/ which some plugins use

Tom

One of the Geeklog Core Developers.
 Quote

Status: offline

ivy

Forum User
Full Member
Registered: 25/11/04
Posts: 313
Location:Tokyo Japan
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?

Geeklog Japan https://www.geeklog.jp
 Quote

Status: offline

Laugh

Site Admin
Admin
Registered: 27/09/05
Posts: 1401
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.
One of the Geeklog Core Developers.
 Quote

Status: offline

Tsuchi

Forum User
Newbie
Registered: 28/09/04
Posts: 2
Location:Osaka Japan
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 /
 Quote

Status: offline

Tsuchi

Forum User
Newbie
Registered: 28/09/04
Posts: 2
Location:Osaka Japan
my preference is

the admin docs be in the admin directory (ie public_html /admin/plugins/ (plugin_name) / docs / language / (plugin_name). html)

PHP 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">
 

 Quote

Status: offline

Laugh

Site Admin
Admin
Registered: 27/09/05
Posts: 1401
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
One of the Geeklog Core Developers.
 Quote

Status: offline

ivy

Forum User
Full Member
Registered: 25/11/04
Posts: 313
Location:Tokyo Japan
Tom,

Thanks!
It's nice,

Geeklog Japan https://www.geeklog.jp
 Quote

All times are EDT. The time is now 09:42 am.

  • Normal Topic
  • Sticky Topic
  • Locked Topic
  • New Post
  • Sticky Topic W/ New Post
  • Locked Topic W/ New Post
  •  View Anonymous Posts
  •  Able to post
  •  Filtered HTML Allowed
  •  Censored Content