Der VereinWiki-Quellcode von How To Wiki
Version 9.1 von Daniel Herrmann am 2020/01/13 22:45
Zeige letzte Bearbeiter
| author | version | line-number | content |
|---|---|---|---|
| 1 | 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. | ||
| 2 | |||
| 3 | {{info title="Mitarbeit erwünscht"}} | ||
| 4 | Das Wiki ist so gedacht, dass jedes Mitglied mitarbeiten kann. Fällt dir irgendwas auf, was falsch ist? Korrigiere es gerne! Fehlt dir irgendwas? Füge es gerne hinzu! Das Wiki lebt von deiner Mitarbeit! Bitte beachte jedoch die unterstehenden Regeln und Best Practices. | ||
| 5 | {{/info}} | ||
| 6 | |||
| 7 | = {{id name="HowToWiki-AufbaudesWikis"/}}Aufbau des Wikis = | ||
| 8 | |||
| 9 | 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 werden. 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: | ||
| 10 | |||
| 11 | |=((( | ||
| 12 | Bereich | ||
| 13 | )))|=((( | ||
| 14 | Spaces | ||
| 15 | )))|=((( | ||
| 16 | Wer darf Lesen | ||
| 17 | )))|=((( | ||
| 18 | Wer darf Schreiben | ||
| 19 | ))) | ||
| 20 | |((( | ||
| 21 | Öffentlich | ||
| 22 | )))|((( | ||
| 23 | Alle Werkstätten, Projekte, Der Verein | ||
| 24 | )))|((( | ||
| 25 | Jeder (auch ohne Anmeldung) | ||
| 26 | )))|((( | ||
| 27 | Jedes Mitglied | ||
| 28 | ))) | ||
| 29 | |((( | ||
| 30 | Intern | ||
| 31 | )))|((( | ||
| 32 | Intern | ||
| 33 | )))|((( | ||
| 34 | Jedes Mitglied | ||
| 35 | )))|((( | ||
| 36 | Jedes Mitglied | ||
| 37 | ))) | ||
| 38 | |((( | ||
| 39 | Geschützt | ||
| 40 | )))|((( | ||
| 41 | Inner Circle | ||
| 42 | )))|((( | ||
| 43 | Vorstand + Bereichsleiter | ||
| 44 | )))|((( | ||
| 45 | Vorstand + Bereichsleiter | ||
| 46 | ))) | ||
| 47 | |||
| 48 | Innerhalb der Spaces werden Seiten erstellt, die hierarchisch aufgebaut werden. Folgende Regeln gilt für die Seiten (Pages): | ||
| 49 | |||
| 50 | * Der Page-Name muss innerhalb eines Spaces eindeutig sein | ||
| 51 | * Der Page-Name darf keine Sonderzeichen enthalten | ||
| 52 | * Es darf innerhalb eines Spaces maximal 3 Level geben, darunter darf keine weitere Seite angelegt werden | ||
| 53 | * Es existieren zwei Templates ein allgemeines und eins für die Beschreibung von Maschinen. Letzteres ist beim Erstellen neuer Maschinen zu verwenden | ||
| 54 | |||
| 55 | = {{id name="HowToWiki-MaschinenundKleinwerkzeuge"/}}Maschinen und Kleinwerkzeuge = | ||
| 56 | |||
| 57 | 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.// | ||
| 58 | |||
| 59 | 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. | ||
| 60 | |||
| 61 | = {{id name="HowToWiki-Linkserstellen"/}}Links erstellen = | ||
| 62 | |||
| 63 | 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: | ||
| 64 | |||
| 65 | \\ | ||
| 66 | |||
| 67 | = {{id name="HowToWiki-Tags"/}}Tags = | ||
| 68 | |||
| 69 | 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: | ||
| 70 | |||
| 71 | |=((( | ||
| 72 | Tag | ||
| 73 | )))|=((( | ||
| 74 | Beschreibung | ||
| 75 | ))) | ||
| 76 | |((( | ||
| 77 | (% class="content-wrapper" %) | ||
| 78 | ((( | ||
| 79 | {{confluence_badge Style="dark" Text="maschine"/}} | ||
| 80 | ))) | ||
| 81 | )))|((( | ||
| 82 | 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. | ||
| 83 | ))) | ||
| 84 | |((( | ||
| 85 | (% class="content-wrapper" %) | ||
| 86 | ((( | ||
| 87 | {{confluence_badge Style="dark" Text="lbl-quick-link"/}} | ||
| 88 | ))) | ||
| 89 | )))|((( | ||
| 90 | Bewirkt, dass eine Seite in den "Getting Started" Links auf der Startseite angezeigt wird | ||
| 91 | ))) | ||
| 92 | |||
| 93 | = {{id name="HowToWiki-Lizenz"/}}Lizenz = | ||
| 94 | |||
| 95 | 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. | ||
| 96 | |||
| 97 | = {{id name="HowToWiki-Plugins"/}}Plugins = | ||
| 98 | |||
| 99 | Es sind einige Plugins in Verwendung, um die Features oder des Aussehen des Wikis anzupassen: | ||
| 100 | |||
| 101 | * [[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 | ||
| 102 | * [[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 | ||
| 103 | * [[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 | ||
| 104 | * [[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 | ||
| 105 | * [[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 | ||
| 106 | * [[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 | ||
| 107 | * [[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 |