DokuWiki

It's better when it's simple

User Tools

Site Tools


template:typowiki

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
template:typowiki [2020-08-25 09:08] birdsofparadisetemplate:typowiki [2024-02-01 04:56] (current) – Update version 1.4 birdsofparadise
Line 2: Line 2:
  
 ---- template ---- ---- template ----
-description   : Responsivesimple, grid-based template+description   : Simpleresponsive template for reading
 author        : axlevxa author        : axlevxa
 email         :  email         : 
-lastupdate_dt : 2020-08-25 +lastupdate_dt : 2024-01-31 
-compatible    : 2020-07-29+compatible    : Hogfather, Igor, Jack Jackrum
 depends       : depends       :
 conflicts     :  conflicts     : 
 similar       : similar       :
-screenshot_img:  +screenshot_img: https://raw.githubusercontent.com/axlevxa/typowiki/main/preview2.png 
-tags          : responsive, simple, easy+tags          : responsive, simple, modern
  
-downloadurl   : https://github.com/axlevxa/typowiki/zipball/master +downloadurl   : https://github.com/axlevxa/typowiki/releases/download/1.4/v1_4-typowiki.zip 
-bugtracker    : https://github.com/axlevxa/typowiki/issues +bugtracker    : https://github.com/axlevxa/typowiki/issues 
-sourcerepo    : https://github.com/axlevxa/typowiki +sourcerepo    : https://github.com/axlevxa/typowiki 
-donationurl   : https://www.blackandpink.org/DONATE/+donationurl   : https://kpoo.com/support
 ---- ----
  
-This is a template in the modernist vein, which I have mixed feelings about. Nonetheless, the idea is to make a wiki as simple and easy-to-use as an evil corporate platform like Google Docs. It is designed to match the look and feel people are familiar with and be comfy to read on a desktop or phone.+This is a simple template in the modernist vein, which I have mixed feelings about. It is designed to match the look and feel people are familiar with and be comfy to read on a desktop or phone. It also is simpler to understand at-a-glance than some other templates.
  
 (See [[https://github.com/axlevxa/typowiki|GitHub page]] for screenshots) (See [[https://github.com/axlevxa/typowiki|GitHub page]] for screenshots)
Line 25: Line 25:
 ===== Download and Install ====== ===== Download and Install ======
  
-Visit GitHub to download this template and its extras:+Visit GitHub to download this template and its extras, or use the button above.
  
-  https://github.com/axlevxa/typowiki/zipball/master+  https://github.com/axlevxa/typowiki/releases
  
 Refer to [[:template]] on how to install and use templates in Dokuwiki. Refer to [[:template]] on how to install and use templates in Dokuwiki.
 +
 +If you download the source from GitHub (i.e. not using the download link above), be sure to upload only the folder called "typowiki" to your tpl folder.
  
 ===== Suggested DokuWiki customizations ===== ===== Suggested DokuWiki customizations =====
  
 ==== Localization ==== ==== Localization ====
-This theme has a unique contextual button in the nav bar. To make it as straightforward as possible, I used custom localizations in DokuWiki.+IMPORTANT: This template has a unique contextual button in the nav bar. To make it as straightforward as possible, I use custom localizations in DokuWiki. **If you don't use these, the template may not display properly on small screens.**
  
 For english, I suggest adding the following in your ''conf/lang/en/lang.php'' file. (See [[:localization#changing_some_localized_texts_and_strings_in_your_installation]] for details.) For english, I suggest adding the following in your ''conf/lang/en/lang.php'' file. (See [[:localization#changing_some_localized_texts_and_strings_in_your_installation]] for details.)
Line 42: Line 44:
 $lang['btn_show'       = 'Cancel'; $lang['btn_show'       = 'Cancel';
 $lang['btn_create'     = 'Create'; $lang['btn_create'     = 'Create';
 +$lang['btn_create'     = 'Create';
 +$lang['btn_source'     = 'Source';
 $lang['loggedinas'     = ''; $lang['loggedinas'     = '';
 $lang['lastmod'        = 'Last edit was'; $lang['lastmod'        = 'Last edit was';
 </code> </code>
  
-Para español (''conf/lang/es/lang.php''):+Español (''conf/lang/es/lang.php''):
  
 <code> <code>
Line 52: Line 56:
 $lang['btn_show'       = 'Cancelar'; $lang['btn_show'       = 'Cancelar';
 $lang['btn_create'     = 'Crear'; $lang['btn_create'     = 'Crear';
 +$lang['btn_source'     = 'Ver fuente';
 $lang['loggedinas'     = ''; $lang['loggedinas'     = '';
 </code> </code>
 +
 +==== Sidebar Content ====
 +Create a page called 'sidebar' in the root, and add your content there. It will appear in the right-hand sidebar.
 +
 +==== Custom Logo ====
 +Upload a square file called 'logo.png', around 70x70, in your media manager root.
 +
 +==== Section Editing ====
 +If you don't like section editing (I don't), you can disable it by setting ''maxseclevel'' to 0 in your Admin panel. (v1.4+)
  
 ==== Custom Editor Icons ==== ==== Custom Editor Icons ====
-I made some custom retina icons for the edit bar (based on [[https://github.com/stephenhutchings/microns|Microns]]). They're not the greatest, but they are a bit more tasteful to our 2020 sensibilities than the default ones. You can find them in the "extras" folder. To use, just move the png files to ''lib/images/toolbar/''. Keep a backup of the standard ones to be safe.+I made some custom retina icons for the edit bar (based on [[https://github.com/stephenhutchings/microns|Microns]]). They're not the greatest, but they do go with the theme's colors a bit better. You can find them in the "extras" folder over at [[https://github.com/axlevxa/typowiki/|Github]]. To use, just move the png files to ''lib/images/toolbar/''. Keep a backup of the standard ones to be safe.
  
  
-==== Link style overwrites ==== +==== Known issues ==== 
-This plugin overwrites the default dokuwiki link styles for the sake of consistency and simplicity.+ 
 +  * Theme doesn't recognize variables set/changed in "Template Style Settings." FIXME
  
 ===== Plugin Compatibility ===== ===== Plugin Compatibility =====
  
 Looks pretty with [[plugin:nspages|nspages]] and [[plugin:discussion|discussion]]. Looks pretty with [[plugin:nspages|nspages]] and [[plugin:discussion|discussion]].
 +
 +===== Changelog =====
 +
 +  * v1.0 - Release
 +  * v1.1 - Fixed some css bugs, added ability to use a custom logo.
 +  * v1.1.1 - Prevents update warning from showing in Extension Manager when latest version is installed. No other changes.
 +  * v1.2 - All links now have visible outline when focused. Search/user menu are now unified into one, with accessibility and localization improvements. General css improvements.
 +  * v1.3 - fix inline emoji display; confirm compatibility with DokuWiki release Jack Jackrum
 +  * v1.4 - Add support for section editing. Begin updating to new menu system to reduce deprecation logs. (Regression: "Discussion" link vanishes from footer because of new menu system.)
  
 ===== That's it... ===== ===== That's it... =====
-Do something cool, take back control of information from the corporate overlords. Center BIPOC women in your wiki project. PRs welcome.+Do something cool, take back control of information from the corporate overlords <3
template/typowiki.1598339312.txt.gz · Last modified: 2020-08-25 09:08 by birdsofparadise

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki