Permalink
Browse files

use new core functionalities where possible and deprecated old fallbacks

  • Loading branch information...
selfthinker committed Sep 9, 2012
1 parent 771faa7 commit 8dc924f7fe39b731f64a6d9f07908e4a35575e20
Showing with 83 additions and 41 deletions.
  1. +2 −2 conf/default.php
  2. +2 −2 conf/metadata.php
  3. +1 −1 lang/en/lang.php
  4. +2 −2 lang/en/settings.php
  5. +9 −9 main.php
  6. +67 −25 tpl_functions.php
View
@@ -4,8 +4,8 @@
*
*/
-$conf['tagline'] = 'This is the tagline - explaining what this site is about.';
$conf['discussionPage'] = 'discussion:@ID@';
$conf['userPage'] = 'user:@USER@:';
-$conf['sidebarID'] = 'sidebar';
$conf['hideTools'] = 0;
+$conf['tagline'] = 'This is the tagline - explaining what this site is about.';
+$conf['sidebarID'] = 'sidebar';
View
@@ -4,8 +4,8 @@
*
*/
-$meta['tagline'] = array('string');
$meta['discussionPage'] = array('string');
$meta['userPage'] = array('string');
-$meta['sidebarID'] = array('string');
$meta['hideTools'] = array('onoff');
+$meta['tagline'] = array('string');
+$meta['sidebarID'] = array('string');
View
@@ -8,7 +8,7 @@
$lang['back_to_article'] = 'Back to article';
$lang['userpage'] = 'User page';
-/* accessibility headlines */
+/* accessibility headlines (deprecated and superseded by core since Adora Belle) */
$lang['user_tools'] = 'User Tools';
$lang['site_tools'] = 'Site Tools';
$lang['page_tools'] = 'Page Tools';
View
@@ -4,8 +4,8 @@
*
*/
-$lang['tagline'] = 'Tagline';
$lang['discussionPage'] = 'Discussion page (leave empty to disable discussions)';
$lang['userPage'] = 'User page (leave empty to disable user pages)';
-$lang['sidebarID'] = 'page name of page included in sidebar';
$lang['hideTools'] = 'Hide tools when not logged in?';
+$lang['tagline'] = 'Tagline (<strong>deprecated</strong>, use core &quot;tagline&quot; setting since Adora Belle)';
+$lang['sidebarID'] = 'page name of page included in sidebar (<strong>deprecated</strong>, use core &quot;sidebar&quot; setting since Adora Belle)';
View
@@ -47,12 +47,12 @@ class="dokuwiki site mode_<?php echo $ACT ?>">
<?php /* how to insert logo instead (if no CSS image replacement technique is used):
upload your logo into the data/media folder (root of the media manager) and replace 'logo.png' accordingly:
tpl_link(wl(),'<img src="'.ml('logo.png').'" alt="'.$conf['title'].'" />','id="dokuwiki__top" accesskey="h" title="[H]"') */ ?>
- <?php if (tpl_getConf('tagline')): ?>
- <p class="claim"><?php echo tpl_getConf('tagline') ?></p>
+ <?php if ($conf['tagline']): ?>
+ <p class="claim"><?php echo $conf['tagline'] ?></p>
<?php endif ?>
<ul class="a11y">
- <li><a href="#dokuwiki__content"><?php echo tpl_getLang('skip_to_content') ?></a></li>
+ <li><a href="#dokuwiki__content"><?php echo $lang['skip_to_content'] ?></a></li>
</ul>
<div class="clearer"></div>
</div>
@@ -61,10 +61,10 @@ class="dokuwiki site mode_<?php echo $ACT ?>">
<!-- USER TOOLS -->
<?php if ($conf['useacl'] && $showTools): ?>
<div id="dokuwiki__usertools">
- <h3 class="a11y"><?php echo tpl_getLang('user_tools') ?></h3>
+ <h3 class="a11y"><?php echo $lang['user_tools'] ?></h3>
<ul>
<?php /* the optional second parameter of tpl_action() switches between a link and a button,
- e.g. a button inside a <li> would be: tpl_action('edit',0,'li') */
+ e.g. a button inside a <li> would be: tpl_action('edit', 0, 'li') */
if ($_SERVER['REMOTE_USER']) {
echo '<li class="user">';
tpl_userinfo(); /* 'Logged in as ...' */
@@ -73,7 +73,7 @@ class="dokuwiki site mode_<?php echo $ACT ?>">
tpl_action('admin', 1, 'li');
_tpl_action('userpage', 1, 'li');
tpl_action('profile', 1, 'li');
- _tpl_action('register', 1, 'li'); /* DW versions > 2011-02-20 can use the core function tpl_action('register', 1, 'li') */
+ tpl_action('register', 1, 'li'); /* DW versions < 2011-02-20 need to use _tpl_action('register', 1, 'li') */
tpl_action('login', 1, 'li');
?>
</ul>
@@ -82,7 +82,7 @@ class="dokuwiki site mode_<?php echo $ACT ?>">
<!-- SITE TOOLS -->
<div id="dokuwiki__sitetools">
- <h3 class="a11y"><?php echo tpl_getLang('site_tools') ?></h3>
+ <h3 class="a11y"><?php echo $lang['site_tools'] ?></h3>
<?php tpl_searchform() ?>
<ul>
<?php
@@ -113,7 +113,7 @@ class="dokuwiki site mode_<?php echo $ACT ?>">
<!-- ********** ASIDE ********** -->
<div id="dokuwiki__aside"><div class="pad include">
- <?php tpl_include_page(tpl_getConf('sidebarID')) /* includes the given wiki page */ ?>
+ <?php tpl_sidebar() /* includes the nearest sidebar page */ ?>
<div class="clearer"></div>
</div></div><!-- /aside -->
@@ -139,7 +139,7 @@ class="dokuwiki site mode_<?php echo $ACT ?>">
<!-- PAGE ACTIONS -->
<?php if ($showTools): ?>
<div id="dokuwiki__pagetools">
- <h3 class="a11y"><?php echo tpl_getLang('page_tools') ?></h3>
+ <h3 class="a11y"><?php echo $lang['page_tools'] ?></h3>
<ul>
<?php
tpl_action('edit', 1, 'li');
View
@@ -16,26 +16,26 @@
*
* @author Anika Henke <anika@selfthinker.org>
*/
-function _tpl_discussion($discussionPage,$title,$backTitle,$link=0,$wrapper=0) {
+function _tpl_discussion($discussionPage, $title, $backTitle, $link=0, $wrapper=0) {
global $ID;
- $discussPage = str_replace('@ID@',$ID,$discussionPage);
- $discussPageRaw = str_replace('@ID@','',$discussionPage);
- $isDiscussPage = strpos($ID,$discussPageRaw)!==false;
- $backID = str_replace($discussPageRaw,'',$ID);
+ $discussPage = str_replace('@ID@', $ID, $discussionPage);
+ $discussPageRaw = str_replace('@ID@', '', $discussionPage);
+ $isDiscussPage = strpos($ID, $discussPageRaw) !== false;
+ $backID = str_replace($discussPageRaw, '', $ID);
if ($wrapper) echo "<$wrapper>";
if ($isDiscussPage) {
if ($link)
- tpl_pagelink($backID,$backTitle);
+ tpl_pagelink($backID, $backTitle);
else
- echo html_btn('back2article',$backID,'',array(),'get',0,$backTitle);
+ echo html_btn('back2article', $backID, '', array(), 'get', 0, $backTitle);
} else {
if ($link)
- tpl_pagelink($discussPage,$title);
+ tpl_pagelink($discussPage, $title);
else
- echo html_btn('discussion',$discussPage,'',array(),'get',0,$title);
+ echo html_btn('discussion', $discussPage, '', array(), 'get', 0, $title);
}
if ($wrapper) echo "</$wrapper>";
@@ -46,29 +46,29 @@ function _tpl_discussion($discussionPage,$title,$backTitle,$link=0,$wrapper=0) {
*
* @author Anika Henke <anika@selfthinker.org>
*/
-function _tpl_userpage($userPage,$title,$link=0,$wrapper=0) {
+function _tpl_userpage($userPage, $title, $link=0, $wrapper=0) {
if (!$_SERVER['REMOTE_USER']) return;
global $conf;
- $userPage = str_replace('@USER@',$_SERVER['REMOTE_USER'],$userPage);
+ $userPage = str_replace('@USER@', $_SERVER['REMOTE_USER'], $userPage);
if ($wrapper) echo "<$wrapper>";
if ($link)
- tpl_pagelink($userPage,$title);
+ tpl_pagelink($userPage, $title);
else
- echo html_btn('userpage',$userPage,'',array(),'get',0,$title);
+ echo html_btn('userpage', $userPage, '', array(), 'get', 0, $title);
if ($wrapper) echo "</$wrapper>";
}
/**
* Create link/button to register page
- * DW versions > 2011-02-20 can use the core function tpl_action('register')
+ * @deprecated DW versions > 2011-02-20 can use the core function tpl_action('register')
*
* @author Anika Henke <anika@selfthinker.org>
*/
-function _tpl_register($link=0,$wrapper=0) {
+function _tpl_register($link=0, $wrapper=0) {
global $conf;
global $lang;
global $ID;
@@ -79,9 +79,9 @@ function _tpl_register($link=0,$wrapper=0) {
if ($wrapper) echo "<$wrapper>";
if ($link)
- tpl_link(wl($ID,'do=register'),$lang_register,'class="action register" rel="nofollow"');
+ tpl_link(wl($ID, 'do=register'), $lang_register, 'class="action register" rel="nofollow"');
else
- echo html_btn('register',$ID,'',array('do'=>'register'),'get',0,$lang_register);
+ echo html_btn('register', $ID, '', array('do'=>'register'), 'get', 0, $lang_register);
if ($wrapper) echo "</$wrapper>";
}
@@ -91,27 +91,34 @@ function _tpl_register($link=0,$wrapper=0) {
*
* @author Anika Henke <anika@selfthinker.org>
*/
-function _tpl_action($type,$link=0,$wrapper=0) {
+function _tpl_action($type, $link=0, $wrapper=0) {
switch ($type) {
case 'discussion':
if (tpl_getConf('discussionPage')) {
- _tpl_discussion(tpl_getConf('discussionPage'),tpl_getLang('discussion'),tpl_getLang('back_to_article'),$link,$wrapper);
+ _tpl_discussion(tpl_getConf('discussionPage'), tpl_getLang('discussion'), tpl_getLang('back_to_article'), $link, $wrapper);
}
break;
case 'userpage':
if (tpl_getConf('userPage')) {
- _tpl_userpage(tpl_getConf('userPage'),tpl_getLang('userpage'),$link,$wrapper);
+ _tpl_userpage(tpl_getConf('userPage'), tpl_getLang('userpage'), $link, $wrapper);
}
break;
- case 'register':
- _tpl_register($link,$wrapper);
+ case 'register': // deprecated
+ _tpl_register($link, $wrapper);
break;
}
}
+
+
+/* deprecated functions for backwards compatibility
+********************************************************************/
+
+
/**
* Returns icon from data/media root directory if it exists, otherwise
* the one in the template's image directory.
+ * @deprecated superseded by core tpl_getFavicon()
*
* @param bool $abs - if to use absolute URL
* @param string $fileName - file name of icon
@@ -130,14 +137,15 @@ function _tpl_getFavicon($abs=false, $fileName='favicon.ico') {
/* use core function if available, otherwise the custom one */
if (!function_exists('tpl_getFavicon')) {
- function tpl_getFavicon($abs=false, $fileName='favicon.ico'){
+ function tpl_getFavicon($abs=false, $fileName='favicon.ico') {
_tpl_getFavicon($abs, $fileName);
}
}
/**
* Returns <link> tag for various icon types (favicon|mobile|generic)
+ * @deprecated superseded by core tpl_favicon()
*
* @param array $types - list of icon types to display (favicon|mobile|generic)
* @author Anika Henke <anika@selfthinker.org>
@@ -166,7 +174,7 @@ function _tpl_favicon($types=array('favicon')) {
/* use core function if available, otherwise the custom one */
if (!function_exists('tpl_favicon')) {
- function tpl_favicon($types=array('favicon')){
+ function tpl_favicon($types=array('favicon')) {
_tpl_favicon($types);
}
}
@@ -175,6 +183,7 @@ function tpl_favicon($types=array('favicon')){
/**
* Include additional html file from conf directory if it exists, otherwise use
* file in the template's root directory.
+ * @deprecated superseded by core tpl_includeFile()
*
* @author Anika Henke <anika@selfthinker.org>
*/
@@ -190,7 +199,40 @@ function _tpl_include($fn) {
/* use core function if available, otherwise the custom one */
if (!function_exists('tpl_includeFile')) {
- function tpl_includeFile($fn){
+ function tpl_includeFile($fn) {
_tpl_include($fn);
}
}
+
+
+/* if newer settings exist in the core, use them, otherwise fall back to template settings */
+
+if (!isset($conf['tagline'])) {
+ $conf['tagline'] = tpl_getConf('tagline');
+}
+
+if (!isset($conf['sidebar'])) {
+ $conf['sidebar'] = tpl_getConf('sidebarID');
+}
+
+if (!function_exists('tpl_sidebar')) {
+ function tpl_sidebar() {
+ /* includes the given wiki page; not exactly the same as in the core */
+ tpl_include_page($conf['sidebar']);
+ }
+}
+
+/* these $lang strings are now in the core */
+
+if (!isset($lang['user_tools'])) {
+ $lang['user_tools'] = tpl_getLang('user_tools');
+}
+if (!isset($lang['site_tools'])) {
+ $lang['site_tools'] = tpl_getLang('site_tools');
+}
+if (!isset($lang['page_tools'])) {
+ $lang['page_tools'] = tpl_getLang('page_tools');
+}
+if (!isset($lang['skip_to_content'])) {
+ $lang['skip_to_content'] = tpl_getLang('skip_to_content');
+}

0 comments on commit 8dc924f

Please sign in to comment.