commit bb4bd94aec430436a3c612b719022b2303e21af9
parent 3e5b10aec7a79c5c1c355862bfcd32a4967dfe17
Author: ugrnm <ultrageranium@bleu255.com>
Date: Fri, 6 Nov 2026 14:59:19 +0100
editing style WIP
Diffstat:
| M | editing.mdwn | | | 128 | +++++++++++++++++++++++++++++-------------------------------------------------- |
1 file changed, 47 insertions(+), 81 deletions(-)
diff --git a/editing.mdwn b/editing.mdwn
@@ -3,105 +3,84 @@ To edit the wiki, you need to be part of the orchad [[circle]].
Intention
---------
-Permacomputing wiki is not Wikipedia, so being neutral or encyclopedic is
-not among our goals, and original research is encouraged. However, it is a
-collaborative project, so if you want to express an opinion the other editors
-may not agree with, please discuss it in the orchad circle, or the bbs forum.
-It can be possible that a page or entry needs to be written to take into acount
-multiple perspectives. Keep in mind however that we aim at hosting material
-that can help us move the discourse and practice forward, so
-[https://en.wikipedia.org/wiki/Pharmakon pharmakonesque] deadlocks should be
+Permacomputing wiki is not Wikipedia, so being neutral or encyclopedic is not among our goals, and original research is encouraged. However, it is a collaborative project, so if you want to express an opinion the other editors may not agree with, please discuss it in the orchad circle, or the bbs forum. It can be possible that a page or entry needs to be written to take into acount multiple perspectives. Keep in mind however that we aim at hosting material that can help us move the discourse and practice forward, so [https://en.wikipedia.org/wiki/Pharmakon pharmakonesque] deadlocks should be
avoided.
Wiki areas
----------
-We do not have fine grained permissions and would like to implement bureauracy
-with wiki editing, so please be mindful of the following house rules:
+We do not have fine grained permissions and would like to implement as little bureauracy as needed for wiki editing, so please be mindful of the following house rules:
-* Home page: do not edit. Its content is the result of a few years of trying things out, and it's good enough. If something needs to be changed there beside grammar/spelling. Discuss it in orchard.
-* Permacomputing design principles: do not edit. This section is updated through collective wiki edit-a-thons organised by bitrot. It needs to remain as stable as possible to be useful for everyone. Feel free to fix grammar/spelling though :)
-* The longer permacomputing introduction: do not edit, same remarks as the Home page.
-* Properties: this page is an ideal starting point to document and address positive and negative aspects of computational systems.
-* Getting Started: could do with a cleanup, and simplifications, and checking overlap and duplicate purpose with the
+* **home page**: do not edit. Its content is the result of a few years of trying things out, and it's good enough. If something needs to be changed there beside grammar/spelling. Discuss it in orchard.
+* **permacomputing design principles**: do not edit. This section is updated through collective wiki edit-a-thons organised by bitrot. It needs to remain as stable as possible to be useful for everyone. Feel free to fix grammar/spelling though :)
+* **the longer permacomputing introduction**: do not edit, same remarks as the Home page.
-Copyediting style
-------------------
+* **charateristics**: this page is an ideal starting point to add new and improve existing entries that can help better understand limits of computational systems and highlight better approaches.
+* **Getting Started**: could do with a cleanup, and simplifications, and checking overlap and duplicate purpose with the
-1. explain the abbreviations before using it (ex. Operations Systems (OS) are
- amazing. The OS are actually shit).
-2. make sure the references are explained before using them. (ex. "Unix is a
- multi-user operating system whose development was started in 1969 by Ken
- Thompson and Dennis Ritchie, as well as an entire family of operating system
- derived from the original Unix." First, explain the original Unix, or
- rearrange the sentences where you explain what unix is, then explain that
- there are multiple versions, an original and others). Same for people
- mentioned, quotes, etc.
+(Copy)editing style
+-------------------
-3. explain the relevance of a quote.
+* permacomputing, not Permacomputing
-4. transition between paragraphs, quotes etc. is key. similar to the rule
- above, make sure the paragraphs are transitioning from one point to another.
+* new pages are not capitalised
-5. careful with jargon. if a technical/academic/etc term needs to be used, maybe it
- needs its own page as well. (i.e. "it refers to a very specific kind of
- 'digital', a highly technoprogressivist and industry-defined kind that
- became prominent in the 'digital revolution' hype of the 1990s."
- technoprogressivist is not a common word that could be understood easily,
- either provide a short explanation or make a page for it)
+* British English spelling for English content
-6. check if there are other pages you can crosslink in your text (i.e. you
- mention hardware, link the hardware page there)
+* do not line break within a paragraph
-7. avoid using brackets (as much as possible), it breaks the reading (and
- comprehending) flow (quite a bit) (right?).
+* to keep the source text readable directly as plaintext markdown, only use two heading levels, <code><h1></code> and </code><h2></code>, using the <code>===</code> and <code>---</code> syntax. If you need to go down to <code><h3></code>, consider using **bold** headers instead, worst case, use a <code>###</code> title
-8. avoid passive-aggresive language. rather, explain why some concepts are
- wrong/didn't work/are bad. (i.e. "digital revolution" hype of the 1990s. why
- was it a hype?; so-called "alternatives", why so-called? why air-qyotes?)
+* explain the abbreviations before using it (ex. Operations Systems (OS) are amazing. The OS are actually shit)
-9. make sure all formatting choices are unified in your text. (i.e.
- https://permacomputing.net/Principles/ here, the sub-principles are written
- as a paragraph first, and then as list. should be the same style).
+* make sure the references are explained before using them. (ex. "Unix is a multi-user operating system whose development was started in 1969 by Ken Thompson and Dennis Ritchie, as well as an entire family of operating system derived from the original Unix." First, explain the original Unix, or rearrange the sentences where you explain what unix is, then explain that there are multiple versions, an original and others). Same for people mentioned, quotes, etc.
-10. use formatting sparingly and with purpose.
+* explain the relevance of a quote
-11. avoid repetation and redundant words, be concise, simple, clear.
+* transition between paragraphs, quotes etc. is key. similar to the rule above, make sure the paragraphs are transitioning from one point to another
-12. don't forget to save! EDITING ON THE WEB FOR LONG SESSIONS WITHOUT SAVING
- INCREASE THE CHANCE OF SAVING RIGHT WHEN YOUR SESSION/AUTH HAS EXPIRED AND
- YOUR BROWSER MAY NOT HAVE CACHED THE FORM BEFORE SUBMITTING IT. In doubt,
- for long edits, just quickly copy the form contentto avoid bad surprises.
+* careful with jargon. if a technical/academic/etc term needs to be used, maybe it needs its own page as well. (i.e. "it refers to a very specific kind of 'digital', a highly technoprogressivist and industry-defined kind that became prominent in the 'digital revolution' hype of the 1990s." technoprogressivist is not a common word that could be understood easily, either provide a short explanation or make a page for it)
+
+* check if there are other pages you can crosslink in your text (i.e. you mention hardware, link the hardware page there)
+
+* avoid using brackets (as much as possible), it breaks the reading (and comprehending) flow (quite a bit) (right?)
+
+* avoid passive-aggresive language. rather, explain why some concepts are wrong/didn't work/are bad. (i.e. "digital revolution" hype of the 1990s. why was it a hype?; so-called "alternatives", why so-called? why air-qyotes?)
+
+* make sure all formatting choices are unified in your text. (i.e. https://permacomputing.net/Principles/ here, the sub-principles are written as a paragraph first, and then as list. should be the same style)
+
+* use formatting sparingly and with purpose
+
+* avoid repetation and redundant words, be concise, simple, clear.
+
+
+Saving/Submitting
+-----------------
+
+* **EDITING ON THE WEB FOR LONG SESSIONS WITHOUT SAVING INCREASES THE CHANCE OF LOOSING YOUR EDITS RIGHT WHEN YOUR SESSION/AUTH HAS EXPIRED AND YOUR BROWSER MAY NOT HAVE CACHED THE FORM CONTENT BEFORE SUBMITTING IT.** In doubt for long edits, just quickly copy the form contentto avoid bad surprises.
+
+* editing via git is possible, but requires access to [[eik]]. WIP :)
On attribution, quotes and footnotes
------------------------------------
-At the current stage of maturity of this wiki, it is often not advisable to
-write a comprehensive articles about a topic if someone else has already done
-it elsewhere. Put in a link to that external resource instead. (In the future,
-we will perhaps want to host copies of all these "dependencies" in the local
-repository as well, but not yet.)
+At the current stage of maturity of this wiki, it is often not advisable to write a comprehensive articles about a topic if someone else has already done it elsewhere. Put in a link to that external resource instead. (In the future, we will perhaps want to host copies of all these "dependencies" in the local repository as well, but not yet.)
-When introducing a new term, please try to include a proper and non-biased
-definition of the topic before proceeding to the permacomputing-specific points
-of view. You can use [[Wikipedia]] or other sources for this, **just make sure
-you properly attribute and quote** (we are CC0, Wikipedia is CC-BY-SA, so you
-can't just copy-and-paste even from there).
+When introducing a new term, please try to include a proper and non-biased definition of the topic before proceeding to the permacomputing-specific points of view. You can use [[Wikipedia]] or other sources for this, **just make sure you properly attribute and quote** (we are CC0, Wikipedia is CC-BY-SA, so you can't just copy-and-paste even from there).
-If you rely on other sources for the writing of a section, do not be lazy or
-mindlessly copypaste from other sources. In general, **do not invisibilize
-people from which you took inspiration and/or learned something from**. Take
-the opportunity of contributing to this wiki to also point to their work and
-research. You must properly attribute your source. You have 4 options:
+If you rely on other sources for the writing of a section, do not be lazy or mindlessly copypaste from other sources. In general, **do not invisibilize people from which you took inspiration and/or learned something from**. Take the opportunity of contributing to this wiki to also point to their work and research. You must properly attribute your source. You have 4 options:
* **Hyperlinks:** Sometimes it's enough to point to external reference as an hyperlink if there is not much to discuss. For instance [Ursula K. Le Guin has an interesting take on technology](http://www.ursulakleguinarchive.com/Note-Technology.html).
+
* **Footnotes:** Can be handy to drift a bit[^drift] but also to give a proper footnote reference when paraphrasing and referencing the thoughts of someone else. For instance Ursula K. Le Guin has been critical of a specific usage of the work *technology* when misused to only refer to the most recent developments, which also happen to be the most problematic[^leguinref].
+
* **Inline quotes:** Use this with footnotes when you want to quote something short inline. For instance Ursula K. Le Guin offers to understand technology more broadly as "the active human interface with the material world"[^leguinrefquote].
+
* **Block quotes:** Finally, you may want to quote entirely a part of someone else's writing, in which case, use the block quote formatting, with a footnote for the reference. For instance here is how Ursula K. Le Guin suggests to reconsider how we use the word *technology*:
> Technology is the active human interface with the material world.
@@ -116,9 +95,7 @@ research. You must properly attribute your source. You have 4 options:
### Limitations of the footnotes
-This it not biblatex/biber. So as you can see in the examples above, you cannot
-reuse an existing footnote, and there is not elegant handling of repetition (no
-Ibid.).
+This it not biblatex/biber. So as you can see in the examples above, you cannot reuse an existing footnote, and there is not elegant handling of repetition (no Ibid.).
Reference style
@@ -132,19 +109,8 @@ try to make it work as best as you can, it's just to have some overall
consistency. No sweat :)
-Acceptable content
-------------------
-
-Basically any topic is allowed as long as it can be discussed from a
-permacomputing-relevant point of view and do not break the [[terms]].
-
-
Licensing
---------
While editing the Permacomputing wiki, you agree that your contribution will be
-published and made available under the [CC0
-Waiver](https://creativecommons.org/publicdomain/zero/1.0/legalcode-plain). If
-you use images, photos, from other sources, please make sure to give full
-credit and if available the license/tersm under which the image is made
-available.
+published and made available under the [CC0 Waiver](https://creativecommons.org/publicdomain/zero/1.0/legalcode-plain). If you use images, photos, from other sources, please make sure to give full credit and if available the license/tersm under which the image is made available.
