]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/commitdiff
Merge remote-tracking branch 'origin/master'
authorJoey Hess <joeyh@joeyh.name>
Thu, 28 Apr 2016 23:06:01 +0000 (19:06 -0400)
committerJoey Hess <joeyh@joeyh.name>
Thu, 28 Apr 2016 23:06:01 +0000 (19:06 -0400)
19 files changed:
doc/bugs/Anon_edit_caused_lock_out_on_entire_site_.mdwn [new file with mode: 0644]
doc/bugs/cannot_login.mdwn [new file with mode: 0644]
doc/bugs/footnotes-look-weird.mdwn [new file with mode: 0644]
doc/css_market.mdwn
doc/examples.mdwn
doc/forum/Translating_ikiwiki_interface/comment_1_389a8173abcc0990f6670796c5f8b227._comment [new file with mode: 0644]
doc/forum/bootstrap_theme.mdwn [new file with mode: 0644]
doc/plugins/contrib/admonition.mdwn [new file with mode: 0644]
doc/plugins/contrib/compile.mdwn
doc/plugins/typography.mdwn
doc/theme_market.mdwn
doc/themes/discussion.mdwn
doc/tips/Importing_posts_from_Wordpress.mdwn
doc/tips/bootstrap_themes_evaluation.mdwn
doc/tips/convert_moinmoin_to_ikiwiki.mdwn
doc/tips/dot_cgi.mdwn
doc/todo/admonitions.mdwn [new file with mode: 0644]
doc/todo/compatible_templates.mdwn
doc/users/desci.mdwn

diff --git a/doc/bugs/Anon_edit_caused_lock_out_on_entire_site_.mdwn b/doc/bugs/Anon_edit_caused_lock_out_on_entire_site_.mdwn
new file mode 100644 (file)
index 0000000..a669413
--- /dev/null
@@ -0,0 +1,59 @@
+Probably caused by something misconfigured about the [[plugins/comments]] plugin.
+
+---
+
+## Config
+
+My setup file:
+
+    # comments plugin
+    # PageSpec of pages where comments are allowed
+    comments_pagespec: forum/* or blog/posts/* or tarefa/*
+    # PageSpec of pages where posting new comments is not allowed
+    comments_closed_pagespec: ''
+    # Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"
+    comments_pagename: comment_
+    # Interpret directives in comments?
+    #comments_allowdirectives: 0
+    # Allow anonymous commenters to set an author name?
+    comments_allowauthor: 1
+    # commit comments to the VCS
+    comments_commit: 1
+    # Restrict formats for comments to (no restriction if empty)
+    comments_allowformats: mdwn txt
+
+The `moderatedcomments` plugins is **not** enabled
+
+The `anonok` plugin is **not** enabled
+
+---
+
+## Steps
+
+I've tried to place a comment clicking in the obvious [Add a comment](https://dev.iikb.xyz/ikiwiki.cgi?do=comment&page=forum%2FTema_bootstrap) in a [forum post](https://dev.iikb.xyz/forum/Tema_bootstrap/).
+
+I've not signed in because the *sign in* page didn't come up, instead a simple `(You might want to Signin first?)` showed up, which I've haven't read and commented away.
+
+---
+
+## Results
+
+As a consequence of that, the user '' - that's a null character, have somehow logged in and it seems that there is no way to [log it out](https://dev.iikb.xyz/ikiwiki.cgi?do=prefs).
+
+None of this phantom user edits are being commited - this [blog post](https://dev.iikb.xyz/blog/posts/Bug_severo_neste_site/) was made with that user logged in via web.
+
+It seems I can't log out from nowhere. I've rebuild the wiki from the command line and restarted the nginx server, the phantom user remains logged in and open to anyone willing to edit away the wiki.
+
+---
+
+## Conclusion
+
+If I wanted to do a totally anonnymous wiki, this would be the best setup ever.
+
+For [this particular installation](https://dev.iikb.xyz), that's not the case.
+
+---
+
+## Question
+
+Is there a session file or something to logout this phantom user?
diff --git a/doc/bugs/cannot_login.mdwn b/doc/bugs/cannot_login.mdwn
new file mode 100644 (file)
index 0000000..a4f1295
--- /dev/null
@@ -0,0 +1,40 @@
+I can't seem to login to ikiwiki sites reliably anymore.
+
+I am not sure what is going on. It affects this wiki and the git-annex
+wiki. I am editing this through the anonymous git push interface.
+
+OpenID is failing on me. That is, sometimes it works, sometimes it
+doesn't. For example, while writing this, I clicked the "Preferences"
+link and I seemed to have been logged in automatically without
+problem, even though I previously *tried* to login and failed with an
+error similar to [[bugs/Error:_OpenID_failure:_time_bad_sig:]], which
+of course I cannot reproduce anymore on ikiwiki.info now:
+
+    Error: OpenID failure: time_bad_sig: Return_to signature is not
+    valid.
+
+I *can* still reproduce this on the git-annex wiki, however, which is
+odd. This *could* be because the OpenID host is screwing up, as I am
+not directly responsible for that box anymore... but then why would it
+work on one wiki and not the other?
+
+But worse, I cannot login with my regular non-OpenID user, which I
+started using more regularly now. When I type the wrong password, the
+login form gives me "Invalid entry" next to the password field. But
+then if I do a password recall and reset my password, I get a
+different error:
+
+    Error: login failed, perhaps you need to turn on cookies?
+
+That happens reliably on git-annex.branchable.com. ikiwiki.info seems
+to be more stable: i can eventually login. i can login to my personal
+wiki with OpenID fine. I can also login to branchable.com itself with
+openid without issues.
+
+So I guess the problem is mostly with git-annex.branchable.com? Not
+sure how to debug this further.
+
+Thanks. --[[anarcat]]
+
+Update: now I can't login to the ikiwiki.info site anymore, getting
+the same errors as on the git-annex site.
diff --git a/doc/bugs/footnotes-look-weird.mdwn b/doc/bugs/footnotes-look-weird.mdwn
new file mode 100644 (file)
index 0000000..a5af38e
--- /dev/null
@@ -0,0 +1,44 @@
+Multimarkdown footnotes are pretty useful. If they are enabled in a
+wiki, they don't look so good with the default stylesheet, however, as
+the references are in the same size and positioning as everything
+else.
+
+This particular wiki does not use multimarkdown, so there's no easy
+way to demonstrate this here, you'll have to trust me on this. :)
+
+The following stylesheet should be added to `style.css`:
+
+    a.footnote { vertical-align: super; font-size: xx-small; }
+    div.footnotes { font-size: small; }
+
+This is a typical style that user-agents apply to the `<sup>` tag. For
+example, chromium has this builtin style for `<sup>`:
+
+    vertical-align: super;
+    font-size: smaller;
+
+Bootstrap uses this instead:
+
+    sup {
+        top: -.5em;
+    }
+    
+    sub, sup {
+        position: relative;
+        font-size: 75%;
+        line-height: 0;
+        vertical-align: baseline;
+    }
+
+I settled on `xx-small` because it's the only size that doesn't affect
+line-height here. However, Bootstrap's way may be better.
+
+At any rate, the correct way to fix this is to *avoid* custom styling
+and use the `<sup>` tag for the footnote reference, as it has
+*meaning* which is important to have proper semantic output (e.g. for
+screen readers), as detailed in [this Stack Overflow discussion][].
+
+[this Stack Overflow discussion]: http://stackoverflow.com/questions/501671/superscript-in-css-only
+
+Note that I also make the bottom `<div>` small as well so that it has
+less weight than the rest of the text. -- [[anarcat]]
index 65e2f5c57125580b79dc7ea77e94f1e6a018fb24..d41a4a318dc0d5e4df51c6780ff3c0823c897356 100644 (file)
@@ -4,6 +4,9 @@ User contributed stylesheet files for ikiwiki. Unless otherwise noted,
 these style sheets can be installed by copying them into your wiki's source
 dir with a filename of `local.css`.
 
+Note that if you enable the [[plugins/localstyle]] plugin, you can also
+create stylesheets that affect only certain parts of the wiki.
+
 Some of stylesheets have developed into fullfledged [[themes]] that are
 included in ikiwiki for easy use.
 
index 19631ad478dbb0f732f5043f68791cd3e392afb1..c772dc05b57ba30f2f8d9cad20d5c5dca13f024c 100644 (file)
@@ -9,4 +9,4 @@ Each example is contained in its own subdirectory; just copy the source
 files into your wiki to start using one of the examples.
 
 The [[tips]] page has some other ideas for ways to use ikiwiki, and the
-[[css_market]] and [[theme market|themes]] has some example stylesheets to change ikiwiki's look.
+[[css_market]] and [[theme market|themes]] explain how to change ikiwiki's look.
diff --git a/doc/forum/Translating_ikiwiki_interface/comment_1_389a8173abcc0990f6670796c5f8b227._comment b/doc/forum/Translating_ikiwiki_interface/comment_1_389a8173abcc0990f6670796c5f8b227._comment
new file mode 100644 (file)
index 0000000..fbee2ce
--- /dev/null
@@ -0,0 +1,7 @@
+[[!comment format=mdwn
+ username="desci"
+ subject="Any chance on moving forward on this?"
+ date="2016-04-09T00:21:45Z"
+ content="""
+How about having an intermediate file defining TMPL_VAR_STRING_X and creating .pot files from this intermediate file? --[[desci]]
+"""]]
diff --git a/doc/forum/bootstrap_theme.mdwn b/doc/forum/bootstrap_theme.mdwn
new file mode 100644 (file)
index 0000000..949aef5
--- /dev/null
@@ -0,0 +1,17 @@
+I've edited a lot of pages with redundant questions, so I will centralize this right here.
+
+After reading a lot until I've found the [[/forum/debconf13_ikiwiki_bof]], and I saw there was a *welcome* for a generic bootstrap theme, so I've delivered.
+
+The 'yet another bootstrap theme' has it's source code on [notabug](https://notabug.org/iikb/ikiwiki-theme-bootstrap).
+
+The installation is like I expected any other theme to be:
+
+* [Untar](https://notabug.org/iikb/ikiwiki-theme-bootstrap/archive/1.0.0.25.tar.gz) or [unzip](https://notabug.org/iikb/ikiwiki-theme-bootstrap/archive/1.0.0.25.zip) the [release files](https://notabug.org/iikb/ikiwiki-theme-bootstrap/releases) into `/usr/share/ikiwiki/themes/bootstrap/`;
+* Active the theme `bootstrap` in the setup file or web setup like [[the manual said|/plugins/theme]];
+* Rebuild the wiki if it doesn't automatically and the site should look like [this](https://web.archive.org/web/20160409044511/https://dev.iikb.org/forum/Tema_bootstrap/).
+
+The [current release](https://notabug.org/iikb/ikiwiki-theme-bootstrap/archive/1.0.0.25.tar.gz) has less than the basics, however it should work out of the box and without modifying anything else, the template files that are tampered with are contained inside the theme folder.
+
+It also shouldn't use external *cdn*s, it does currently use [my own cdn](https://cdn.iik.org) but no one should rely on it so I'm moving the files inside the git tree so it will be auto contained.
+
+It is available in the [[theme_market]] already.
diff --git a/doc/plugins/contrib/admonition.mdwn b/doc/plugins/contrib/admonition.mdwn
new file mode 100644 (file)
index 0000000..43c63e4
--- /dev/null
@@ -0,0 +1,56 @@
+[[!meta author="anarcat"]]
+[[!template id=plugin name=admonition author="[[anarcat]]"]]
+[[!tag type/chrome]]
+
+# Admonitions
+
+This plugin adds directives that allow users to outline certain
+sections of text using a custom style sheet and bright icons.
+
+5 directives are available:
+
+* [[ikiwiki/directive/tip]]
+* [[ikiwiki/directive/note]]
+* [[ikiwiki/directive/important]]
+* [[ikiwiki/directive/caution]]
+* [[ikiwiki/directive/warning]]
+
+Or, in Ikiwiki markup:
+
+    \[[!tip "Lorem ipsum dolor sit amet, consectetuer adipiscing elit."]]
+    \[[!note "Vivamus id enim."]]
+    \[[!important "In id erat non orci commodo lobortis."]]
+    \[[!caution "In id erat non orci commodo lobortis."]]
+    \[[!warning "Phasellus neque orci, porta a, aliquet quis, semper a, massa."]]
+
+Those directives simply create a `<div>` elements in the right
+style. So the above can also be simply written as:
+
+    <div class="tip">Lorem ipsum dolor sit amet, consectetuer adipiscing elit.</div>
+    <div class="note">Vivamus id enim.</div>
+    <div class="important">In id erat non orci commodo lobortis.</div>
+    <div class="caution">In id erat non orci commodo lobortis.</div>
+    <div class="warning">Phasellus neque orci, porta a, aliquet quis, semper a, massa.</div>
+
+# Rationale
+
+The idea behind the directives is to make the the CSS elements easier
+to discover through the builtin documentation. Obviously, more
+admonitions can be created simply by adding similar icons and CSS
+elements. Of course, you will not get the above directives expanded
+automatically unless you patch the admonition plugin, unfortunately.
+
+# Code
+
+[[!template id=gitbranch branch=anarcat/admonitions author="[[anarcat]]"]]
+
+The [[!taglink patch]] is available from
+[anarcat's "admonition" branch][] and is designed to be merged in
+Ikiwiki directly:
+
+    git clone -b admonitions git://src.anarc.at/ikiwiki.git
+
+[anarcat's "admonition" branch]: http://src.anarc.at/ikiwiki.git/shortlog/refs/heads/admonitions
+
+See also [[todo/admonitions]] for the discussion leading to the
+creation of this plugin.
index 564f7f68c8a3320a101f861bf14bcbc233188326..7527f26984bc51be95f3104fdf21d87e00ef0f8f 100644 (file)
@@ -91,6 +91,7 @@ using python-like string formatting, and described in the setup options section.
   advertised).
 - `template`: Name of the template to use (if set, the `source` option is
   irrelevant).
+- `var_*`: Any argument with a name starting with ``var_`` is transmitted to the template. For instance, if directive has argument ``var_foo=bar``, then the template will have a variable named ``foo``, and ``<TMPL_VAR FOO>`` will be replaced by ``bar``.
 
 ### Extensions
 
index 9ff6c4ffdcb87ccbc74c81a30f5bd6438b041bc4..4b274d1f41d731d394ab559f5e558bdddf843309 100644 (file)
@@ -7,6 +7,8 @@ plain ASCII punctuation characters into ``smart'' typographic punctuation HTML
 entities. To use it, you need to have the [[!cpan Text::Typography]] module
 installed.
 
-This plugin has a configuration option. To change the attributes,
-set `--typographyattributes=whatever`. See the documentation for
-[[!cpan Text::Typography]] for available attributes.
+This plugin has a configuration option. To change the attributes, set
+`--typographyattributes=whatever`.  Alternatively, set
+`typograph_attributes: whatever` in your config file.  The default is
+`3`.  See the documentation for [[!cpan Text::Typography]] for available
+attributes.
index 90f8d903dcd8e7abe17fc6a1cefa3f47d5181e73..dd3b073d71065b9250e745628c1406bee5af38c3 100644 (file)
@@ -6,18 +6,24 @@ It is usually preferable (and more maintainable) to create a [[css]] file instea
 
 Feel free to add your own [[theme|themes]] here, but first consider writing a simpler [[css]] file and adding it to the [[css market]] instead, or look at the [[themes]] shipped with ikiwiki.
 
- * **[Ikistrap](https://github.com/gsliepen/ikistrap)**, contributed by gsliepen, based on Bootstrap 4.
+* **[AntPortal theme](https://github.com/AntPortal/ikiwiked)**, contributed by Danny, see an example [on the Antportal wiki](https://antportal.com/wiki/)
 
- * **[AntPortal theme](https://github.com/AntPortal/ikiwiked)**, contributed by Danny, see an example [on the Antportal wiki](https://antportal.com/wiki/)
+* **[Night city theme](http://anarcat.ath.cx/night_city/README/)**, contributed by [[anarcat]].
 
- * **[Night city theme](http://anarcat.ath.cx/night_city/README/)**, contributed by [[anarcat]], see an example [on his homepage](http://anarc.at)
+* **[Bootstrap theme](http://anonscm.debian.org/gitweb/?p=users/jak/website.git;a=summary)**, contributed by [JAK LINUX](http://jak-linux.org/about/), based on [Twitter Bootstrap](http://twitter.github.com/bootstrap/), [modifications available](https://anarc.at/blog/2015-09-09-bootstrap/) from [[anarcat]] as well
 
- * **[Bootstrap theme](http://anonscm.debian.org/gitweb/?p=users/jak/website.git;a=summary)**, contributed by [JAK LINUX](http://jak-linux.org/about/), based on [Twitter Bootstrap](http://twitter.github.com/bootstrap/), [modifications available](https://anarc.at/blog/2015-09-09-bootstrap/) from [[anarcat]] as well
+  * [Yet another bootstrap theme](https://notabug.org/iikb/ikiwiki-theme-bootstrap), this one can be used like a regular theme by placing [the theme files](https://notabug.org/iikb/ikiwiki-theme-bootstrap/archive/1.0.0.25.zip) on `/usr/share/ikiwiki/themes/bootstrap/` and changing the `theme` configuration to `boostrap`.
 
- * **[Bootstrap 3](https://github.com/ramseydsilva/ikiwiki-bootstrap-theme)**, contributed by [[ramsey]], based on [Twitter Bootstrap 3](http://getbootstrap.com), also modified by [dequis.org](https://github.com/dequis/ikiwiki-bootstrap-theme/tree/dequis.org)
+* **[Bootstrap 3](https://github.com/ramseydsilva/ikiwiki-bootstrap-theme)**, contributed by [[ramsey]], based on [Twitter Bootstrap 3](http://getbootstrap.com). [Example](http://bootstrap-ramseydsilva.wiki.orangeseeds.org). This template has been forked and modified in many ways:
 
- * **[Bootstrap 2](https://notabug.org/hiatobr/ikiwiki-bootstrap-theme-2)**, contributed by [Hacklab Independência](https://hi.ato.br), a fork of [[ramsey]]'s [Bootstrap 3](https://github.com/ramseydsilva/ikiwiki-bootstrap-theme) original work. You may see examples on [[my user page|/users/desci]]
+  * Modification for [dequis.org](https://github.com/dequis/ikiwiki-bootstrap-theme/tree/dequis.org). [Example](http://bootstrap-dequis.wiki.orangeseeds.org).
 
- * yet another **[Bootstrap 3](https://github.com/anderbubble/ikiwiki-bootstrap)** theme, contributed by anderbubble
+  * Modification to fix the sidebar: **[Bootstrap 2](https://notabug.org/hiatobr/ikiwiki-bootstrap-theme-2)**, contributed by [Hacklab Independência](http://hi.ato.br). This one is hard translated to brazilian portuguese. [Example](http://bootstrap-hiatobr.wiki.orangeseeds.org).
+
+  * Yet another **[Bootstrap 3](https://github.com/anderbubble/ikiwiki-bootstrap)** theme, contributed by anderbubble. [Example](http://bootstrap-anderbubble.wiki.orangeseeds.org).
+
+  * And one more **[Bootstrap 3](https://github.com/tgpfeiffer/ikiwiki-bootstrap-template)** theme (can't you guys get along already?!), contributed by tgpfeiffer, this one shipping a copy of the bootstrap files. [Example](http://bootstrap-tgpfeiffer.wiki.orangeseeds.org).
+
+
+* **[Ikistrap](https://github.com/gsliepen/ikistrap)**, contributed by gsliepen, based on Bootstrap 4.
 
- * and one more **[Bootstrap 3](https://github.com/tgpfeiffer/ikiwiki-bootstrap-template)** theme (can't you guys get along already?!), contributed by tgpfeiffer, this one shipping a copy of the bootstrap files
index 5c0766a0625cb4316043f553cb035aa830be2357..1c0dd91ec56147dd9ab79ca3ea78462da04af806 100644 (file)
@@ -18,3 +18,67 @@ links to the actual theme. -- [[anarcat]]
 > theme yet. I recently made `<TMPL_IF THEME_$NAME>` be available,
 > so the page.tmpl could use that to do different things if the boostrap
 > theme was enabled. --[[Joey]]
+
+>> Would you reconsider? I've made [[this bootstrap theme|/forum/bootstrap_theme]] that works within the theme plugin without changing the `templatedir` configuration option. It seems that the `page.tmpl` I have in the subfolder `templates` takes precedence. Not sure what you meant by "two versions of page.tmpl", though. -- [[desci]]
+
+>>> The reason we don't want individual themes shipped with ikiwiki
+>>> to have to include their own `page.tmpl` is that when we add new
+>>> features (such as new plugins) to the ikiwiki core, if those features
+>>> require a `page.tmpl` change, we don't want to have to add them to
+>>> multiple variations of `page.tmpl`. This would either lead to
+>>> increased maintenance work (repeating ourselves), or theme-dependent
+>>> feature availability like what happens in Wordpress (for instance
+>>> imagine if `osm` only worked with Bootstrap and `sidebar` only worked
+>>> with Actiontabs - you wouldn't be able to have both).
+>>>
+>>> If you maintain your own local theme, you're welcome to maintain a
+>>> version of `page.tmpl` containing only the features you personally
+>>> need, but the `page.tmpl` in ikiwiki should be comprehensive. --[[smcv]]
+
+>>>> I've tried to make the least changes possible in [this page.tmpl file](https://notabug.org/iikb/ikiwiki-theme-bootstrap/raw/master/templates/page.tmpl), but I couldn't overcome the suckness of bootstrap itself.
+>>>> I am aware of alternatives to bootstrap, but it seems that every one of them would require some changes in the `page.tmpl` to work as expected.
+>>>> I think it is realistic to have a bootstrap (or other superb, fantastic css frame*lazy*work) without a `page.tmpl`,
+>>>> but I also think there should be other way around the chaos of each and every [[available theme|theme_market]] having it's own installing proccess.
+>>>> Other argument I have is: could we have a theme-contrib, like the [[plugins]] have? This would require the mantainer to implement the new features in their themes.
+
+---
+
+I have a question.
+
+Where should I put a custom theme other than `/usr/share/ikiwiki/themes/`?
+
+I put `.pm` plugins on `~/.ikiwiki/Ikiwiki/Plugin` and it works well.
+
+How would I go about not tampering with the root filesystem to install a theme?
+
+Also, I have another question:
+
+I have a complex theme I'm working on, and it doesn't even have a `style.css`, because it is about editing `.tmpl` files and relying on the bootstrap files, so I want to know if the theme plugin will understand this structure:
+
+```
+/usr/share/ikiwiki/themes/
+└── my-theme/
+    ├── basewiki/
+    │   ├── bootstrap/
+    │   │   ├── css/
+    │   │   │   └── bootstrap.min.css
+    │   │   ├── js/
+    │   │   │   ├── bootstrap.js
+    │   │   │   └── bootstrap.min.js
+    │   │   └── fonts/
+    │   │       ├── glyphicons-halflings-regular.eot
+    │   │       ├── glyphicons-halflings-regular.svg
+    │   │       ├── glyphicons-halflings-regular.ttf
+    │   │       ├── glyphicons-halflings-regular.woff
+    │   │       └── glyphicons-halflings-regular.woff2
+    │   └── index.mdwn
+    └── templates/
+        ├── page.tmpl
+        └── whatever.tmpl
+```
+
+**Edit:** no, it doesn't. When i change theme in the config to `my-theme`, the engine only uses the `templates` subfolder under `theme/my-theme`, and not `basewiki`. So the workaround is doing like [IkiStrap](https://github.com/gsliepen/ikistrap) proposed, suggesting the user to alter the `underlaydir` and `templatedir` configs instead of choosing a theme via the old fashioned `theme` config.
+
+This feels more like an overhaul than a theme for me, could we clarify what is a theme, a template, an overhaul, a change to the look and feel, a change to the frontend, a change to the design, etc.?
+
+-- [[desci]]
index 6dc9734fe2c0d31d33021fe633a78e1303a4da32..64c995e1800406b16097cf9a52f830dcf1895886 100644 (file)
@@ -2,7 +2,7 @@
 
 Use case: You want to move away from Wordpress to Ikiwiki as your blogging/website platform, but you want to retain your old posts.
 
-[This](http://git.chris-lamb.co.uk/?p=ikiwiki-wordpress-import.git) is a simple tool that generates [git-fast-import](http://www.kernel.org/pub/software/scm/git/docs/git-fast-import.html)-compatible data from a WordPress export XML file.
+[This](https://chris-lamb.co.uk/projects/ikiwiki-wordpress-import) is a simple tool that generates [git-fast-import](http://www.kernel.org/pub/software/scm/git/docs/git-fast-import.html)-compatible data from a WordPress export XML file.
 
 WordPress categories are mapped onto Ikiwiki tags. The ability to import comments is planned.
 
index f1f6553015a3ea83205829f47ee8c24e15c810b2..77849dbf1d82be6cdaee6bf1585e20406281363e 100644 (file)
@@ -12,3 +12,35 @@ In order to figure out exactly which ones fares the best, i made test wikis for
 Hopefully this will help others figure out what the heck is going on here... Personnally, I think I prefer the JAK linux one, but i don't like the idea of depending on a theme-specific plugin...  -- [[anarcat]]
 
 Update: I ended up forking the Jak theme also... My experience has been documented in [this blog post](http://anarc.at/blog/2015-09-09-bootstrap/?updated). --[[anarcat]]
+
+---
+
+Congratulations on your setup and here is my *mea culpa* on this:
+
+Originally I've started making the [hiatobr](http://bootstrap-hiatobr.wiki.orangeseeds.org)'s fork to address the following issues with the other attempts to make a bootstrap theme:
+
+* The sidebar wasn't working;
+* The themes were poorly written and did not found a way to incorporate the bootstrap proposal to the ikiwiki's template model;
+* I wanted diversity and the original idea was to provide a handful of templates like the [bootstrap examples](http://getbootstrap.com/getting-started/#examples).
+
+Turns out:
+
+* I've fixed the sidebar, don't remember how but you may find out in the [history](https://notabug.org/hiatobr/ikiwiki-bootstrap-theme-2/commits/d3769844c536a0d97955157f4c55e719af1dd3d0);
+* I've added an [[opengraph plugin|plugins/contrib/opengraph/]] in the template so your facebook friends can share your blog posts;
+* We have translated stuff to Brazilian Portuguese totally ignoring the i18n conventions so that kind of broke the template;
+* The "proper way" to use the template is not documented;
+* We did not provide other templates as planned because of the [end of Hacklab Independência](https://we.riseup.net/hiatobr/fim-do-hacklab-independ-ncia);
+
+The webdev collective has just met again and the plan to make multiple ikiwiki blog bootstrap templates will continue, but since I've failed once, this shall wait for results.
+
+As for the [[theme_market]] page, since the modifications didn't provide much innovation, mine included, I've [edited the page](http://source.ikiwiki.branchable.com/?p=source.git;a=commit;h=b18ae270ac7b93fe51f83bd7dc885d068165e407), see if it seems cleaner now.
+
+--[[desci]]
+
+---
+
+There you go, I've provided a minimalistic [[Bootstrap 3 Template|/forum/bootstrap_theme]] that should behave the proper way (tm) and it's easy as cloning the repository on `/usr/share/ikiwiki/themes/boostrap` and setting `theme: bootstrap`.
+
+I've saved an [example on the wayback machine](https://web.archive.org/web/20160409044511/https://dev.iikb.org/forum/Tema_bootstrap/), because I will continue to improve that theme and the idea now is to make multiple variations of it, so the user has a choice. For example, changing the navbar from black to white requires some bootstrap specific changes, so I'll probably make another theme just for that.
+
+--[[desci]]
index 4b3deb2ea270bc2189c2b50d52b241fbd38ae2cd..492418b5aee639287da3f2f94d9f4a54fe746772 100644 (file)
@@ -46,7 +46,7 @@ Usage instructions are in the `README` file.
    vertical list instead of an horizontal list)
  * PageList, through [[ikiwiki/directive/map]]
  * MonthCalendar, partially, through [[ikiwiki/directive/calendar]]
- * FootNote, through markdown
+ * FootNote, through multimarkdown (`[^foo]` → `[^foo]: this is the footnote`)
  * Anchor, through markdown and plain HTML
  * `<<BR>>`, through the weird line ending thing
  * AttachList, through a weird [[ikiwiki/directive/inline]]
index a33c8f385a91377804aaa087a56b00cfabd00d8a..3fc4048204ac6829944094d27dfe2ee8c5188627 100644 (file)
@@ -82,6 +82,32 @@ made into a startup script in `init.d`. You may also need to make this file writ
 
     chmod a+w /tmp/fcgi.socket
 
+If you have [systemd](https://en.wikipedia.org/wiki/Systemd), you may use a service file like so:
+
+Edit/create a service file (in Debian it would be: `sudo vim /lib/systemd/system/ikiwiki.service`
+
+Content of `ikiwiki.service`:
+
+    [Unit]
+    Description=Ikiwiki fcgi socket wrap
+    After=network.target
+    
+    [Service]
+    Type=simple
+    User=www-data
+    Group=www-data
+    ExecStart=/usr/bin/spawn-fcgi -s /tmp/fcgi.socket -n -- /usr/sbin/fcgiwrap
+    
+    [Install]
+    WantedBy=multi-user.target
+
+Then run:
+
+    # This enables the service at startup
+    sudo systemctl enable ikiwiki.service
+    # This attempts to start the service
+    sudo systemctl start ikiwiki.service
+
 Then you need an nginx config plugged in that wrapper. Here's an
 example virtual host configuration:
 
diff --git a/doc/todo/admonitions.mdwn b/doc/todo/admonitions.mdwn
new file mode 100644 (file)
index 0000000..50f62bf
--- /dev/null
@@ -0,0 +1,125 @@
+In the [MoinMoin wiki][], there is this neat little hack called
+[Admonitions][] that basically create a `<div>` block with a specific
+style out of a certain section of the text.
+
+I couldn't find a way to do this easily in Ikiwiki. On the one hand,
+there is no easy way to create div blocks with arbitrary styles (which
+is basically what MoinMoin admonitions are). On the other hand, there
+are no neat little logos in stylesheets like there are in Moinmoin
+either.
+
+It would be great to see this implemented in Ikiwiki. Now, I know I
+can make a `<div>` myself, but I am not sure we should encourage users
+to inject arbitrary HTML in ikiwiki pages. And even then, we should
+add adminition CSS classes to make that easier to use.
+
+Ideally, Ikiwiki would support Pandoc or Github-style fenced blocks
+and could abuse those to allow arbitrary styles (and markup!) to kick
+in. The [[ikiwiki/directive/format]] directive could also be used, I
+guess, but I dislike how it requires all those brackets and quotes and
+bangs and all...
+
+-- [[anarcat]]
+
+[MoinMoin wiki]: https://moinmo.in/
+[Admonitions]: https://moinmo.in/HelpOnAdmonitions
+
+> ikiwiki's general design is that it supports exactly three forms
+> of markup:
+>
+> * whatever the `htmlize` plugin does
+> * as a special ikiwiki-specific extension, \[[wikilinks]]
+> * as another special ikiwiki-specific extension, \[[!directives]]
+>
+> All markup interpretation beyond wikilinks and directives is
+> the `htmlize` plugin's responsibility. The `mdwn` plugin
+> interprets Markdown, the `rst` plugin interprets
+> reStructuredText and so on.
+>
+> It sounds as though you're asking for a `htmlize` plugin which
+> interprets an extended dialect of Markdown:
+>
+> * standard Markdown (inasmuch as such a thing exists) as usual
+> * mapping certain syntax (what?) to "admonitions"
+>
+> ikiwiki deliberately doesn't implement Markdown parsing, it just
+> calls out to one of several Perl implementations of Markdown.
+>
+> Alternatively, you could have a small plugin that translates
+>
+>     [[!warning "Do what I say, not as I do."]]
+>
+> into an appropriate `<div>`. That's the "lightest" form of
+> markup that is built into ikiwiki itself.
+>
+> Alternatively^2, some different hook (I think [[plugins/typography]]
+> might use the right one?) could interpret an ad-hoc syntax and
+> turn it into a `<div>` either before or after `htmlize` processing.
+> However, that would be adding an extra layer of syntax for your
+> users to keep track of.
+>
+> [[templates|ikiwiki/directive/template]] are another way this could
+> work:
+>
+>     \[[!template id=warning text="Do as I say, not as I do."]]
+>
+> There's a "note" template bundled with ikiwiki already.
+>
+> --[[smcv]]
+
+>> I think you mean the `htmlize` hook, as I cannot find any `htmlize`
+>> plugin.. That said, yeah, i understand the limitations of Ikiwiki
+>> here. I guess that the [[ikiwiki/directive/template]] directive is a
+>> good workaround, but it's not really shorter to write:
+>>
+>>     \[[!template id=warning text="Do as I say, not as I do."]]
+>>
+>> than to write:
+>>
+>> [[!format txt """<div class="warning">Do as I say, not as I do.</div>"""]]
+>>
+>> ... in fact, it's actually longer. So short of allowing arbitrary
+>> classes *and* fenced blocks, I don't think this can go much
+>> further.
+>>
+>> We *could*, however, import the admonition styles from MoinMoin
+>> directly. It would involve importing 5 icons from MoinMoin and
+>> creating associated styles. Is that something you would be open to?
+>>
+>> --[[anarcat]]
+
+>> Looking more at the MoinMoin images, the source (and license!) for
+>> them is not quite clear, so they don't make such great targets for
+>> inclusion. They are, nevertheless, included in Debian so presumably
+>> they are DFSG-friendly? The copyright file marks them as "UNKNOWN"
+>> which is worrisome... I have found the following results about them:
+>>
+>> * [admon-warning.png][] seems to be [public domain according to this sketchy site][]
+>> * [admon-note.png][] seems to have a [source in XFCE][], as part of
+>>   the notes plugin
+>> * [admon-tip.png][] is used in the Debian release notes, so is
+>presumably fine as well [source there](https://www.debian.org/releases/testing/amd64/release-notes/images/note.png)
+>> * [admon-important.png][], same, [important.png](https://www.debian.org/releases/testing/amd64/release-notes/images/important.png)
+>> * [admon-caution.png][] can be found in Mediawiki as well, which is
+>> a good source of icons. According to Debian, some are public domain,
+>> some are LGPL (!?). In MediaWiki itself, the source of that file is
+>> lost in the mists of time.
+>>
+>> Even though there is some confusion about the source of those
+>> images, I think, in good faith, that they can be generally be
+>> considered reusable. --[[anarcat]]
+
+[public domain according to this sketchy site]: http://all-free-download.com/free-vector/download/tango_process_stop_115912.html
+[source in XFCE]: http://git.xfce.org/panel-plugins/xfce4-notes-plugin/tree/data/icons/scalable/xfce4-notes-plugin.svg
+[admon-warning.png]: https://moinmo.in/moin_static19/modernized/img/admon-warning.png
+[admon-note.png]: https://moinmo.in/moin_static19/modernized/img/admon-note.png
+[admon-tip.png]: https://moinmo.in/moin_static19/modernized/img/admon-tip.png
+[admon-important.png]: https://moinmo.in/moin_static19/modernized/img/admon-important.png
+[admon-caution.png]: https://moinmo.in/moin_static19/modernized/img/admon-caution.png
+
+Update: I have made a [[plugins/contrib/admonition]] plugin for this
+purpose, as a patch. Hopefully it will be mergeable here? Here's a
+screenshot of what the help page would look like, to give you an idea
+of the results:
+
+<img src="http://paste.anarc.at/snaps/snap-2016.04.15-18.07.39.png" />
index a47f4ba0ce5194588038b2c94971314efc7e3dcc..687515d06a497384f3db820278c088af3898f680 100644 (file)
@@ -25,6 +25,10 @@ I think it was anarcat who had the patches
 > someone else ported bootstrap4 to ikiwiki (see
 > [ikistrap][]). -- [[anarcat]]
 
+---
+
+I've started [yet another bootstrap theme](https://notabug.org/iikb/ikiwiki-theme-bootstrap). The main reason being because I wanted a theme that actually worked within the [[theme plugin|/plugins/theme]] without changing anything else, and [[I've made it|/forum/bootstrap_theme]]. --[[desci]]
+
 [ikistrap]: https://github.com/gsliepen/ikistrap
 [bootstrap theme]: https://anarc.at/blog/2015-09-09-bootstrap/
 [custom theme]: http://anarcat.ath.cx/night_city/README/
index 47335b93b5e4710003ec9d3e0c02086d073d7ed3..dce4ea48feba8a73070bbc7080d10a61f9c93a2f 100644 (file)
@@ -1,13 +1,24 @@
-Sites I am using Ikiwiki with the [[bootstrap 3 theme|/theme_market]]:
+# Personal information
 
-* <https://hi.ato.br>
-* <https://capoeira.li/blog>
-* <http://dissertosradicais.tem.blog.br>
-* <http://epelaspracasnaoteranome.tem.blog.br>
-* <http://iuri.tem.blog.br>
-* <http://mim.tem.blog.br>
-* <http://piratas.xyz>
+<https://desci.xyz>
 
 ---
 
+# Ikiwiki Plugins
+
 A plugin to add facebook spyware to your ikiwiki: [[plugins/contrib/opengraph/]]
+
+---
+
+# Ikiwiki Themes
+
+A theme to add [bootstrap 3](https://getbootstrap.com) to ikiwiki without overhauling the installation: [[forum/bootstrap_theme]]
+
+---
+
+# Ikiwiki Sites
+
+## Currently online:
+
+* <https://dev.iikb.org>
+* <https://dev.iikb.xyz> (proxy_pass)