Erstellen neuer Seiten

Aus Baustatik-Wiki
Version vom 26. März 2024, 18:02 Uhr von Gbolle (Diskussion | Beiträge) (→‎Beispiel-Seiten)
(Unterschied) ← Nächstältere Version | Aktuelle Version (Unterschied) | Nächstjüngere Version → (Unterschied)
Zur Navigation springen Zur Suche springen
Schreiben.jpg

Hier kannst Du nachlesen, wie neue Seiten im Baustatik-Mediawiki nach einem einheitlichen Format erstellt werden. Außerdem werden einige Regeln erläutert, die bei der Erstellung von Seiten zu beachten sind.

Um einen neuen Beitrag am einfachsten zu erstellen, musst du den Titel des Beitrages zunächst über das Suchfeld von Baustatik-Wiki suchen. Wenn der Beitrag noch nicht im Wiki vorhanden ist, wird dir der Titel in Rot angezeigt. Durch anklicken wird dann eine neue Seite mit dem Titel erstellt, die du speichern kannst. Danach kannst du dir aus der "Vorlage für neue Beiträge" im Bearbeitungsmodus den Quellcode kopieren und durch deine Texte und Bilder austauschen.

Erstellen einer Seite in - Grundlagen/Begriffe -

Bezeichnung von Seiten

Da Seiten im Bereich - Grundlagen/Begriffe - unterschiedliche Informationen enthalten können, gibt es hier auch unterschiedliche Möglichkeiten der Seitenbezeichnung:

  • Begriffe
Enthält die Seite die Definition und Erläuterung eines Fachbegriffs, dann ergibt sich die Seitenbezeichnung einfach aus dem zu bezeichnenden Begriff.
Beispiel 1: Betonstahlmatten
Beispiel 2: Feuerwiderstandsdauer
  • abgrenzbare Themen (Einzelthemen)
Enthält die Seite Informationen zu einem gut abgrenzbaren Thema, welches nur auf der bezeichneten Seite behandelt wird, dann ergibt sich die Seitenbezeichnung einfach aus dem behandelten Thema.
Beispiel 1: Betondeckung
Beispiel 2: Mitwirkende Plattenbreite
  • komplexe Themen (Behandlung eines Teilthemas auf der betreffenden Seite)
Enthält die Seite Informationen zu einem Teilthema, welches sich in einen größeren Themenkomplex einordnen lässt oder für eine bessere Verständlichkeit einem Oberbegriff zugeordnet werden muss, dann ergibt sich die Seitenbezeichnung aus dem Oberbegriff/Themenkomplex + dem behandelten Teilthema. Trennzeichen ist hier ein Bindestrich.
Beispiel 1: Durchstanzen - Bemessungswert der einwirkenden Querkraft
Beispiel 2: Deckengleicher Unterzug - Lasteinzugsfläche

Grundsätzlich sind für die Bezeichnung von Seiten nur Sachbegriffe zu wählen, da die Seiten in der Kategorie-Übersicht alphabetisch geordnet werden.

Beispiel: Mitwirkende Plattenbreite (RICHTIG) - Ermittlung der mitwirkenden Plattenbreite (FALSCH)

Struktur von Seiten

Eine Seite in den Kategorien - Grundlagen/Begriffe - hat grundsätzlich folgende Struktur:

  • Seiten-Vorschau
Wenn man mit der Maus über den Link zu einer Seite fährt, kann eine kurze Seitenvorschau (bestenfalls Kurztext mit einer Abbildung) angezeigt werden. Das klappt aber nur, wenn Kurztext und Abbildung vor der Gliederung angeordnet werden. Der Link auf die Abbildung steht ganz oben (als Vorlage siehe z. B. Expositionsklassen).
Kurztext und Abbildung sollten so aufgebaut sein, dass Sie eine gute Übersicht über den zu erwartenden Seiteninhalt geben.
  • Seiteninhalt
Der Inhalt der Seite kann nach eigenem Ermessen strukturiert werden. Ziel ist es hier das behandelte Thema möglichst anschaulich zu behandeln, unter Beachtung schon vorhandener Seiten abzugrenzen und ggf. entsprechende Links zu anderen Seiten (Erläuterung von Begriffen, verwandte Themen/Seiten) einzufügen.
Zur einheitlichen Gestaltung von Seiteninhalten (Text, Formeln, Grafiken) gibt es später noch genauere Hinweise.
  • Quellenangaben
Zusammenfassung der verwendeten Quellen (siehe auch - Quellenverweise)
  • Seiteninfo
Das Feld [Seiteninfo] gibt eine Übersicht über den Bearbeitungsstand der Seite und eine Bewertung der Informationsqualität (siehe auch Qualitätssicherung). Für die Seiteninfo ist die Vorlage Seiteninfo zu benutzen.
  • Kategorie
Je nach betrachteter Bauweise ist die Seite in eine passende Kategorie einzuordnen.
Beispiel 1: [[Kategorie:Grundlagen/Begriffe-Stahlbetonbau]]
Beispiel 2: [[Kategorie:Grundlagen/Begriffe-Stahlbau]]

Einheitliche Gestaltung von Seiten

Text

Für die textliche Gestaltung von Seiten gibt es keine besonderen Hinweise. Es gelten die generellen Regeln für die übersichtliche und anschauliche Erstellung von Texten, d. h.

  • kurze präzise Formulierungen
  • sinnvolle Anordnung von Absätzen
  • Nutzung von strukturierten Inhalten (Aufzählungen, Tabellen) an den passenden Stellen

Grafische Darstellungen

Veranschaulichung der Betondeckungsmaße (Beispiel-Abbildung)

Grafische Darstellungen sind rechtsbündig in Rahmen anzuordnen und mit einer Bildunterschrift zu versehen. Der Zusammenhang zwischen Text und Abbildung ist durch die räumliche Nähe und ggf. durch geeignete Formulierungen im Text herzustellen (keine Bild-Nummerierungen o. ä.). Die Bildgröße kann variieren. Falls möglich, ist es sinnvoll die Schriftgröße in Abbildungen und die Größe der Abbildung so zu wählen, dass diese nicht unbedingt aufgemacht werden muss, um deren Inhalt zu erfassen. Grafiken (Dateien) sind vor dem Hochladen nach folgenden Regeln zu bezeichnen.

  • vollständiger Titel der Seite auf der die Datei (erstmalig) verwendet wird + laufende Nummerierung
  • Beispiel: Betondeckung2.png (siehe Beispiel-Abbildung)
Achtung :
  • Die Dateinamen von Grafikdateien dürfen keine Umlaute enthalten. Sonst gibt es Zuordnungsprobleme.

Formeln und Bezeichnungen

Für Formeln gelten ähnliche Regeln wie für grafische Darstellungen. Der Bezug zum Text wird durch die räumliche Nähe hergestellt (keine Nummerierung der Formel). Jede Formel sollte hinsichtlich Ihrer Bestandteile vollständig erklärt werden. Auch wenn eine ähnliche Formulierung auf der gleichen oder einer anderen Seite zu finden ist, muss davon ausgegangen werden, dass der Leser auf unterschiedlichem Wege zum betreffenden Abschnitt gelangt ist und daher eine vollständige Beschreibung des Formelinhalts zu schätzen weiß.

Beispiel:



wobei:

cmin... Mindestbetondeckung
∆cdev... Vorhaltemaß


Bezüglich der Verwendung von Formeln und Berechnungen in Beispielen gelten andere Regeln.

Die Erstellung von Formeln erfolgt mithilfe der LaTeX-Codierung (siehe - Formeln).

Beispiel-Seiten

Nachfolgend sind einige Seiten angegeben, die hinsichtlich Ihrer Struktur und der Formatierung den zuvor beschriebenen Regeln entsprechen:

Erstellen einer Seite in - Software-Anwendungen -

Bezeichnung und Strukturierung von Seiten

Hauptseiten

Die Bezeichnung und Strukturierung von Seiten in dem Bereich - Software-Anwendungen - folgt prinzipiell der Bezeichnung und Strukturierung der betreffenden Software-Anwendungen selbst (z. B. Baustatik-Module der mb Worksuite). Die Hauptseite des betreffenden Moduls erhält damit als Seitentitel die Bezeichnung des zugehörigen Moduls (Modul-Nr. + Bezeichnung)

Beispiel für ein Baustatik-Modul der mb Worksuite: S200.de Einachsig gespannte Mehrfeldplatte

Die Hauptseiten haben in der oberen Gliederungsebene immer die gleiche Struktur:

  • Eingabe → verweist auf Seiten mit Hinweisen zur Eingabe von Informationen für die Berechnung
  • Grundlagen → verweist auf maßgebende Berechnungsgrundlagen (Seiten in - Grundlagen/Begriffe -)
  • Beispiele → verweist auf Seiten mit zugehörigen Beispielberechnungen (Seiten in - Beispiele -)
  • Kategorie
Je nach betrachteter Bauweise ist die Seite in eine passende Kategorie einzuordnen. Für die Strukturierung der Liste auf der Kategorie-Seite kann der Kategorie-Angabe noch die Nr. des mb AEC Moduls hinzugefügt werden.
Beispiel 1: [[Kategorie:MB-AEC Baustatik-Module Stahlbetonbau|200]]
Beispiel 2: [[Kategorie:MB-AEC Baustatik-Module Stahlbau|404]]

Alle folgenden Erläuterungen beziehen sich nur noch auf Seiten in der Ebene [Eingabe].

Für die Bezeichnung von Seiten in - Grundlagen/Begriffe - → siehe Bezeichnung von Seiten in - Grundlagen/Begriffe -
Für die Bezeichnung von Seiten in - Beispiele - → siehe ...


Seiten zu Eingabekategorien

Der Eingabebereich eines jeden mb AEC Moduls gliedert sich in Eingaberegister (Reiter) und Eingabekategorien (Unterpunkte im jeweiligen Eingaberegister). Für Hinweise zur Eingabe wird für jede Eingabekategorie eine neue Seite angelegt. Sie erhält folgende Bezeichnung: Benennung der Eingabekategorie + Modul-Nr. (...des mb AEC Moduls). Einige Standard-Eingabekategorien werden mit gleichem oder ähnlichem Aufbau in mehreren mb AEC Modulen benutzt. Die Modul-Nr. wird dann durch 3 Sterne ersetzt.

Beispiel 1 (für eine modulindividuelle Eingabekategorie): Zusatzangaben Plattenbalken (S340.de)
Beispiel 2 (für eine modulübergreifende Eingabekategorie): Werkstoff (S***.de)

Die Seiten im Bereich - mb AEC Module - haben in der Regel folgenden einheitliche Aufbau:

  • Eingabe
  • Hinweise
  • Quellenangaben
  • Seiteninfo
Das Feld [Seiteninfo] gibt eine Übersicht über den Bearbeitungsstand der Seite und eine Bewertung der Informationsqualität (siehe auch Qualitätssicherung). Im Unterschied zu den Seiten in - Grundlagen/Begriffe - ist hier für die Seiteninfo die Vorlage Seiteninfo(mb) zu benutzen. Diese enthält zusätzlich noch die Modul-Versions-Nr., auf die sich die Informationen beziehen.

einheitlicher Aufbau von Seiten

Eingabe

Den Informationen zur Eingabe sollte eine grafische Darstellung des Eingabebereiches vorangestellt werden. Im Unterschied zu den grafischen Darstellungen in den Seiten des Bereiches - Grundlagen/Begriffe - werden die Darstellungen in den hier betreffenden Seiten einfach linksbündig ohne Rahmen und Bezeichnung angeordnet.

Beispiel:

Baustatik-Wiki



Manche Eingabebereiche sind dynamisch aufgebaut, d. h. sie verändern ihre Gestalt und ihre Eingabeoptionen z. B. je nachdem welches Verfahren ausgewählt wurde oder welche Option angewählt wurde. Die Darstellung des Eingabebereiches sollte hier möglichst vollständig erfolgen, so dass alle Eingabemöglichkeiten erklärt werden können. Das kann u. U. mehrfache Darstellungen eines Eingabebereiches erfordern. Ggf. sind auch erklärende Bildunterschriften sinnvoll.
Alternativ können unterschiedliche Eingabemöglichkeiten sehr gut durch eine Gliederung der betreffenden Seite erläutert werden. Es ist grundsätzlich sinnvoll die Eingabe möglichst vollständig zu erklären. Dabei sind kurze, kompakte, übersichtlich strukturierte Informationen zu bevorzugen. Diese können und sollten ggf. durch Hinweise zu Normen/Richtlinien usw. oder auch Hinweise zu Anwendungsgrenzen ergänzt werden.

Hinweise

Für die Nutzung der hier beschriebenen Seiten macht es keinen Sinn, nur Informationen zu bringen, die im Wesentlichen schon in der Anwendungshilfe der Baustatik-Module enthalten sind. Vielmehr von Bedeutung sind Hinweise, die über die in der Hilfe angegebenen Standardinformationen hinausgehen. Dies betrifft beispielsweise:

  • Hinweise zur Verwendung (oder Nichtverwendung) der Eingabeparameter in der Berechnung
  • Hinweise zur Erlangung einer benötigten Information, sofern diese nicht offensichtlich verfügbar ist und z. B. erst durch eine anderweitige Berechnung ermittelt werden muss
  • Hinweise zur Ableitung einer Information aus dem statischen System oder anderweitigen Randbedingungen
  • Hinweise zu Grenzwerten bestimmter Eingabeparameter (mit Begründung)
  • Hinweise zu Kontrollmöglichkeiten bestimmter Eingabewerte
  • ...

Beispiel-Seiten

Nachfolgend sind einige Seiten angegeben, die hinsichtlich Ihrer Struktur und der Formatierung den zuvor beschriebenen Regeln entsprechen:

Erstellen einer Seite in - Beispiele -

Bezeichnung von Seiten

Die Bezeichnung von Seiten im Bereich - Beispiele - erfolgt nach folgendem Schema:

  • Einzelthema + (Bsp.) - für ein Einzelthema
Beispiel 1: Betondeckung (Bsp.)
  • Oberbegriff/Themenkomplex - Teilthema + (Bsp.)
Beispiel 2: Zwang - Mindestbewehrung zur Rissbreitenbegrenzung für eine Sohlplatte (Bsp.)

Struktur von Seiten

Die Seiten sollten mindestens folgende Abschnitte bzw. Elemente aufweisen:

  • Aufgabenstellung
Die Aufgabenstellung muss alle Informationen beinhalten, die für die Erfassung der Ausgangssituation und die weitere Berechnung benötigt werden (z. B. Bauteilgeometrie, Baustoffkennwerte, Einwirkungen/Schnittgrößen, statische Randbedingungen usw.). Darüber hinaus ist das konkrete Ziel der Beispielberechnung zu beschreiben. Die Aufgabenstellung sollte immer auch eine oder mehrere grafische Darstellungen des betrachteten Bauteils, des Bauteilausschnitts oder des Tragsystems enthalten.
  • Lösung

Die Lösung beinhaltet je nach Ermessen des Autors alle Berechnungsschritte, Annahmen und Informationen, die für ein vollständiges Nachvollziehen des Berechnungsablaufes erforderlich sind.

  • Quellenangaben (falls auf Quellen verwiesen wird)
Zusammenfassung der verwendeten Quellen (siehe auch - Quellenverweise)
  • Seiteninfo
Das Feld [Seiteninfo] gibt eine Übersicht über den Bearbeitungsstand der Seite und eine Bewertung der Informationsqualität (siehe auch Qualitätssicherung). Für die Seiteninfo ist die Vorlage Seiteninfo zu benutzen.

Hinweise für eine gute Gestaltung von Seiten

  • Bemühen Sie sich um eine übersichtliche Struktur der Seite (Leerzeilen, Einrückungen, Markierungen)! Um so besser und schneller lassen sich Detailinformationen aus der Berechnung entnehmen.
  • Versehen Sie die einzelnen Berechnungsschritte mit entsprechenden erläuternden Bemerkungen (z.B. Erklärungen, Annahmen oder Herkunft von Eingangsgrößen usw.)!
  • Vermeiden Sie sich häufig wiederholende gleichartige Berechnungen ohne jeden informativen Mehrwert! Dadurch wird das Berechnungsbeispiel unübersichtlich. Hier reicht (für den Fall, dass man auf derartige Ergebnisse Bezug nehmen muss oder möchte) eine einfache Angabe des Berechnungsergebnisses (ggf. mit Verweis auf das angewendete Verfahren). Bei einer größeren Anzahl gleichartiger Berechnungsergebnisse bietet eine tabellarische Darstellung eine gute Übersicht.
  • Verwenden Sie ggf. grafische Darstellungen, um die Definition bestimmter Größen deutlich zu machen (z. B. Abmessungen)! Auch grafische Darstellungen von Ablesungen in Tabellen oder Diagrammen (günstigerweise mit Hervorhebung der Ablesung) verbessern die Nachvollziehbarkeit Ihrer Berechnung erheblich.

Beispiel-Seiten

Nachfolgend sind einige Seiten angegeben, die hinsichtlich Ihrer Struktur und der Formatierung den zuvor beschriebenen Regeln und Hinweisen entsprechen:


Seiteninfo
Quality-flag-green.gif
Status: Seite fertig, inhaltlich OK