]> git.g-eek.se Git - inbyggd-frihet-wiki.git/commitdiff
Styleguide and editorial ground rules provided.
authorGustav Eek <gustav.eek@fripost.org>
Sat, 17 Feb 2018 17:46:07 +0000 (18:46 +0100)
committerGustav Eek <gustav.eek@fripost.org>
Sat, 17 Feb 2018 17:54:35 +0000 (18:54 +0100)
New document *styleguide.mdwn* contains fundamental Ikiwiki concepts,
etc. Links provided in *index.mdwn*. Finally also the
mandatory *sandbox.mdwn* is there.

index.mdwn
sandbox.mdwn [new file with mode: 0644]
styleguide.mdwn [new file with mode: 0644]

index b72dbf2d88e3b78f3c3751b327f2518ddc042295..4d226d14d61913435b4f05b10b2bcc6f622646e8 100644 (file)
@@ -33,11 +33,20 @@ Besök gärna vår **[maillista](https://lists.fripost.org/sympa/info/inbyggd-fr
 * [Vår plan](projekt)
 
 ____________________
+
 * [[Citat]]
 * [[Mjukvarusnack]]
 * [[Läsning]]
 * [/dev/null](null/)
 
+____________________
+
+
+* Notera [vår editerings- och stilguide](styleguide), vilken guidar
+till wikins ramverk, och vår stil.
+
+____________________
+
 
 **[WIP]** Vi testar Matrix som chattprogram, installera [klient](https://matrix.org/docs/projects/try-matrix-now.html) för att kika in på *https://kirkegaard.g-eek.se:8448*.
 
@@ -52,6 +61,7 @@ Klona gärna Inbygg Frihets wiki (denna).
  * SSH -- `gitolite3@git.g-eek.se:inbyggd-frihet-wiki` -- Du behöver skicka ssh-nyckel.
  * HTTP -- `https://git.g-eek.se.org/inbyggd-frihet-wiki` -- Funkar inte ännu`
 
-Vi använder [[ikiwiki]]
+Vi använder [[ikiwiki]]. Läs mer i [vår stilguide](styleguide) om
+formatet. Varje wiki ska ha en [sandlåda](sandbox), vilket också denna har.
 
 ----
diff --git a/sandbox.mdwn b/sandbox.mdwn
new file mode 100644 (file)
index 0000000..3b47e2f
--- /dev/null
@@ -0,0 +1,241 @@
+% Sandlåda (en. Sandbox)
+
+Följande är en sanlåda. Den syftar till att pröva ut
+formatet. Syntaxen
+är [markdown](https://sv.wikipedia.org/wiki/Markdown). Vi hänvisar
+till John
+Grubers
+[Daring Fireball](https://daringfireball.net/projects/markdown),
+[Ikiwikis formateringsguide](http://ikiwiki.info/ikiwiki/formatting)
+och John
+MacFarlanes [Pandoc utökningar](http://pandoc.org/README.html) för
+detaljer i syntaxen.
+
+###Is this a heading?
+
+Sure it is.
+
+Nope my friend.
+
+List:
+
+* thing 1
+* thing 2 [[test page space allowed]]
+* thing 3
+* * sublist a? [[TestPage]]
+* * sublist b [[testpage]]
+* thing 4
+
+
+
+[[!meta date="Thu Jun 16 22:04:33 2005" updated="Thu Dec 22 01:23:20 2011"]]
+
+This is the [[SandBox]], a page anyone can edit to try out ikiwiki
+(version [[!version  ]]).
+vvvv
+CamelCase ?
+
+[[!tag sandbox]]
+
+What about [[this page]], nono better [[that page]]?
+
+hello world (right back at ya)
+
+wait how does versioning work
+
+test, is it being saved? Probably. I will check. This seems really straightforward.
+
+Hello!
+
+~~~
+pre formated text?
+~~~
+
+```
+testing markdown
+```
+
+# one
+
+- foo
+
+## two
+
+- bar
+
+### trois
+
+- blah
+       - more blah
+
+#### quatre
+
+## bir
+- bir
+
+## iki
+- iki
+
+* yildiz
+** cyildiz
+
+- tire
+  - ctire
+
+* *i dene*
+* **b dene**
+
+
+1. number
+2. list
+       a. ick
+       b. bar
+
+| table | here |
+|----| ---- |
+| test adfasdfasdfa | 2 |
+| subtest | adfad|
+
+Sort of formatted.. No borders, though.
+
+
+> This is a blockquote.
+>
+> This is the first level of quoting.
+A block of text
+>
+> > This is a nested blockquote.
+>
+>> Without a space works too.
+>>> to three levels
+
+This is pretty sweet
+
+Azerty
+** Qsdf **
+
+>
+> Back to the first level.
+>
+> added a line in level 1
+> and another
+
+
+Numbered list
+
+1. First item.
+       1. Sub item.
+       1. Number 2
+1. Another.
+1. And another..
+       1. foo
+       2. bar
+       3. quz
+       3. quze
+
+Bulleted list
+
+* item
+* *italic item*
+* item
+* one
+  * footballs; runner; unices
+  * Cool !
+       * test
+  * this
+* something else
+  * some more
+  * and more
+       * and
+         * this
+> a blockquote
+> in a list
+> how is this handled
+               *this  _ _ _
+         * this 2
+         * this 3
+
+test _this_ out.
+
+`test this code block`
+[[!wikipedia War_of_1812]]
+----
+
+[[!template id=note text="this is generated by the [[plugins/haiku]] plugin"]]
+[[!haiku hint="sandbox play"]]
+
+----
+
+## Different sorts of links:
+
+* [[Features]]
+* <http://ikiwiki.info/ikiwiki/formatting/>
+* [[different_name_for_a_WikiLink|ikiwiki/WikiLink]]
+* <http://www.gnu.org/>
+* [GNU](http://www.gnu.org/)
+* <a href="http://kitenet.net/~joey/">Joey's blog</a>
+
+----
+
+# header1
+
+## header2
+
+### header3
+
+#### header4
+
+##### header 5
+
+**bold**
+
+_italic_
+
+test ms
+
+opopopo
+----
+
+This **SandBox** is also a [[blog]]!
+
+[[!inline pages="sandbox/* and !*/Discussion" rootpage="sandbox" show="4" archive="yes"]]
+
+Testy test!
+
+
+<p>
+This is an email link:
+<a href="mailto:erik.josefsson@europarl.europa.eu?Subject=Hello%20again" target="_top">
+Send Mail</a>
+</p>
+
+What follows is some preformatted text.  Each line is proceeded by four spaces.
+
+       Test
+
+       <Test>
+
+       <test>
+       <test>
+
+       <test>
+         <child />
+       </test>
+
+...Now why doesn't it work like that on my own copy of ikiwiki? :(
+
+Räksmörgås.
+
+`pre?`
+
+Testing. Test. 試験として書き込みします。
+ℜ𝔢𝔞𝔩𝔩𝔶 𝔠𝔬𝔬𝔩 𝔣𝔬𝔫𝔱, 𝔪𝔞𝔫.
+𝕀𝕗 𝕥𝕙𝕒𝕥'𝕤 𝕨𝕙𝕒𝕥 𝕪𝕠𝕦'𝕣𝕖 𝕚𝕟𝕥𝕠,
+𝓟𝓮𝓻𝓼𝓸𝓷𝓪𝓵𝓵𝔂, 𝓘 𝓵𝓲𝓴𝓮 𝓪 𝓫𝓲𝓽 𝓸𝓯 𝓼𝓽𝔂𝓵𝓮. 𝓐𝓷𝓭 𝓬𝓵𝓪𝓼𝓼.
+𝕭𝖚𝖙 𝕴 𝖉𝖔𝖓'𝖙 𝖍𝖆𝖛𝖊 𝖆 𝖇𝖚𝖌 𝖆𝖇𝖔𝖚𝖙 𝖎𝖙.
+
+Καλημέρα!
+
+test
+
+I must **emphasise** this.
diff --git a/styleguide.mdwn b/styleguide.mdwn
new file mode 100644 (file)
index 0000000..a0364cc
--- /dev/null
@@ -0,0 +1,194 @@
+% Wikins stilguide
+
+Detta är ett försök att beskriva syntax och struktur på Inbyggd
+Frihets sida. Ett fåfängt försök i en komplex miljö. När du bidrar med
+innehåll, är bidraget det viktiga. Kolla annars hur vi gjort i övrigt,
+och ring om du är osäker.
+
+Wikin genereras med [[ikiwiki]]. Syntaxen
+är [markdown](https://sv.wikipedia.org/wiki/Markdown). Vi hänvisar
+till John Grubers
+[Daring Fireball](https://daringfireball.net/projects/markdown),
+[Ikiwikis formateringsguide](http://ikiwiki.info/ikiwiki/formatting)
+och John MacFarlanes [Pandoc utökningar](http://pandoc.org/README.html)
+för detaljer i syntaxen.
+
+Varje wiki ska ha en [sandlåda](sandbox), vilket också denna har.
+
+I övrigt följer vi följande principer
+
+[[!toc]]
+
+
+# Terminologi
+
+ * Begreppen *artikel*, *dokument* och *fil* används synonym åsyftande
+   en sida på wikin.
+
+ * Med *indexsida/indexdokument* åsyftas huvuddokumentet i en subhierarki av sidor.
+
+
+# Språk
+
+Wikin är i allmänhet svenskspråkig, men också engelska
+förekommer. Eftersträva svenska. Viktigare dock, är att vara entydig
+och konsekvent inom en artikel. Vissa artiklar/dokumnet förekommer i
+flera språk. Markera detta per flera versioner,
+t.ex. *styleguide-sv.mdwn* och *styleguide-en.mdwn*.
+
+
+# Döp dokument -- filens namn
+
+Dokumentets filnamnet reglerar URL:en (Universal Resource Location),
+men titeln bestäms enligt nedan. Välj något passande. Detta
+dokumentets filnamn är t.ex. "styleguide" (där föredrogs engelska)
+trotas att titeln är "Wikins stilguide"
+
+
+# Rubrikhierarkier i dokumenten
+
+Avsnitt avdelas med avsnittsrubriker. Dessa markeras med "#". Använd i
+första hand förstahierarkin. Varje avsnitt ska också ha *minst* ett
+stycke. Exempel:
+
+```
+Första stycke i ett dokument
+
+
+# Först nivå underrubrik markerar avsnitt
+
+Första stycke i detta avsnitt beskriver avnittets syfte och
+innehåll. Här presenteras typiskt underliggande avsnittshierarki och
+dess betydelse.
+
+## Andra-nivå avsnittrubrik
+
+Dessa stycken förtydligar och fördjupar överhierarkiska avsnitt.
+
+## Ännu en andranivårubrik
+
+Med stycke.
+
+
+# Ytterligare förstanivå avsnittsrubriker
+
+Som sagt varje avsnitt ska också ha *minst* ett stycke
+```
+
+
+# Titel i dokument
+
+Välj en titel som passar. Inför den per Pandocs initiativ "%"-syntaxen:
+
+```
+% Dokumentets titel
+% Författare
+% Datum
+
+Första stycke
+
+
+# Först hierarki underrubrik markerar avsnitt
+
+Första stycke i detta avsnitt ...
+```
+
+Använd alternativt YAML-versionen:
+
+```
+---
+title: Dokumentets titel
+author: Författare
+date: datum
+subtitle: Undertitel, vilket bl.a. möjliggörs av YAML-konstruktionen
+...
+
+Första stycke
+
+
+# Först hierarki underrubrik markerar avsnitt
+
+Första stycke i detta avsnitt ...
+```
+
+
+# Dokumenthierarkier
+
+Ikiwiki
+har [stöd för hierarkier](https://ikiwiki.info/ikiwiki/subpage/). Det
+är användbar struktur i många sammanhang. Innbyggd frihets wiki är en
+strukturerad samling information som ofta snarare återspeglar en
+traditionell hemmsida än en encyklopedi. Där lämpar sig ofta att
+använda hierarkier. Dock finns risk för överanvändning av hierarkisk
+struktur framför andra strukturtekniker, som t.ex. taggar, kategorier,
+och index.
+
+Konstruera hierarki såhär:
+
+```
+wiki/
+  index.mdwn
+  guider.mdn
+  guider/
+       grub.mdwn
+       liebreboot.mdwn
+       etc.
+```
+
+Från hemsidan (*index.mdwn*) hänvisas till indexsidan "Guider"
+(*guider.mdwn*) som i sin tur har undersidor, "Guide för GRUB"
+(*grub.mdwn*), "Liebreboot" (liebreboot.mdwn), etc. Dokumentets
+filnamnet reglerar URL:en men titeln bestäms enligt ovan.
+
+Läs också mer om
+[länkningsregler](https://ikiwiki.info/ikiwiki/subpage/linkingrules/),
+Ikiwiki.
+
+Undvik avsnitt i indexsidor. En *indexsida*, t.ex. *guider.mdwn*, är
+en sida med undersidor. Det faktum att du *vill* ha riktiga
+*undersidor* innebär ett *visst* behov av hierarki. Låt då den
+strukturen stå för sig själv och använd dessa undersidors titel som
+nästa undernivå. Kolla hur vi gjort i övrigt om du är osäker.
+
+
+# Vertikalt mellanrum
+
+Vertikalt mellanrum, det tycker vi om. Goda exempel:
+
+```
+### KGPE-D16
+
+**General.** (Libreboot-20160907)
+
+  * RAM is sensitive, less is more likely to
+       work. See
+       [coreboot wiki](https://www.coreboot.org/Board:asus/kgpe-d16) for
+       working configurations
+
+  * Internal GPU works (for text mode only), note the hardware switch
+       (see motherboard manual)
+
+Moreover
+
+  * North bridge (?) gets hot
+
+        * A system with 2x 6276 CPUs draws between 200 and 400 watt
+        * There are two ethernet ports and one IPMI (not used)
+        * RAM order is important, see motherboard manual
+
+  * Hardware jumpers for GPU, ethernet etc.
+```
+
+
+# Radbrytning och mellanslag
+
+Det är god sed att, om möjligt, ställ in din texteditor på att bryta
+vid 80 tecken e.dy. Då blir det lättare att tillgodogöra sig
+innehållet i text-form, jämfört med att raderna sticker iväg över hela
+skärmen.
+
+Granska så att du inte stoppar in mellanslag där det inte ska vara
+(t.ex. i slutet på raden där det ofta smyger sig in). Sist tecken i
+varje dokument ska vara nyradstecken.
+
+Emacsanvändare kan använda `M-x whitespace-cleanup`.