]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blob - doc/ikiwiki/wikilink/discussion.mdwn
Process .md like .mdwn, but disallow web creation.
[git.ikiwiki.info.git] / doc / ikiwiki / wikilink / discussion.mdwn
1 # Creating an [[anchor]] in Markdown
3 Is it a native Markdown "tag" for creating an [[anchor]]? Unfortunately,
4 I haven't any information about it at
5 [Markdown syntax](http://daringfireball.net/projects/markdown/syntax) page.
7 Of course, I know that I can use HTML tag to do it,
8 for example <a name="foo" />, but I don't want to mix Markdown
9 and HTML code if it's not necessary.
11 BTW, ikiwiki doesn't displays the #foo anchor in the example
12 ("To link to an anchor inside a page...") at [[WikiLink]] page...
14 --[[Paweł|ptecza]]
16 > Just found out that headers are already indexed with `index1h1 ... indexMhN`.
17 > So one can link to headings with `\[[page|#index2h3]]` for example. 
18 > It would be much easier though if it was translated to the heading's name,
19 > so on could to `\[[page#name]]`. --Timoses
21 >> That's [[plugins/headinganchors]]. --smcv
23 > No such syntax exists in markdown.  ikiwiki could certainly have a
24 > [[preprocessor_directive|directive]] for it, though.
25 > --[[JoshTriplett]]
27 >> [[!tag wishlist]]
28 >> I'd like to implement such a thing.  Joey, what is this supposed to look like?
29 >> `\[[anchor WHATEVER]]`?  --[[tschwinge]]
31 >>> Why would you want to use a preprocessor directive for something that can
32 >>> be more shortly and clearly done with plain HTML? Markdown is *designed*
33 >>> to be intermixed with HTML. --[[Joey]]
35 >>>> I tend to disagree.
36 >>>> It just doesn't feel right for me to put HTML code straight into Markdown files.
37 >>>>
38 >>>> Quoting <http://daringfireball.net/projects/markdown/>:
39 >>>>
40 >>>>> The idea is that a Markdown-formatted document should be publishable as-is, as plain text, *without looking like it’s been marked up with tags or formatting instructions*.
41 >>>>
42 >>>> Also, in theorie at least, Markdown might also support other output formats than HTML.
43 >>>> Those wouldn't know about how to deal with the intermingled HTML code.
44 >>>>
45 >>>> --[[tschwinge]]
46 >>>>>Not sure \[[anchor WHATEVER]] looks any better than &lt;a name="WHATEVER"&gt;...?  --[[sabr]]
48 > The lack of the `#foo` anchor in the anchor example on [[wikilink]]
49 > definitely looks like a bug.  --[[JoshTriplett]]
51 >> Fixed that --[[Joey]]
53 >>> Sorry to bring this up (1 year since last change in this page) but what is the status of this? Can we use anchors like it's in [[wikilink]]? This discusion is tagged as wishlist, but isn't listed in [[wishlist]]. What is "fixed that" then? Again, sorry if this is a dead issue, but I have a tendency to create big wiki pages, and anchors are very needed for me, but I've spent all morning trying to make it work and it just doesn't. TY. --rbern
55 The 'name' attribute of the 'a' element is a depracated way to create a named anchor. The right way to do that is using the 'id' attribute of any element. This is because an anchor may refer to a complete element rather than some point in the page.
57 Standard purity aside, if you define an anchor (using either 'a name' or 'id') to a single point in the document but refer to a complete section, the browser may just show that specific point at the bottom of the page rather than trying to show all the section.
58 --[[tzafrir]]
60 ---
62 Considering a hierarchy like `foo/bar/bar`, I had the need to link from the
63 `foo/bar/bar` page to the `foo/bar` one.  It would have been convenient to
64 simply write [[wikilink]]s like `\[[../bar]]` (or even just `\[[..]]`?), but
65 this doesn't work, so I had to resort to using `\[[foo/bar]]` instead.
66 --[[tschwinge]]
68 > I believe, that doesn't entirely solve the problem. Just assume, your hierarchy is `/foo/bar/foo/bar`.
70 > How do you access from the page `/foo/bar/foo/bar` the `/foo/bar` and not `/foo/bar/foo/bar`?
72 > Do we have a way to implement `\[[../..]]` or `\[[/foo/bar]]`?
74 > Even worse, trying to link from `/foo/bar` to `/foo/bar/foo/bar` ... this will probably need `\[[./foo/bar]]` --[[Jan|jwalzer]]
76 >> There is no ".." syntax in wikilinks, but if the link begins with "/" it
77 >> is rooted at the top of the wiki, as documented in
78 >> [[subpage/linkingrules]]. Therefore, every example page name you listed
79 >> above will work unchanged as a wikilink to that page! --[[Joey]]
81 ----
83 How do I make images clickable?  The obvious guess, \[[foo.png|/index]], doesn't work.  --[[sabr]]
85 > You can do it using the img plugin. The syntax you suggested would be ambiguous,
86 > as there's no way to tell if the text is meant to be an image or displayed as-is.
87 > --[[Joey]]
89 ----
91 Is it possible to refer to a page, say \[[foobar]], such that the link text is taken from foobar's title [[directive/meta]] tag? --Peter
93 > Not yet. :-) Any suggestion for a syntax for it? Maybe something like \[[|foobar]] ? --[[Joey]]
95 I like your suggestion because it's short and conscise. However, it would be nice to be able to refer to more or less arbitrary meta tags in links, not just "title". To do that, the link needs two parameters: the page name and the tag name, i.e. \[[pagename!metatag]]. Any sufficiently weird separater can be used instead of '!', of course. I like \[[pagename->metatag]], too, because it reminds me of accessing a data member of a structure (which is what referencing a meta tag is, really). --Peter
97 > I dislike \[[pagename->metatag]] because other wikis use that as their normal link/label syntax.
98 > I'm not sure that it is a good idea to refer to arbitrary meta tags in links in the first place - what other meta tags would you really be interested in?  Description?  Author?  It makes sense to me to refer to the title, because that is a "label" for a page.
99 > As for syntax, I do like the \[[|foobar]] idea, or perhaps something like what <a href="http://www.pmwiki.org">PmWiki</a> does - they have their links the other way around, so they go \[[page|label]] and for link-text-as-title, they have \[[page|+]].  So for IkiWiki, that would be \[[+|page]] I guess.
100 > --[[KathrynAndersen]]
102 ----
104 I am thinking that it would be useful to parse parts of one wiki page into another. Here something like `\[[page=anchor]]` would be really nice to simply parse the content of that section, as opposed to `\[[page#anchor]]` which only creates a link to that section. -- [[Timoses]]
106 > When you say "parse parts" do you mean taking a section of a wiki page and including its text
107 > in a different wiki page? So for instance you might want `/installation` to include the
108 > `Downloading binaries` section of `/download`, but not the rest of that page?
110 > That's really a separate feature request (inlining isn't linking), and is also rather difficult
111 > to do in IkiWiki's processing model: at the time that [[wikilinks|ikiwiki/wikilink]] and
112 > [[directives|ikiwiki/directive]] are processed, the page content is still Markdown or
113 > whatever other format is relevant, not HTML. That makes sections difficult to identify.
115 > I would suggest making the desired section a separate page (for example you might
116 > call it `/download/binaries`), and including that whole page everywhere it should
117 > appear (for example in both `/download` and `/installation`) using
118 > `\[[!inline pages="download/binaries" raw=yes]]`. --[[smcv]]