aboutsummaryrefslogtreecommitdiff
path: root/Vimwiki.wiki
blob: 73aebe7aac7f85bce70dc4f0168f88e773e3f78b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
= Contents =
  - [[#Vimwiki|Vimwiki]]
    - [[#Vimwiki#Användning|Användning]]
      - [[#Vimwiki#Användning#Script|Script]]
      - [[#Vimwiki#Användning#Keybinds|Keybinds]]
      - [[#Vimwiki#Användning#Dairy|Dairy]]
      - [[#Vimwiki#Användning#Checkboxes|Checkboxes]]
      - [[#Vimwiki#Användning#Links|Links]]
      - [[#Vimwiki#Användning#External files|External files]]
    - [[#Vimwiki#Todo|Todo]]
    - [[#Vimwiki#Table of Contents|Table of Contents]]
      - [[#Vimwiki#Table of Contents#Kvarstår|Kvarstår]]
    - [[#Vimwiki#HTML|HTML]]
      - [[#Vimwiki#HTML#HTML sidebar|HTML sidebar]]
      - [[#Vimwiki#HTML#Rubrikslänkar|Rubrikslänkar]]

= Vimwiki =
Den här repon versionskontrolleras på git@hornquist.se/git/vimwiki.git,
och bör vid varje push byggas och publiceras på
http://wiki.hornquist.se.

== Användning ==

=== Script ===

För att enklare skapa commits kan [[file:wiki|mitt script]] användas.
Det bör ligga i det här repot.

=== Keybinds ===
* <CR> on a word or selection creates a link
* <CR> on a link follows the link
* <BS> goes back
* `gl-` gör nuvarande rad till punktlista (`-` kan även `1`, `a`, `A`,
  `i`, `I`, `#`, `*`)
* `glx` ger nuvarda list-item en checkruta
* `gl[lh]` Öka eller minska listnivå

=== Dairy ===
- <leader>w<leader>i creates index
- <leader>w<leader>w new entry
- <leader>wi open index

=== Checkboxes ===
* C-space toggles box

=== Links ===
- `C-xC-o` autocompletes inter links.

=== External files ===
Både `file:` och `local:` kan användas på filer. Vid export blir
`file:` relativt filpath-rooten, emedans `local:` blir relativt
vimwiki-rooten. `file`: bör där med _undvikas_.

Se [[help:VimwikiLinkConverter]] för hur länkar konverteras till HTML,
och [[help:VimwikiLinkHandler]] för hur de hanteras inom vim.

:TODO:
`help:` bör stödjas och länka till matchande help sida i vim.

== Todo ==
:TODO:
- [X] Genererade file: linkar för Vimwiki pekar blir absoluta på den
      path de pekar på. Dock fungerar inte webbservern så.
      [[local:test|Den här länken]] tror jag just nu pekar på
      `/var/www/wiki/vim/test`. Dock borde den bara peka på `/test`.
      `vim/` exporteras inte ens.
- [ ] Möjlighet att länka till e-posts-medelanden.
- [ ] `5=` bör ge mig rubrik nivå 5
- [ ] Autogenerera taggar och tag-index
- [X] Templates fungerar inte, se vimwiki-option-template_ext

== Table of Contents ==
Inehållsförtäckning till Tagbar genereras av ett script från
https://github.com/vimwiki/utils , vilket nu finns som submodul till
det här repot.

=== Kvarstår ===
:TODO:
- [ ] Få `auto_toc` att fungera 

== HTML ==

=== HTML sidebar ===
:TODO:

CSS liknande den nedan flyttar inehållsförtäckningen till sidan. Några
problem finns dock:

- `#toc` har inte det id:t. `document.getElementsByTagName("ul")[0]`
  returerar det dock om det finns.
- Det är fult att TOC ligger innuti content
- `<h1>Contents</h1>` ligger kvar på sidan.

{{{
#toc {
    height: 100vh;
    position: fixed;
    top: 0;
    right: 1em;
    width: 20%;
}

.content {
    width: 80;
}
}}}

Utöver det bör sidebaren även gå att gömma (med JS). Samt inte visas
på mobil.

=== Rubrikslänkar ===
https://github.com/HugoNikanor/vimwiki/tree/header-link

Alla rubriker är nu länkar till sig själva!