]> sipb.mit.edu Git - ikiwiki.git/blob - doc/users/tschwinge.mdwn
341a5295346c06c8067d734f48f85b802f22f7d6
[ikiwiki.git] / doc / users / tschwinge.mdwn
1 [[!meta title="Thomas Schwinge"]]
2 # Thomas Schwinge
3
4 <tschwinge@gnu.org>  
5 <http://www.thomas.schwinge.homeip.net/>
6
7 I have converted the [GNU Hurd](http://www.gnu.org/software/hurd/)'s previous
8 web pages and previous wiki pages to a *[[ikiwiki]]* system; and all that while
9 preserving the previous content's history, which was stored in a CVS repository
10 for the HTML web pages and a TWiki RCS repository for the wiki; see
11 <http://www.gnu.org/software/hurd/colophon.html>.
12
13 # Issues to Work On
14
15 ## Stability of Separate Builds
16
17 The goal is that separate builds of the same source files should yield the
18 exactly same HTML code (of course, except for changes due to differences in
19 Markdown rendering, for example).
20
21   * Timestamps -- [[forum/ikiwiki__39__s_notion_of_time]], [[forum/How_does_ikiwiki_remember_times__63__]]
22
23     Git set's the current *mtime* when checking out files.  The result is that
24     <http://www.gnu.org/software/hurd/contact_us.html> and
25     <http://www.bddebian.com:8888/~hurd-web/contact_us/> show different *Last
26     edited* timestamps.
27
28     This can either be solved by adding a facility to Git to set the
29     checked-out files' *mtime* according to the *AuthorDate* / *CommitDate*
30     (which one...), or doing that retroactively with the
31     <http://www.gnu.org/software/hurd/set_mtimes> script before building, or
32     with a ikiwiki-internal solution.
33
34   * HTML character entities
35
36     <http://www.gnu.org/software/hurd/purify_html>
37
38 ## Tags -- [[bugs/tagged__40____41___matching_wikilinks]]
39
40 Tags should be a separate concept from wikilinks.
41
42 ### \[[!map]] behavior
43
44 The \[[!map]] on, for example,
45 <http://www.gnu.org/software/hurd/tag/open_issue_hurd.html>, should not show
46 the complete hierarchy of pages, but instead just the pages that actually *do*
47 contain the \[[!tag open_issue_hurd]].
48
49 > `tagged(open_issue_hurd)` in its pagespec should do that. --[[Joey]]
50
51 ## Anchors -- [[ikiwiki/wikilink/discussion]]
52
53 ## Default Content for Meta Values -- [[plugins/contrib/default_content_for___42__copyright__42___and___42__license__42__]]
54
55 This will decrease to be relevant, as we're going to add copyright and
56 licensing headers to every single file.
57
58 ## Texinfo -- [[plugins/contrib/texinfo]]
59
60 Not very important.  Have to consider external commands / files / security (see
61 [[plugins/teximg]] source code)?
62
63 ## Shortcuts -- [[plugins/shortcut/discussion]]
64
65 ## \[[!meta redir]] -- [[todo/__42__forward__42__ing_functionality_for_the_meta_plugin]]
66
67 Implement a checker that makes sure that no pages that use \[[!meta redir]]
68 redirect to another page (and are thus considered legacy pages for providing
69 stable URLs, for example) are linked to from other wiki pages.  This is useful
70 w.r.t. backlinks.  Alternative, the backlinks to the \[[!meta redir]]-using
71 pages could perhaps be passed on to the referred-to page?
72
73 > I found that backlinks was an easy way to find such links to such pages.
74 > (Although the redirection made it hard to see the backlinks!) --[[Joey]] 
75
76 ## Sendmail -- [[todo/passwordauth:_sendmail_interface]]
77
78 ## Parentlinks -- [[bugs/non-existing_pages_in_parentlinks]]
79
80 ## Discussion Pages of Discussion Pages of...
81
82 Is it useful to have Discussion pages of Discussion pages (etc.)?  -- On
83 <http://www.gnu.org/software/hurd/hurd/building/cross-compiling/discussion.html>,
84 this possibility is offered.
85
86 ## Modifying [[plugins/inline]] for showing only an *appetizer*
87
88 Currently ikiwiki's inline plugin will either show the full page or nothing of
89 it.  Often that's too much.  One can manually use the [[plugins/toggle]] plugin
90 -- see the *News* section on <http://www.gnu.org/software/hurd/>.  Adding a new
91 mode to the inline plugin to only show an *appetizer* ending with *... (read
92 on)* after a customizable amount of characters (or lines) would be a another
93 possibility.  The *... (read on)* would then either toggle the full content
94 being displayed or link to the complete page.
95
96 > You're looking for [[plugins/more]] (or possibly a way to do that automatically, 
97 > I suppose. --[[Joey]] 
98
99 ## Prefix For the HTML Title
100
101 The title of each page (as in `<html><head><title>`...) should be prefixed with
102 *GNU Project - GNU Hurd -*.  We can either do this directly in `page.tmpl`, or
103 create a way to modify the `TITLE` template variable suitably.
104
105 ## [[plugins/inline]] feedfile option
106
107 Not that important.  Git commit b67632cdcdd333cf0a88d03c0f7e6e62921f32c3.  This
108 would be nice to have even when using *usedirs*.  Might involve issues as
109 discussed in *N-to-M Mapping of Input and Output Files* on
110 [[plugins/contrib/texinfo]].
111
112 > Do you mean when *not* using usedirs? It is currently supported for usedirs,
113 > only. --[[Joey]] 
114
115 ## Unverified -- these may be bugs, but have yet to be verified
116
117   * ikiwiki doesn't change its internal database when \[[!meta date]] /
118     \[[!meta updated]] are added / removed, and thusly these meta values are
119     not promulgated in RSS / Atom feeds.
120
121     > I would rather see this filed as a bug, but FWIW, the problem
122     > is probably that meta does not override the mdate_3339
123     > template variable used by the atom and rss templates.
124     > (Meta does store ctime directly in the ikiwiki database, but cannot
125     > store mtime in \%pagemtime because it would mess up detection of when
126     > actual file mtimes change.) --[[Joey]]
127
128   * Complicated issue w.r.t. *no text was copied in this page*
129     ([[plugins/cutpaste]]) in RSS feed (only; not Atom?) under some conditions
130     (refresh only, but not rebuild?).  Perhaps missing to read in / parse some
131     files?
132
133   * [[plugins/recentchanges]]
134
135       * Creates non-existing links to changes.
136
137       * Invalid *directory link* with `--usedirs`.
138
139       * Doesn't honor `$timeformat`.
140
141       * Does create `recentchangees.*` files even if that is overridden.