Documentation in themes

Skinning and designing Serendipity (CSS, HTML, Smarty)
Post Reply
User avatar
onli
Regular
Posts: 2243
Joined: Tue Sep 09, 2008 10:04 pm
Contact:

Documentation in themes

Post by onli » Mon Aug 11, 2014 2:18 pm

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?

User avatar
garvinhicking
Core Developer
Posts: 30020
Joined: Tue Sep 16, 2003 9:45 pm
Location: Cologne, Germany
Contact:

Re: Documentation in themes

Post by garvinhicking » Mon Aug 11, 2014 2:37 pm

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)
# 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/

User avatar
Timbalu
Regular
Posts: 4598
Joined: Sun May 02, 2004 3:04 pm

Re: Documentation in themes

Post by Timbalu » Mon Aug 11, 2014 2:38 pm

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)
Regards,
Ian

Serendipity Styx Edition and additional_plugins @ https://ophian.github.io/ @ https://github.com/ophian

User avatar
onli
Regular
Posts: 2243
Joined: Tue Sep 09, 2008 10:04 pm
Contact:

Re: Documentation in themes

Post by onli » Mon Aug 11, 2014 2:57 pm

Thx guys! I will try out how that looks in 2.0.

Post Reply