TS: Dokumentation

Hello,

Doku

wie stellt man in Dokumentationen verständlich einen kompletten Roundturn nebst aller beteiligten Komponenten dar?

Web

Im Zeitalter von HTML(5), das uns vermutlich noch eine Weile erhalten bleibt, gehe ich davon aus, dass man im Browser eher vertikal scrollen möchte.

Print

Und will man das Ganze dann drucken (ggf. auch als PDF), sollten im Webdokument an definierbaren Stellen Pagebreaks einfügbar sein. Funktioniert das im CSS inzwischen?

Glück Auf
Tom vom Berg

--
Es gibt nichts Gutes, außer man tut es!
Das Leben selbst ist der Sinn.
  1. Servus!

    Hello,

    Doku

    wie stellt man in Dokumentationen verständlich einen kompletten Roundturn nebst aller beteiligten Komponenten dar?

    Ich verstehe Deine Frage nicht? Meinst Du evtl. Roundtrip?

    Web

    Im Zeitalter von HTML(5), das uns vermutlich noch eine Weile erhalten bleibt,

    ???

    gehe ich davon aus, dass man im Browser eher vertikal scrollen möchte.

    Ja, siehe hier: HTML/Tutorials/Single-Page_Webseite

    Das hat aber mehr mit den mobilen Geräten als mit HTML5 zu tun.

    Und jedes HTML-Dokument nimmt ohne CSS die volle Breite des Viewports ein - weitere Inhalten kommen drunter und man kann entweder scrollen oder mit Maus / Swipe runtergehen.

    Print

    Und will man das Ganze dann drucken (ggf. auch als PDF), sollten im Webdokument an definierbaren Stellen Pagebreaks einfügbar sein. Funktioniert das im CSS inzwischen?

    Ja, siehe hier: CSS/Tutorials/Print-CSS/Seitenformate

    Wenn du ein PDF hast, hat dies bereits von Dir festgelegte Seitenformate.

    Glück Auf
    Tom vom Berg

    Herzliche Grüße

    Matthias Scharwies

    --
    Einfach mal was von der ToDo-Liste auf die Was-Solls-Liste setzen.“
    1. Hello,

      Doku

      wie stellt man in Dokumentationen verständlich einen kompletten Roundturn nebst aller beteiligten Komponenten dar?

      Ich verstehe Deine Frage nicht? Meinst Du evtl. Roundtrip?

      Yes Sir!
      Das ist wohl eher der Fachbegriff für "einmal rundherum im Client-Server-Model (per HTTP/s).

      Web

      Im Zeitalter von HTML(5), das uns vermutlich noch eine Weile erhalten bleibt,

      Ich glaube daran, dass es in den nächsten (10?) Jahren keine Ersatztechnologie geben wird.

      gehe ich davon aus, dass man im Browser eher vertikal scrollen möchte.

      Ja, siehe hier: HTML/Tutorials/Single-Page_Webseite

      Das hat aber mehr mit den mobilen Geräten als mit HTML5 zu tun.

      Aber mit Gewohnheit und den klassischen Methoden, wie DRUCK und BUCHFORMEN im westeuropäischen Bereich.

      Und jedes HTML-Dokument nimmt ohne CSS die volle Breite des Viewports ein - weitere Inhalten kommen drunter und man kann entweder scrollen oder mit Maus / Swipe runtergehen.

      Print

      Und will man das Ganze dann drucken (ggf. auch als PDF), sollten im Webdokument an definierbaren Stellen Pagebreaks einfügbar sein. Funktioniert das im CSS inzwischen?

      Ja, siehe hier: CSS/Tutorials/Print-CSS/Seitenformate

      Wenn du ein PDF hast, hat dies bereits von Dir festgelegte Seitenformate.

      so der CSS-Gott will ;-)

      Glück Auf
      Tom vom Berg

      --
      Es gibt nichts Gutes, außer man tut es!
      Das Leben selbst ist der Sinn.
      1. Aloha ;)

        Wenn du ein PDF hast, hat dies bereits von Dir festgelegte Seitenformate.

        so der CSS-Gott will ;-)

        Was hat PDF mit CSS zu tun?

        Grüße,

        RIDER

        --
        Camping_RIDER a.k.a. Riders Flame a.k.a. Janosch Albers-Zoller
        # Twitter # Steam # YouTube # Self-Wiki # Selfcode: sh:) fo:) ch:| rl:) br:^ n4:? ie:% mo:| va:) js:) de:> zu:} fl:( ss:) ls:[
        1. Hallo Janosch,

          Was hat PDF mit CSS zu tun?

          ein HTML Dokument, das man in PDF konvertieren will, muss für paged media aufbereitet werden, was auf CSS-isch @media print heißt. Und dann bist Du bei diesem, jenem und auch solchem.

          Rolf

          --
          sumpsi - posui - obstruxi
          1. Aloha ;)

            Was hat PDF mit CSS zu tun?

            ein HTML Dokument, das man in PDF konvertieren will, muss für paged media aufbereitet werden, was auf CSS-isch @media print heißt.

            Richtig - das hat aber nicht (direkt) mit PDF zu tun, sondern eben mit der Druckausgabe. Dass der Browser die Druckausgabe auch als PDF statt nur auf totem Baum ablegen kann, ist nachrangig.

            Mir ging es darum darauf hinzuweisen, dass in dieser Frage das Stichwort PDF eine falsche Fährte ist (und, wenn ich das richtig verstehe, schon hier im Thread missverstanden wurde).

            Grüße,

            RIDER

            --
            Camping_RIDER a.k.a. Riders Flame a.k.a. Janosch Albers-Zoller
            # Twitter # Steam # YouTube # Self-Wiki # Selfcode: sh:) fo:) ch:| rl:) br:^ n4:? ie:% mo:| va:) js:) de:> zu:} fl:( ss:) ls:[
  2. Hallo Tom,

    wie man etwas verständlich darstellt, ist die hohe Kunst der Doku.

    Für die Beschreibung von Kommunikationsablhäufen kenne ich Bilder, wo die beteiligten Komponenten als Boxen erscheinen und dazwischen nummerierte Pfeile sind, um die Reihenfolge anzugeben.

    Eine andere Möglichkeit sind UML Sequenzdiagramme.

    Solche Sequenzdarstellungen muss man nach Bedarf für jede einzelne Kommunikation erstellen.

    Die konkrete Beschreibung jedes einzelnen Pfeils folgt nach der Beschreibung der Sequenz.

    Was du mit Scrollrichtung ansprichst und was es mit HTML generell oder HTML5 speziell zu tun hat, weiß ich nicht.

    Beim Drucken kannst du zum einen für bestimmte Elemente festlegen, ob es vorher oder nachher einen Umbruch geben soll (aktive Umbruchsteuerung). Und du kannst festlegen, dass ein Element zusammen bleiben soll. Würde ein Umbruch in ein solches Element fallen, rutscht es komplett auf die nächste Seite. Wie gut das in den Browsern funktioniert, musst du testen.

    Du darfst aber vom Browser nicht erwarten, ein DTP Programm zu sein oder zu werden

    Rolf

    --
    sumpsi - posui - obstruxi