Page 1 of 1

Documentation in themes

Posted: Mon Aug 11, 2014 2:18 pm
by onli
Is there a way to add documentation to themes such that it is accessible from inside the backend (a bit like with plugins?). Or a way to add a link to en external manual?

Re: Documentation in themes

Posted: Mon Aug 11, 2014 2:37 pm
by garvinhicking
onli wrote:Is there a way to add documentation to themes such that it is accessible from inside the backend (a bit like with plugins?). Or a way to add a link to en external manual?
The config.inc.php does offer customization options, you could use a "info" configuration type to add a HTML output linking to a documentation.html file or something like that, or to a webpage...?

It would be a bit hidden though, because the user has to go to the config option panel before they can see it (in 1.7 it was displayed on the same page, only with 2.0 this is an issue now)

Re: Documentation in themes

Posted: Mon Aug 11, 2014 2:38 pm
by Timbalu
In themes config.inc via

Code: Select all

$template_config = array(
array(
'var' => 'about',
'name' => 'Template Readme',
'type' => 'custom',
'custom' => THEME_ABOUT
),
...
or by adding a 'Summary:' info text option in info.txt and then make this generally avail-/readable by the plugin/theme list info button layer in 2.0.

Ups. Already answered.

Or by info.txt Name: theme name +(link to readme)

Re: Documentation in themes

Posted: Mon Aug 11, 2014 2:57 pm
by onli
Thx guys! I will try out how that looks in 2.0.