Wiki-Quellcode von How To Wiki

Version 30.1 von Daniel Herrmann am 2022/11/20 10:50

version	line-number	content
14.1	1	Herzlich willkommen auf dem Makerspace Darmstadt Wiki!
6.1	2
14.1	3	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	{{info icon="false" title="Fehlt etwas?"}}
	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!
6.1	10	{{/info}}
	11
15.1	12	= {{id name="HowToWiki-Inhaltsverzeichnis"/}}Inhaltsverzeichnis =
	13
	14	{{toc/}}
	15
7.1	16	= {{id name="HowToWiki-AufbaudesWikis"/}}Aufbau des Wikis =
6.1	17
16.1	18	== {{id name="HowToWiki-WikiÜbersicht"/}}Wiki Übersicht ==
6.1	19
21.1	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.
16.1	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
13.1	26	(% class="wrapped" %)
7.1	27	\|=(((
	28	Bereich
	29	)))\|=(((
	30	Spaces
	31	)))\|=(((
	32	Wer darf Lesen
	33	)))\|=(((
	34	Wer darf Schreiben
	35	)))
	36	\|(((
	37	Öffentlich
	38	)))\|(((
	39	Alle Werkstätten, Projekte, Der Verein
	40	)))\|(((
	41	Jeder (auch ohne Anmeldung)
	42	)))\|(((
	43	Jedes Mitglied
	44	)))
	45	\|(((
	46	Intern
	47	)))\|(((
	48	Intern
	49	)))\|(((
	50	Jedes Mitglied
	51	)))\|(((
	52	Jedes Mitglied
	53	)))
	54	\|(((
	55	Geschützt
	56	)))\|(((
	57	Inner Circle
	58	)))\|(((
	59	Vorstand + Bereichsleiter
	60	)))\|(((
	61	Vorstand + Bereichsleiter
	62	)))
2.1	63
16.1	64	== {{id name="HowToWiki-Pages"/}}Pages ==
	65
21.1	66	Innerhalb der Spaces werden Seiten erstellt, die hierarchisch aufgebaut werden. Folgende Regeln gelten für die Seiten (Pages):
2.1	67
7.1	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
4.1	72
16.1	73	Der Aufbau und die Struktur innerhalb eines Bereichs (Holz, Metall, Laser, ...) ist immer gleich und wird hier am Beispiel der Holzwerkstatt gezeigt:
	74
	75	{{documentTree/}}
	76
	77	Die Seiten sind:
	78
25.1	79	* Holzwerkstatt Home: Bereichsübersicht, Fotos, Bereichsleiter, ... alles was den Bereich im allgemeinen Betrifft
16.1	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.
25.1	82	* Kleinwerkzeuge: Eine Seite pro Kleinwerkzeug in diesem Bereich
	83	* Kleinwerkzeuge => Unterseite: Unterhalb können weitere Seiten mit Details oder Anleitungen/Tutorials angelegt werden. Als Beispiel könnte dort eine Anleitung erstellt werden, wie zb mit dem Exzenterschleifer zu arbeiten ist oder wie man Stemmeisen verwendet.
	84	* Anleitungen: Sammelpunkt der Links zu allen an Maschinen/Kleingeräte angehängter Betriebsanleitungen. Zeigt alle files mit den tags 'holz' und 'anleitung'
	85	* Arbeitsabläufe und Sicherheit: Material zum korrekten Arbeiten mit gerätekategorien, hauptsächlich der Berufsgenossenschaft. Wird in den jeweiligen Maschinen und Kleingeräten durch die tags 'holz' 'sicherheit' und die kategorie (zb 'kreissäge') verlinkt.
16.1	86
17.1	87	== {{id name="HowToWiki-WaskommtWohin?"/}}Was kommt Wohin? ==
15.1	88
16.1	89	Grundsätzlich gibt es verschiedene Arten von Inhalt, die an unterschiedlichen Stellen im Wiki ihren Platz haben. Die folgende Tabelle gibt eine Übersicht:
15.1	90
19.1	91	(% class="wrapped" %)
16.1	92	\|=(((
	93	Inhalt
	94	)))\|=(((
	95	Wohin
	96	)))
	97	\|(((
	98	Organisatorische Informationen (Einweisungen, Verein, ...)
	99	)))\|(((
	100	[[doc:MD.WebHome]]
	101	)))
	102	\|(((
	103	Sonstige organisatorische oder allgemeine Infos
	104	)))\|(((
	105	[[doc:MD.WebHome]]
	106	)))
	107	\|(((
	108	Beschreibung eigener Projekte (kann gerne auf Anleitungen innerhalb der Bereiche verweisen)
	109	)))\|(((
	110	[[doc:PROJ.WebHome]] > [[doc:PROJ.Mitgliederprojekte.WebHome]]
	111	)))
	112	\|(((
	113	Vereinsprojekte (Datron-Fräse, ...)
	114	)))\|(((
	115	[[doc:PROJ.WebHome]] > [[doc:PROJ.WebHome]]
	116	)))
	117	\|(((
	118	Workshops und Inhalte
	119	)))\|(((
	120	[[doc:PROJ.WebHome]] > Workshops
	121	)))
	122	\|(((
	123	Beschreibung einer Maschine
	124	)))\|(((
	125	//Bereich// > Maschinen
	126	)))
	127	\|(((
	128	Anleitung oder Erklärung zu einer Maschine
	129	)))\|(((
	130	//Bereich// > Maschinen > //Maschine//
	131	)))
	132	\|(((
	133	Allgemeine Anleitungen (Wie erstelle ich Joins bei 3D Druck Teilen?)
	134	)))\|(((
	135	//Bereich// > Anleitungen
	136	)))
	137	\|(((
	138	Interne Inhalte, die nicht für die Öffentlichkeit bestimmt sind
	139	)))\|(((
	140	[[doc:IN.WebHome]]
	141	)))
	142
20.1	143	= {{id name="HowToWiki-BenutzungdesWikis"/}}Benutzung des Wikis =
	144
	145	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:
	146
	147	Wie bearbeite ich eine Seite?
	148
27.1	149	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 Maus - der Screenshot erklärt, wie.
20.1	150
28.1	151	[[image:attach:Screenshot 2022-11-20 at 10.49.52.png\|\|style="max-height: 250.0px;" height="250"]]
20.1	152
	153	Personal Space
	154
	155	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!
	156
28.1	157	[[image:attach:image.png\|\|height="250"]]
27.1	158
17.1	159	= {{id name="HowToWiki-Maschinenvs.Kleinwerkzeuge"/}}Maschinen vs. Kleinwerkzeuge =
4.1	160
7.1	161	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.//
	162
	163	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.
	164
9.1	165	= {{id name="HowToWiki-Linkserstellen"/}}Links erstellen =
	166
12.1	167	[[image:attach:Link erstellen.png\|\|thumbnail="true" data-xwiki-image-style-alignment="start" height="150"]]
9.1	168
10.1	169	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.
	170
9.1	171	\\
	172
19.1	173	\\
	174
	175	\\
	176
	177	\\
	178
7.1	179	= {{id name="HowToWiki-Tags"/}}Tags =
	180
	181	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:
	182
13.1	183	(% class="wrapped" %)
7.1	184	\|=(((
	185	Tag
	186	)))\|=(((
	187	Beschreibung
	188	)))
	189	\|(((
	190	(% class="content-wrapper" %)
5.1	191	(((
7.1	192	{{confluence_badge Style="dark" Text="maschine"/}}
5.1	193	)))
7.1	194	)))\|(((
	195	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.
	196	)))
	197	\|(((
	198	(% class="content-wrapper" %)
	199	(((
	200	{{confluence_badge Style="dark" Text="lbl-quick-link"/}}
	201	)))
	202	)))\|(((
	203	Bewirkt, dass eine Seite in den "Getting Started" Links auf der Startseite angezeigt wird
	204	)))
17.1	205	\|(((
	206	(% class="content-wrapper" %)
	207	(((
	208	{{confluence_badge Style="dark" Text="anleitung-<maschinenkürzel>"/}}
	209	)))
	210	)))\|(((
	211	Für alle Seiten unterhalb einer Maschine - bewirkt, dass die Anleitung danach automatisch auf der Hauptseite der Maschine angezeigt wird
	212	)))
7.1	213
	214	= {{id name="HowToWiki-Lizenz"/}}Lizenz =
	215
	216	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.
8.1	217
	218	= {{id name="HowToWiki-Plugins"/}}Plugins =
	219
	220	Es sind einige Plugins in Verwendung, um die Features oder des Aussehen des Wikis anzupassen:
	221
	222	* [[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
	223	* [[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
	224	* [[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
	225	* [[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
	226	* [[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
	227	* [[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
	228	* [[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
10.1	229
	230	\\
18.1	231
	232	{{info title="Zusätzliche Plugins"}}
	233	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!
	234	{{/info}}

Wiki-Quellcode von How To Wiki

Seitenübersicht

Community

Frage? FAQ!

Offene Werkstatt

Führungen und Rundgänge