]> Lady’s Gitweb - Wiki/blob - Sources/Meta/Editing.djot
Update Meta:Editing for some new functionality
[Wiki] / Sources / Meta / Editing.djot
1 {v-short="Editing"}
2 # editing this wiki
3
4 This wiki follows proper wiki philosophy, meaning that ⓐ all content
5 is subject to change and deletion by members at any time, ⓑ it is
6 assumed that people will put the most time and effort into things
7 they are most passionate or knowledge·able about, ⓒ the
8 generally‐accepted _goal_ is in making the wiki _better_ or _more
9 interesting_ and not in being _right_ or _wrong_, and ⓓ the result
10 should be taken as a slightly‐inaccurate consensus opinion of the
11 current moment which captures nobody’s worldview correctly but
12 never·the·less is fun, useful, or meaningful to spend time with.
13 It should go without saying that nobody believes everything on this
14 site and everybody believes some of it.
15
16 Be aware of the [][Meta:Licence] for this site; when you contribute,
17 you do so under these terms.
18
19 Wiki editing is done using Git; the git repository is located at
20 `ssh://wiki@git.ladys.computer/srv/git/Wiki`.
21 Obviously, only people who have s·s·h keys registered with the `wiki`
22 user to be able to edit.
23 Registration is by invitation only.
24
25 The file structure of the wiki is as follows:8--:
26
27 ```
28 Sources/
29 ↳ Category/
30 ↳ Editor/
31 ↳ Meta/
32 ↳ Namespace/
33 ↳ Page/
34 ↳ Special/
35 ```
36
37 The directories inside of `Sources/` are the wiki
38 [Namespaces][Special:Namespaces]; `Pages/` is the namespace for
39 ordinary pages.
40 Pages are written in [Djot][]{title="Djot (/dʒɑt/)"} with support for
41 the additional features documented below.
42
43 Filenames…
44
45 - *must not* include spaces.
46 - _should_ be PascalCase.
47 - _should_ closely match the title of the page (but _need not_ match it
48 exactly).
49
50 They also need to end in the extension `.djot`.
51
52 The first thing you should do is set up one or more [Editor][Editor:]
53 pages describing yoursel{f∣ves}.
54
55 The website is rebuilt on every push; Git _should_ warn you if there
56 are any errors.
57 Contact me ([][@:Lady]{.sig}) if things go horribly wrong.
58
59 {#djot-ext}
60 ## extensions to the Djot syntax
61
62 {id="djot.links-internal"}
63 ### internal links
64
65 A reference link which contains a colon is an internal link.
66 Typically, you should not include link text and just let it be
67 autogenerated from the page title.
68
69 - For any page, its full reference is `[][NamespaceName:FileName]`.
70
71 - Some namespaces have an abbreviated syntax:8--:
72
73 - Pages in the `Page` namespace can be referred to as just
74 `[][:FileName]`.
75
76 - Namespaces themselves can be linked as `[][NamespaceName:]`; this
77 is short for `[][Namespace:NamespaceName]`.
78 *Namespace pages are not implemented yet.*
79
80 - Editor pages can be linked as `[][@:YourName]`.
81 Add the class `sig` to format the link as a signature.
82
83 - Category pages can be linked as `[][#:Category]`. *Category pages
84 are not implemented yet.*
85
86 - The `v` attribute can be used to select an alternate title for the
87 page.
88 For example, `[][:FileName]{v=plural}`.
89 Variant titles must be specified on the title of the page being
90 linked, for example `{v-plural=FileNames}`.
91
92 - To link a section within a page, follow its filename with a hash and
93 the section i·d: `[][:FileName#section]`.
94 *This isn’t implemented yet.*
95
96 - If a page doesn’t exist, it will generate a “redlink” to
97 [][Special:NotFound] and the page will appear on the list at
98 [][Special:ToDo].
99 *The latter isn’t implemented yet.*
100
101 - The `@as` attribute can be used on emphasized text to change what
102 H·T·M·L element is used.
103 The following values are supported:8--:
104
105 - `_b_{as=b}`
106 - `_cite_{as=cite}`
107 - `_i_{as=i}`
108 - `_u_{as=u}`
109
110 {id="djot.links-external"}
111 ### external links
112
113 For the most part these work exactly as expected.
114 Both reference links and inline links are allowed.
115
116 You should give external links a `@title`, like
117 `{title="Some External Document"}`.
118 This is used to generate the title to use for the link in the listing
119 at the bottom of the page.
120 If the title matches the link text, you can leave the link text blank,
121 as in `[](https://example.com){title="Example Page"}`:
122 [](https://example.com){title="Example Page"}.
123
124 {#bcp}
125 ## best practices
126
127 {id="bcp.writing" v-full="best practices while {writing ∣ editing}"}
128 ### while {writing ∣ editing}
129
130 - *Use Unicode* to the best of your ability.
131 There are symbols defined for most spaces and invisible characters.
132 You can also escape any special character using the following
133 syntax:8--: `:U+NNNN:` (where `NNNN`:mathsp:=:mathsp:the
134 codepoint in hexadecimal).
135 However, it is generally best to just input the characters directly
136 if you are able.
137
138 - *Wrap lines* to (at most) 71 characters.
139
140 - *Indent with spaces,* not tabs.
141
142 - *Put each sentence on its own line.*
143 This helps to keep git diffs clean and means that only sentences, not
144 entire paragraphs, will need to be reflowed.
145
146 - *Don’t capitalize titles,* unless they begin with a proper noun.
147 (*Do* capitalize filenames.)
148
149 - *Sign opinions,* ideally with a link to your [Editor][Editor:]’s
150 page, like this: [][Editor:Lady]{.sig}.
151 This offers them some protection against other people removing them
152 just because they disagree.
153
154 - *Communicate in‐band,* again with signatures; if you want to talk
155 about the contents of a page, there is no better place to do that
156 than the page itself.
157
158 - *Feel free to copy·edit* other people’s words (including and up to
159 deleting and re·writing the whole thing), but *try to preserve
160 ideolect* (e·g don’t change someone else’s typography for no
161 reason).
162
163 {id="bcp.git" v-full="best practices using git"}
164 ### using git
165
166 - *Use descriptive commit names.*
167 These don’t have to be long, but they should be informative enough
168 that someone following the [Atom feed][] has a general idea of
169 what the change entails.
170
171 - *Rebase, don’t merge.*
172 We want to preserve a linear commit history.
173 You should probably set `git config --global pull.ff only` if you
174 haven’t already.
175
176 - *Only force push [with lease][git push --force-with-lease].*
177 Ideally, don’t force push at all, but there are some cases where it
178 might be necessary (e·g, if you accidentally make a merge commit).
179
180 - You can work on changes you don’t want to be live yet in a branch,
181 but *branching is discouraged* and it’s better to just work messily
182 on `live`.
183
184 [Djot]:
185 https://htmlpreview.github.io/?https://github.com/jgm/djot/blob/maste
186 r/doc/syntax.html
187 [Atom feed]:
188 https://git.ladys.computer/Wiki/atom
189 [git push --force-with-lease]:
190 https://git-scm.com/docs/git-push#Documentation/git-push.txt---no-for
191 ce-with-lease
This page took 0.058814 seconds and 5 git commands to generate.