MKSP - How To Wiki

Herzlich willkommen auf dem Makerspace Darmstadt Wiki!

Diese Seite stellt ein paar Informationen insbesondere für diejenigen zusammen, die aktiv am Wiki arbeiten möchten. Das Wiki ist so gedacht, dass jedes Mitglied mitarbeiten kann. Das Wiki lebt von deiner Mitarbeit! Bitte beachte jedoch die unterstehenden Regeln und Best Practices.

4

5

**Fällt dir irgendwas auf, was falsch ist?** Korrigiere es gerne!

6

**Fehlt dir irgendwas?** Füge es gerne hinzu!

7

8

9

Fehlen dir auf dieser Seite irgendwelche Informationen, die Du brauchst, um am Wiki mitzuarbeiten? Hinterlasse einfach ein Kommentar unten, dann werden wir uns darum kümmern, deine Fragen möglichst zeitnah zu beantworten!

10

11

12

= {{id name="HowToWiki-Inhaltsverzeichnis"/}}Inhaltsverzeichnis =

= {{id name="HowToWiki-AufbaudesWikis"/}}Aufbau des Wikis =

17

18

== {{id name="HowToWiki-WikiÜbersicht"/}}Wiki Übersicht ==

19

20

Als Software des Wikis kommt eine Community-Version von [[Atlassian Confluence>>url:https://www.atlassian.com/software/confluence||shape="rect"]] zum Einsatz, die uns als Makerspace kostenfrei zur Verfügung gestellt wird.

21

22

== {{id name="HowToWiki-Spaces"/}}Spaces ==

23

24

Das Wiki ist in verschiedene so genannte Spaces eingeteilt, je einen für einen Werkstattbereich sowie einige interne Bereiche. Der Zugriff auf manche internen Bereiche ist geschützt. Übersicht:

25

26

(% class="wrapped" %)

|=(((

Bereich

)))|=(((

Spaces

)))|=(((

Wer darf Lesen

)))|=(((

Wer darf Schreiben

)))

|(((

Öffentlich

)))|(((

Alle Werkstätten, Projekte, Der Verein

40

)))|(((

41

Jeder (auch ohne Anmeldung)

)))|(((

Jedes Mitglied

)))

|(((

Intern

)))|(((

Intern

)))|(((

Jedes Mitglied

)))|(((

Jedes Mitglied

)))

|(((

Geschützt

)))|(((

Inner Circle

)))|(((

Vorstand + Bereichsleiter

60

)))|(((

61

Vorstand + Bereichsleiter

62

)))

63

64

== {{id name="HowToWiki-Pages"/}}Pages ==

65

66

Innerhalb der Spaces werden Seiten erstellt, die hierarchisch aufgebaut werden. Folgende Regeln gelten für die Seiten (Pages):

67

68

* Der Page-Name muss innerhalb eines Spaces eindeutig sein

69

* Der Page-Name darf keine Sonderzeichen enthalten

70

* Es darf innerhalb eines Spaces maximal 3 Level geben, darunter darf keine weitere Seite angelegt werden

71

* Es existieren zwei Templates ein allgemeines und eins für die Beschreibung von Maschinen. Letzteres ist beim Erstellen neuer Maschinen zu verwenden

72

73

Der Aufbau und die Struktur innerhalb eines Bereichs (Holz, Metall, Laser, ...) ist immer gleich und wird hier am Beispiel der Holzwerkstatt gezeigt:

Die Seiten sind:

* **Die Holzwerkstatt**: Bereichsübersicht, Fotos, Bereichsleiter, ... alles was den Bereich im allgemeinen Betrifft

80

* **Maschinen**: Eine Seite pro Maschine, die in diesem Bereich ist

81

* **Maschinen => Unterseite**: Unterhalb jeder Maschine können weitere Seiten mit Details oder Anleitungen bezüglich dieser speziellen Maschine angelegt werden. Als Beispiel könnte dort eine Anleitung erstellt werden, wie bei der Holz-CNC die Z-Achse korrekt eingestellt wird.

82

* **Kleinwerkzeuge**: Übersicht über alle Kleinwerkzeuge in diesem Bereich, die keine eigene Seite haben wie die Maschinen.

83

* **Anleitungen**: Hier können Anleitungen angelegt werden, die einen Vorgang oder ein Verfahren maschinenunabhängig zu beschreiben.

84

85

== {{id name="HowToWiki-WaskommtWohin?"/}}Was kommt Wohin? ==

86

87

Grundsätzlich gibt es verschiedene Arten von Inhalt, die an unterschiedlichen Stellen im Wiki ihren Platz haben. Die folgende Tabelle gibt eine Übersicht:

88

89

(% class="wrapped" %)

|=(((

Inhalt

)))|=(((

Wohin

)))

|(((

Organisatorische Informationen (Einweisungen, Verein, ...)

)))|(((

[[doc:MD.WebHome]]

)))

|(((

Sonstige organisatorische oder allgemeine Infos

)))|(((

[[doc:MD.WebHome]]

)))

|(((

Beschreibung eigener Projekte (kann gerne auf Anleitungen innerhalb der Bereiche verweisen)

107

)))|(((

108

[[doc:PROJ.WebHome]] > [[doc:PROJ.Mitgliederprojekte.WebHome]]

109

)))

110

|(((

111

Vereinsprojekte (Datron-Fräse, ...)

112

)))|(((

113

[[doc:PROJ.WebHome]] > [[doc:PROJ.WebHome]]

114

)))

115

|(((

116

Workshops und Inhalte

117

)))|(((

118

[[doc:PROJ.WebHome]] > Workshops

119

)))

120

|(((

121

Beschreibung einer Maschine

122

)))|(((

123

//Bereich// > Maschinen

124

)))

125

|(((

126

Anleitung oder Erklärung zu einer Maschine

127

)))|(((

128

//Bereich// > Maschinen > //Maschine//

129

)))

130

|(((

131

Allgemeine Anleitungen (Wie erstelle ich Joins bei 3D Druck Teilen?)

132

)))|(((

133

//Bereich// > Anleitungen

134

)))

135

|(((

136

Interne Inhalte, die nicht für die Öffentlichkeit bestimmt sind

)))|(((

[[doc:IN.WebHome]]

)))

= {{id name="HowToWiki-BenutzungdesWikis"/}}Benutzung des Wikis =

142

143

Learning by Doing - vermutlich der effektivste Weg, dich ins Wiki einzufinden. Probier gerne aus, du kannst immer in der Version der Seite zurückspringen und Änderungen rückgängig machen. Auf zwei wichtige Dinge soll jedoch hingewiesen werden:

144

145

**Wie bearbeite ich eine Seite?**

146

147

Das ist leider nicht ganz so intuitiv, wie man es sich wünschen würde. Der einfachste Weg ist, einen der vielen Shortcuts (einfach oben rechts am Rand mal das Fragezeichen drücken) zu verwenden. Drücke einfach "e" auf deiner Tastatur und du kannst die Seite bearbeiten. Natürlich geht es aber auch per Tastatur - der Screenshot erklärt, wie.

148

149

[[image:url:https://files.slack.com/files-pri/T5JH1DB7B-F010RBD2H2B/image.png]]

**Personal Space**

Wenn Du oben Rechts auf dein Icon klickst, kannst Du einen "Personal Space" erstellen. Dieser gehört völlig dir, außer Dir hat niemand Zugriff darauf. Du kannst ihn für persönliche Notizen verwenden, oder - gerade wenn du am Anfang noch unsicher bist - als Playground, um erweiterte Funktionen des Wikis wie Macros und Links auszuprobieren. Du kannst auch anderen Leuten nachträglich Zugriff auf bestimmte Seiten in diesem persönlichen Space geben oder die Seite zu einem öffentlichen Bereich verschieben - probier es einfach aus!

154

155

= {{id name="HowToWiki-Maschinenvs.Kleinwerkzeuge"/}}Maschinen vs. Kleinwerkzeuge =

156

157

Wir unterscheiden zwischen **Maschinen** und **Kleinwerkzeuge**. **Maschinen** haben eine eigene Wiki-Seite direkt unterhalb der jeweiligen Werkstatt. Für **Kleinwerkzeuge** gibt es in jedem Werkstatt-Bereich eine eigene Seite für deren Beschreibung und Auflistung. //Für jedes Kleinwerkzeug ist hier eine "Heading 1" Überschrift zu wählen.//

158

159

Es gibt derzeit noch keine allgemeine Definition, was eine Maschine und was ein Kleinwerkzeug ist. Als Daumenregel: Wenn es sich lohnt, für irgendetwas eine eigene Wiki-Seite zu erstellen, dann kann es als Maschine angesehen werden.

160

161

= {{id name="HowToWiki-Linkserstellen"/}}Links erstellen =

162

163

[[image:attach:Link erstellen.png||thumbnail="true" data-xwiki-image-style-alignment="start" height="150"]]

164

165

Beim erstellen von Links zu Seiten im Wiki ist darauf zu achten, **dass nicht einfach die Adresszeile des Browsers kopiert wird**. Wird die Seite umbenannt, sind die Links nicht mehr gültig! Stattdessen sollte wie auf dem folgenden Screenshot zu sehen ein Link zur Seite generiert werden. Dieser ist kürzer und bleibt auch nach dem Umbenennen einer Seite konsistent.

\\

\\

\\

\\

= {{id name="HowToWiki-Tags"/}}Tags =

176

177

Confluence verwendet Tags für die Organisation von Inhalten. So können beispielsweise automatisch Inhalte mit einem bestimmten Tag an einer anderen Stelle zusammengefasst werden. Folgende Tags werden aktuell verwendet:

178

179

(% class="wrapped" %)

|=(((

Tag

)))|=(((

Beschreibung

)))

|(((

(% class="content-wrapper" %)

(((

)))

)))|(((

Darf nur an Pages von Maschinen innerhalb eines Bereichs angefügt werden und bewirkt, dass die Maschine automatisch in der Geräteübersicht angezeigt wird.

192

)))

193

|(((

194

(% class="content-wrapper" %)

(((

)))

)))|(((

Bewirkt, dass eine Seite in den "Getting Started" Links auf der Startseite angezeigt wird

200

)))

201

|(((

202

(% class="content-wrapper" %)

203

(((

204

{{confluence_badge Style="dark" Text="anleitung-<maschinenkürzel>"/}}

205

)))

206

)))|(((

207

Für alle Seiten unterhalb einer Maschine - bewirkt, dass die Anleitung danach automatisch auf der Hauptseite der Maschine angezeigt wird

208

)))

209

210

= {{id name="HowToWiki-Lizenz"/}}Lizenz =

211

212

Um die kommerzielle Verwendung der hier erstellten Inhalte zu verhindern, wird der Inhalt unter die [[Creative Commons Attribution-NonCommercial-ShareAlike Lizenz>>url:https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode||shape="rect"]] gestellt. Durch deine Mitarbeit erkennst Du an, dass diese Lizenz auch für von dir veröffentliche Inhalte im Wiki gilt.

213

214

= {{id name="HowToWiki-Plugins"/}}Plugins =

215

216

Es sind einige Plugins in Verwendung, um die Features oder des Aussehen des Wikis anzupassen:

217

218

* [[Refined>>url:https://marketplace.atlassian.com/apps/15231/refined-structure-and-theme-confluence?hosting=server&tab=overview||shape="rect"]] und [[Refined Mobile>>url:https://marketplace.atlassian.com/apps/22008/refined-mobile-for-confluence?hosting=server&tab=overview||shape="rect"]]: Theme sowie Einführung des Space-Kategorien. Bessere Unterstützung für mobile Endgeräte

219

* [[No Email Storm>>url:https://marketplace.atlassian.com/apps/42684/no-email-storm?hosting=server&tab=overview||shape="rect"]]: Anpassung der Notification und Watcher Einstellungen in Confluence

220

* [[SAML Single Sign On>>url:https://marketplace.atlassian.com/apps/1212129/saml-single-sign-on-sso-confluence?hosting=server&tab=overview||shape="rect"]]: Anbindung an unser Anmeldesystem Keycloak

221

* [[Sketch for Confluence>>url:https://marketplace.atlassian.com/apps/1211075/sketch-for-confluence-image-editing?hosting=server&tab=overview||shape="rect"]]: Add-on zur Bearbeitung von Bildern und Fotos direkt während des Uploads

222

* [[Scroll Exporter for Confluence>>url:https://marketplace.atlassian.com/apps/24982/scroll-word-exporter-for-confluence?hosting=server&tab=overview||shape="rect"]]: Gut aussehender Export von Confluence Seiten in Word Dokumente

223

* [[Google Drive / Docs for Confluence>>url:https://marketplace.atlassian.com/apps/1216484/google-drive-docs-for-confluence?hosting=server&tab=overview||shape="rect"]]: Plugin zum Einbinden von Google Docs direkt in Confluence

224

* [[Draw.io>>url:https://marketplace.atlassian.com/apps/1210933/draw-io-diagrams-for-confluence?hosting=server&tab=overview||shape="rect"]]: Plugin zum Zeichnen von Graphen und technischen Zeichnungen

\\

Fehlt dir eine bestimmte Funktionalität, die sich [[über ein Plugin>>url:https://marketplace.atlassian.com/addons/app/confluence||shape="rect"]] nachrüsten ließe? Dann hinterlasse einfach ein Kommentar, wir werden das prüfen!

230

Wiki-Quellcode von How To Wiki