Wiki-Artikel Vorlage: Unterschied zwischen den Versionen

Aus HSHL Mechatronik
Zur Navigation springen Zur Suche springen
(Die Seite wurde neu angelegt: „Kategorie:HowTo --~~~~ == Einleitung == Das Ziel ist die '''nachhaltige Sicherung von Informationen'''. D. h. die Artikel sollen so geschrieben sein, das…“)
 
(Änderung 114463 von Mirekgoebel (Diskussion) rückgängig gemacht.)
Markierung: Rückgängigmachung
 
(87 dazwischenliegende Versionen von 6 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
[[Kategorie:HowTo]]
[[Kategorie:HowTo]]
[[Kategorie:Vorlagen]]
'''Autoren:'''
<!-- Dies hier wird nicht angezeigt -->


--[[Benutzer:Mirekgoebel|Prof. Dr. Mirek Göbel]] ([[Benutzer Diskussion:Mirekgoebel|Diskussion]]) 11:41, 19. Sep. 2014 (CEST)


== Einleitung ==
== Einleitung ==
Das Ziel ist die '''nachhaltige Sicherung von Informationen'''. D. h. die Artikel sollen so geschrieben sein, dass jemand die Erkenntnisse leicht verwenden kann und z. B. realisierte Projekte nachbauen kann!
 
== Inhalt ==
Die Gliederung des Inhalts hängt stark von Ihrem individuellen Projekt ab. Benutzen Sie einen leicht nachvollziehbaren roten Faden und gliedern Sie nach gesundem Menschenverstand!
 
 
 
=== Unterabschnitt ===
# Nutzen Sie Aufzählungen
#* mit verschiedenen Schachtelungen
#* und so weiter
# zweite Ebene
#* mit erneuter Unterebene
 
=== Bilder ===
Bauen Sie Bilder ein, am Besten mit darin gekennzeichneten Stellen, die Sie dann im Text erklären. Referenzieren Sie Bilder und Tabellen konsequent im Text. Zitieren Sie ggf. die Bildurheber.
[[Datei:RetroGameStation_HSHL_Messe.jpg|rechts|mini|Abb 1: Beispielbild mit Quelle  <ref>© Mirek Göbel - Eigenes Werk</ref>]]
 
==== Bilder in den Text einbetten ====
Wenn Sie Bilder anzeigen möchten, ohne dass der Artikel links oder rechts weiter läuft, können Sie den Textfluss mit dem Befehl <nowiki><br clear=all></nowiki> stoppen (vgl. Abb. 2).
 
[[Datei:Sps steuerung cpu313c.jpg|left|mini|300px|Abb 2: Beispiel <nowiki><br clear=all></nowiki>]]
<br clear=all>
 
Alternativ können Sie das Bild in einer "wikitable" anzeigen lassen. Dadurch wird das Bild auch auf Bildschirmen mit einer anderen Auflösung in der richtigen Darstellungsart angezeigt (vgl. Abb. 3).
{| class="wikitable"
| [[Datei:Sps steuerung cpu313c.jpg|left|mini|300px|Abb 3: Beispiel wikitable]]
|}
Hier geht es weiter mit dem Text.
 
=== Tabellen ===
Tabelle 1 zeigt ein schönes Beispiel. Tipp: Tabellen lassen sich auch aus dem Excel-Format in das MediaWiki-Format konvertieren. Dazu gibt es diese Internetseite: [https://tableconvert.com/excel-to-mediawiki].
{| class="wikitable"
! style="font-weight: bold;" | Spalte 1
! style="font-weight: bold;" | Spalte 2
! style="font-weight: bold;" | Spalte 3
|+ style = "text-align: left"|Tabelle 1: Beispieltabelle
|-
| blabla
| sowieso
| sowieso
|-
| test
| sowieso
| test1
|}
 
{| class="wikitable sortable"
|+ Tabelle mit Sortierfunktion
|-
! Überschrift !! Überschrift !! Überschrift
|-
| Beispiel || Beispiel || Beispiel
|-
| Beispiel || Beispiel || Beispiel
|-
| Beispiel || Beispiel || Beispiel
|}
 
=== Formeln ===
Für Formeln nutzen Sie die <nowiki><math></nowiki>-Umgebung.
 
Dieser Quelltext
 
<code type="latex">
<nowiki><math></nowiki> y = \int\limits_0^2 {\sin \frac{x}{2}dx}<nowiki></math></nowiki>
</code>
 
wird dann so dargestellt
<math>
y = \int\limits_0^2 {\sin \frac{x}{2}dx}
</math>.
 
Eine Übersicht über die Befehle findet sich z. B. hier: [https://latex-kurs.de/fragen/Gleichungen_Basic.html Gleichungen in math].
 
 
=== Sonderzeichen ===
Sonderzeichen setzen Sie einfach über [Alt]+ANSI Code z.B. [Alt]+0177: ±
 
Übersicht der [https://www.chip.de/news/ANSI-Code-Tabelle-Sonderzeichen-schnell-finden_132459812.html ANSI-Code Sonderzeichen]
 
Alternativ kann der [https://www.vioma.de/de/wiki/tools/html-sonderzeichen/#HTML-Sonderzeichen:%20Dingbats%20Zahlen Unicode] eingegeben werden z.B. <nowiki>&#10102;</nowiki> für &#10102;.
 
=== Formatierung ===
Nutzen Sie zur Formatierung Beispiele, z. B. aus dem weltbekannten Wikipedia selbst (das ist die gleiche Syntax!) oder anderer Hilfeseiten wie z. B. <ref> [http://meta.wikimedia.org/wiki/Help:Editing/de Hilfeseite des Wikimedia-Projekts] </ref>.
 
=== Quelltext ===
Anleitung und Beispiele zum Einbinden von Quelltext finden Sie hier: [[Quelltext_einbinden]].
<!-- 27.02.2021 derzeit defekt
Bei lang= muss die richtige Sprache eingetragen werden (matlab, c,...).
 
<source line lang="matlab" style="font-size:small">
for i=1:10
%    try
%        image = CAMERA_DumpFrame(s);     
%    catch err
%        error('MATLAB:RWTHMindstormsNXT:Sensor:unknown', 'An unknown Error occured while fetching the image. Please check that the Camera is connected and try again');
%    end
    image = CAMERA_GetImage(com);
    handle = imshow(image);
    %pause(0.1)
    currTime(i) = toc(startTime);
    disp(['Aktuelle Zeit: ',num2str(currTime(i))])
    %imwrite(image,sprintf('NXTCamImage%03d.png',i));
    %imwrite(img,fullfile(workingDir,sprintf('HexBug%03d.png',n)));
    % ca. alle 4.8 Sekunden ein Bild
end;
</source>
-->
 
=== Zitieren ===
Fremdquellen sollten Sie auf jeden Fall zitieren. Internetquellen können Sie einfach verlinken. Literatur zitieren Sie bitte nach [[Zitieren_nach_DIN1505|DIN ISO 690:2013-10]].
 
=== Absätze ausblenden ===
<div class="mw-collapsible mw-collapsed">
Zusätzliche Informationen können Sie mit dieser Formatierung bei Bedarf ein- und ausklappen.
</div>
 
{| role="presentation" class="wikitable mw-collapsible mw-collapsed"
| <strong>Tipp 1&thinsp;</strong>
|-
| '''Beispiele für Deklarationen:''' <br>
<syntaxhighlight lang="c" style="background-color: #EFF1C1; font-size:small">
BAUD_RATE_u32 = 9600;
const unsigned int AUFLOESUNG_u16 = 1023;
const float ARDUINO_SPANNUNG_f32  = 5.0;
const uint8_t DIGITAL_PIN_u8 = 7;
 
byte i = 0;      // Zählvariablen können vereinfacht werden
byte Cnt_u8 = 0; // Alternative
</syntaxhighlight>
|-
|}




== Aufbau der Artikel ==
{| role="presentation" class="wikitable mw-collapsible mw-collapsed"
Sie dürfen die Vorlage für Wiki-Artikel als Grundlage verwenden. Der Aufbau ist wie folgt:
| <strong>Musterlösung&thinsp;</strong>
|-
| Hier Musterlösung einfügen.
|-
|}


# Einleitung
#* inkl. Nennung der Autoren
#* Beschreibung des organisatorischen Rahmens (Praktikum? Lehrveranstaltung?), in dem dieser Artikel entsteht.
#* Fügen Sie einen Link ein, der zu dem organisatorischen Rahmen des Projekts zurückführt (z. B. zu einer Übersichtsseite einer Lehrveranstaltung)
# Inhalt, gegliedert je nach Sinn & Zweck
# Fazit/Zusammenfassung/Ausblick
#* Was ist das Ergbnis?
#* Was kann/muss noch verbessert werden?
#* Fügen Sie einen Link ein, der zu dem organisatorischen Rahmen des Projekts zurückführt (z. B. zu einer Übersichtsseite einer Lehrveranstaltung)
# Quellen: Sobald Sie eine Quelle (insbesondere bei Bildern) verwenden, nennen Sie dort die Quelle mittels <ref> [http://www.mediawiki.org/wiki/Manual:$wgExternalLinkTarget] </ref>. Hier führen Sie diese dann als Aufzählung auf.
# Korrektur/Rückmeldungen


== Zusammenfassung ==
Was ist das Ergbnis?
Das Ergebnis dieses Artikels ist eine Vorlage, mit der Nutzer des Wikis schnell und leicht eigene Artikel verwirklichen können. Diese Vorlage ist Bestandteil der Anleitungen aus [http://193.175.248.171/wiki/index.php/Kategorie:HowTo den How-To's].


== Regeln für das Verfassen von Artikeln ==
Bitte beachten Sie beim Verfassen von Artikeln in diesem Wiki unbedingt die folgenden Hinweise! Tipp: Nach Verfassen des Artikels kontrollieren Sie noch einmal diesen und nutzen die folgende Liste als "Checkliste".


* temporäre Dateien wie z. B. Projektpläne etc. gehören nicht ins Wiki!
== Ausblick ==
* Bilder: Bei '''jedem''' Bild sind die Originaldaten hinzuzufügen, mit denen das Bild erstellt wurde, damit künftige Erweiterungen/Nachbesserungen etc. ermöglicht werden (Bsp: Zeichnung: Bild der Zeichnung als *.jpg und die Ursprungsdatei als *.ppt o. ä. ablegen!)
Was kann/muss noch verbessert werden?
* Quellen angeben (insbesondere bei Bildern etc.)
* Nutzen Sie Aufzählungen/Tabellen/Formeln, um Ihren Text leicht lesbar zu machen.
* Vermeiden Sie viel Fließtext.




== Literaturverzeichnis ==
<references />
<references />

Aktuelle Version vom 4. Oktober 2024, 15:53 Uhr


Autoren:


Einleitung

Inhalt

Die Gliederung des Inhalts hängt stark von Ihrem individuellen Projekt ab. Benutzen Sie einen leicht nachvollziehbaren roten Faden und gliedern Sie nach gesundem Menschenverstand!


Unterabschnitt

  1. Nutzen Sie Aufzählungen
    • mit verschiedenen Schachtelungen
    • und so weiter
  2. zweite Ebene
    • mit erneuter Unterebene

Bilder

Bauen Sie Bilder ein, am Besten mit darin gekennzeichneten Stellen, die Sie dann im Text erklären. Referenzieren Sie Bilder und Tabellen konsequent im Text. Zitieren Sie ggf. die Bildurheber.

Abb 1: Beispielbild mit Quelle [1]

Bilder in den Text einbetten

Wenn Sie Bilder anzeigen möchten, ohne dass der Artikel links oder rechts weiter läuft, können Sie den Textfluss mit dem Befehl <br clear=all> stoppen (vgl. Abb. 2).

Abb 2: Beispiel <br clear=all>


Alternativ können Sie das Bild in einer "wikitable" anzeigen lassen. Dadurch wird das Bild auch auf Bildschirmen mit einer anderen Auflösung in der richtigen Darstellungsart angezeigt (vgl. Abb. 3).

Abb 3: Beispiel wikitable

Hier geht es weiter mit dem Text.

Tabellen

Tabelle 1 zeigt ein schönes Beispiel. Tipp: Tabellen lassen sich auch aus dem Excel-Format in das MediaWiki-Format konvertieren. Dazu gibt es diese Internetseite: [1].

Spalte 1 Spalte 2 Spalte 3
Tabelle 1: Beispieltabelle
blabla sowieso sowieso
test sowieso test1
Tabelle mit Sortierfunktion
Überschrift Überschrift Überschrift
Beispiel Beispiel Beispiel
Beispiel Beispiel Beispiel
Beispiel Beispiel Beispiel

Formeln

Für Formeln nutzen Sie die <math>-Umgebung.

Dieser Quelltext

<math> y = \int\limits_0^2 {\sin \frac{x}{2}dx}</math>

wird dann so dargestellt .

Eine Übersicht über die Befehle findet sich z. B. hier: Gleichungen in math.


Sonderzeichen

Sonderzeichen setzen Sie einfach über [Alt]+ANSI Code z.B. [Alt]+0177: ±

Übersicht der ANSI-Code Sonderzeichen

Alternativ kann der Unicode eingegeben werden z.B. ❶ für ❶.

Formatierung

Nutzen Sie zur Formatierung Beispiele, z. B. aus dem weltbekannten Wikipedia selbst (das ist die gleiche Syntax!) oder anderer Hilfeseiten wie z. B. [2].

Quelltext

Anleitung und Beispiele zum Einbinden von Quelltext finden Sie hier: Quelltext_einbinden.

Zitieren

Fremdquellen sollten Sie auf jeden Fall zitieren. Internetquellen können Sie einfach verlinken. Literatur zitieren Sie bitte nach DIN ISO 690:2013-10.

Absätze ausblenden

Zusätzliche Informationen können Sie mit dieser Formatierung bei Bedarf ein- und ausklappen.



Zusammenfassung

Was ist das Ergbnis? Das Ergebnis dieses Artikels ist eine Vorlage, mit der Nutzer des Wikis schnell und leicht eigene Artikel verwirklichen können. Diese Vorlage ist Bestandteil der Anleitungen aus den How-To's.


Ausblick

Was kann/muss noch verbessert werden?


Literaturverzeichnis

  1. © Mirek Göbel - Eigenes Werk
  2. Hilfeseite des Wikimedia-Projekts