DokuWiki

It's better when it's simple

User Tools

Site Tools


template:ad-hominem

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:ad-hominem [2022-02-12 15:32] – [Dark Mode] sascha-leibtemplate:ad-hominem [2024-03-27 13:11] (current) – [Cookies Banner] sascha-leib
Line 5: Line 5:
 author        : Sascha Leib author        : Sascha Leib
 email         : ad@hominem.info email         : ad@hominem.info
-lastupdate_dt : 2022-01-05 +lastupdate_dt : 2024-02-07 
-compatible    : 2020-07-29 "Hogfather"+compatible    : !Frusterick Manners, !Greebo, Jack Jackrum, Kaos
 depends       : depends       :
-conflicts     : +conflicts     : plugin:cookielaw
 similar       : dokuwiki similar       : dokuwiki
 screenshot_img: http://ad.hominem.info/img/template-screenshot_04.jpg screenshot_img: http://ad.hominem.info/img/template-screenshot_04.jpg
-tags          : !beta, responsive, sidebar, mobile, print, html5, css3, semantic, clean, dark, dark-mode, customizable, minimal, accessible+tags          : responsive, sidebar, mobile, print, html5, css3, semantic, clean, dark, dark-mode, customizable, minimal, accessible, subsite, kaos
  
-downloadurl   : https://github.com/saschaleib/dokuwiki-template-ad-hominem/archive/refs/tags/0.5.3.zip+downloadurl   : https://github.com/saschaleib/dokuwiki-template-ad-hominem/archive/refs/tags/2024-02-07.zip
 bugtracker    : https://github.com/saschaleib/dokuwiki-template-ad-hominem/issues bugtracker    : https://github.com/saschaleib/dokuwiki-template-ad-hominem/issues
 sourcerepo    : https://github.com/saschaleib/dokuwiki-template-ad-hominem sourcerepo    : https://github.com/saschaleib/dokuwiki-template-ad-hominem
Line 20: Line 20:
 This is an attempt to create a very simple and lightweight template for DokuWiki that stays true to the ideas of the original design, but modernizes the code and improve on the usability. This is an attempt to create a very simple and lightweight template for DokuWiki that stays true to the ideas of the original design, but modernizes the code and improve on the usability.
  
-It was designed to work for [[https://ad.hominem.info/|my DokuWiki site of the same name]] but may be useful for others, too.+It was designed to work for my DokuWiki site of the same name (now migrated to [[https://denkfehler.online/wiki/hauptseite/|Denkfehler Online]]), but may be useful for others, too.
  
-Please keep in mind that this is still "work in progress", and this template may not be ready for production use on other sitesUse with care.+This is provided "as is", with no explicit or implied claim to be usable for any specific purposeIt is well tested and fine-tuned, but you are using it at your own risk.
  
 Feedback and bug reports are of course always welcome :-) Feedback and bug reports are of course always welcome :-)
Line 33: Line 33:
     * This also works for Wikipedia links!     * This also works for Wikipedia links!
   * Looks good in print.   * Looks good in print.
-  * Tries to implement [[https://www.w3.org/TR/WCAG21/|WCAG 2.1]] Level AA (not quite there yetbut this is definitely a goal!+  * The template implements [[https://www.w3.org/TR/WCAG21/|WCAG 2.1]] Level AA (howeverthe DokuWiki content renderer has some limitations) 
-  * Neatly formatted and standards-compliant code (where possible – the main page text comes from the DokuWiki renderer and that’s out of my control).+  * [[wp>General Data Protection Regulation|GDPR]]-compliant: does not load external resources like font files or others (note that the [[config:jquerycdn]] setting needs to be set to “local delivery only” for GDPR-compliance
 +  * Neatly formatted and standards-compliant code (where possible – again, the DokuWiki content renderer is the limiting factor)
   * Makes better use of larger screens (target is half of a 4K screen), but because the template is fully responsive, smaller is no problem (down to ca. 300px wide)   * Makes better use of larger screens (target is half of a 4K screen), but because the template is fully responsive, smaller is no problem (down to ca. 300px wide)
   * improvements to edit view, media manager, etc.   * improvements to edit view, media manager, etc.
   * User-side controlled “dark mode”, i.e. follows the client side dark mode settings.   * User-side controlled “dark mode”, i.e. follows the client side dark mode settings.
   * Improvements to the default functionality, e.g. a resizeable internal link selection widget, etc.   * Improvements to the default functionality, e.g. a resizeable internal link selection widget, etc.
 +  * Configuration to override the "home"-link (see below)
   * Integrated "Cookies" banner functionality   * Integrated "Cookies" banner functionality
 +  * Compatible with PHP8 and DokuWiki “Kaos”.
  
 ===== Download and Install ====== ===== Download and Install ======
Line 75: Line 78:
   * "The message to display on the Cookie banner": This is a free-text field that allows you to set the text to display. This text is directly copied into a ''<p>'' context in the banner, without escaping. That means you can insert some (inline) HTML for formatting, if needed.   * "The message to display on the Cookie banner": This is a free-text field that allows you to set the text to display. This text is directly copied into a ''<p>'' context in the banner, without escaping. That means you can insert some (inline) HTML for formatting, if needed.
  
-  * "Link to the “More information” page": this is either an internal or external address that the "More information" link shall link to. Internal addresses should look like, e.g. ''about:cookies'' (this is also the default), external addresses start with either <html>http://</html> or <html>https://</html> …+  * "Link to the “More information” page": this is either an internal or external address that the "More information" link shall link to. Internal addresses should look like, e.g. ''about:cookies'' (this is also the default), external addresses start with either ''%%http://%%'' or ''%%https://%%'' … 
 + 
 +==== Override Home Link ==== 
 + 
 +The template has an option to override the "home" link in the settings. What is this good for? Imagine your wiki is not "stand-alone", but rather only a section in your wider website. In this case, you don't want a click on the site name or logo to bring the visitor to the wiki homepage, but rather to your main //site// homepage. Well, this can be done with this option. 
 + 
 +If you enter, for example, "/index.html", the links on the site icon and site name will both lead to this address. In addition, the "home" icon link in the "You are here" navigation (if enabled) will lead to this link, and the wiki homepage will become a normal entry in the site hierarchy. 
 + 
 +Leaving the field empty will keep the original behaviour (home is your wiki homepage) intact.
  
 ===== Dark Mode ===== ===== Dark Mode =====
  
-Starting from version ''0.4.0'', this template features a client-controlled “dark mode”. This means that visitors to your site who have "dark mode" activated on their machines will see the site in a suitable dark colour scheme.+This template supports client-controlled “dark mode”. This means that visitors to your site who have "dark mode" activated on their machines will see the site in a suitable dark colour scheme.
  
 The following screenshots show the light and dark mode side by side: The following screenshots show the light and dark mode side by side:
  
-{{ http://ad.hominem.info/img/template-screenshot_04.jpg | Screenshots in light and dark mode }}+{{ https://denkfehler.online/_template/screenshot_13.jpg | Screenshots in light and dark mode }}
  
 Generally, there is nothing to do for a site admin, but please be aware of this, and make sure to check your site in dark mode from time to time (or in light mode, if you normally use dark mode). Generally, there is nothing to do for a site admin, but please be aware of this, and make sure to check your site in dark mode from time to time (or in light mode, if you normally use dark mode).
Line 89: Line 100:
 There are two potential issues to be aware of: There are two potential issues to be aware of:
  
-  * If you used the "Template Style Settings" to override the default colours, notably to create a custom "dark" appearance, the time when you update to 0.40 would be a good time to review these settings.+  * If you used the "Template Style Settings" to override the default colours, notably to create a custom "dark" appearance, you may want to review these settings.
  
   * If possible, create images in a way that they also work with dark backgrounds. Especially if you use transparency, it would be good to test and see how these look like with a much darker background.   * If possible, create images in a way that they also work with dark backgrounds. Especially if you use transparency, it would be good to test and see how these look like with a much darker background.
Line 99: Line 110:
 ===== Cookies ===== ===== Cookies =====
  
-This template also comes with it’s own implementation of the [[plugin:cookielaw|Cookielaw Plugin]], and as suchalso sets a cookie to remember that the banner has already been shown to the visitor.+This template also comes with its own implementation of the [[plugin:cookielaw|Cookielaw Plugin]], and as suchalso sets a cookie to remember that the banner has already been shown to the visitor.
  
-The “''cookielaw''“ cookie is set for one year (not 10 years as the original), and it can only contain the value “''1''”, which means it can not be used for tracking users. This means it is purely a “technical cookie“ in the sense of the EU’s “E-Privacy Directive.+The “''cookielaw''” cookie is set for one year (not 10 years as the original), and it can only contain the value “''1''”, which means it can not be used for tracking users. This means it is purely a “technical cookie“ in the sense of the EU’s “E-Privacy Directive.
  
 Please keep in mind, however, that the DokuWiki system sets additional cookies, which are explained on [[faq:cookies|another page]]. Please keep in mind, however, that the DokuWiki system sets additional cookies, which are explained on [[faq:cookies|another page]].
 +
 +===== 2-column “compact” print style =====
 +
 +Since 1.5 there is now an option to switch from the default "basic" print style to a more "compact" 2-column style.
 +
 +This "compact" style is typographically more advanced and IMHO also looks a lot better, but it requires some work from the editor to make sure the page works well in print.
 +
 +Most importantly, use the class "''print-wide''" can be used to mark up sections that should span both columns, e.g. for images, tables, etc. 
 +
 +If you use the [[plugin:wrap|Wrap]] plugin, you can simply wrap (pun intended) such a section with:
 +
 +> ''<WRAP print-wide>''
 +>  …
 +> ''</WRAP>''
 +
 +Another option is the [[plugin:adhoctags|Ad.Hoc Tags]] plugin of the same author, which allows you to use a larger number of HTML tags, including the possibility to simply add class names (and other attributes) in your code. Here you could write, e.g.:
 +
 +> ''<aside print-wide>''
 +>  …
 +> ''</aside>''
 +
 +Last but not least: ''<figure>'' blocks are also spanning both columns by default and also have specialized styling to make sure they look good in print (including their ''<figcaption>''s). If you want to override this behaviour, you can keep them in a single column by adding the class ''print-narrow''.
 +
 +Other print-related classes include ''noprint'' and ''print-only'', which do exactly what their names promise.
 +
 +===== HTML Tags =====
 +
 +As of DokuWiki “Jack Jackrum”, embedding HTML tags in the DokuWiki code is no longer supported. In order to still allow semantic markup to be added, the autor of this template also provides a plugin, [[plugin:adhoctags|Ad-Hoc Tags]], which enables //specific// HTML tags in a more Wiki-like syntax.
 +
 +This has been developed with, and is designed to be used with this template (though it is fully useable with other templates as well, of course).
 +
 ===== Visit my site ===== ===== Visit my site =====
  
 The best way to experience this template is by browsing my sites, which make full use of it: The best way to experience this template is by browsing my sites, which make full use of it:
  
-  * [[https://ad.hominem.info/|Ad Hominem Info]] +  * [[https://denkfehler.online/wiki/hauptseite/|Denkfehler Online]] 
-  * [[https://denkfehler.online/hauptseite|Denkfehler Online]]+  * [[https://fallacies.online/wiki/index|Fallacies Online]]
  
template/ad-hominem.1644676332.txt.gz · Last modified: 2022-02-12 15:32 by sascha-leib

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