Was du reviewen kannst

Alles, worauf du zeigen kannst, ist ein Element – eine Sphinx-Needs-Anforderung, eine Überschrift, ein Absatz, eine Tabellenzeile, ein Bild oder ein einzelnes markiertes Wort. Es gibt keine Markierungen im Quelltext; deciwa findet die Elemente im Inhalt selbst (Keine Markierungen im Quell... (DEC_NO_MARKERS)).

Review am Ergebnis

Du reviewst, was die Lesenden sehen: die gebaute Sphinx-Seite, gerendertes Markdown, die Live-Website (Reviews finden auf den Erge... (DEC_REVIEW_ON_RESULTS)). Jedes Element des Ergebnisses gehört zu seiner Stelle im Quelltext, deshalb erscheint dasselbe Feedback überall, wo das Element gezeigt wird. Code wird im Quelltext reviewt.

Elemente pro Format

Beim Überfahren wird das Element unter dem Mauszeiger hervorgehoben; ein Klick oder eine Taste wählt es aus. Alt geht eine Ebene höher, z. B. von einem Absatz zu seinem Abschnitt. Markierst du vorher Text, gibst du Feedback nur zu diesen Wörtern (Format-Objekte werden beim ... (DEC_HOVER_SELECT)).

Format

Elemente

Verfügbar

Sphinx (rST, Markdown) mit Sphinx-Needs

Need, Abschnitt, Absatz, Listenpunkt, Tabellenzeile, Codeblock, Hinweis, Bild

jetzt

Markdown

Abschnitt, Absatz, Listenpunkt, Tabellenzeile, Codeblock, Frontmatter-Feld

0.1

Reiner Text

Absatz, Zeile

0.1

Python

Modul, Klasse, Funktion, Methode, Docstring

0.4

HTML

Block-Container, Überschriften, Absätze, Bilder

jetzt (Web-Skript)

JSON, YAML

das Dokument, jedes Objekt, Array und jeder einzelne Wert

jetzt (JSON- und YAML-Dateien werd... (DEC_DATA_ADAPTERS))

AsciiDoc, C, JS, TS

Abschnitte und Blöcke; Funktionen, Klassen, Structs

später

Bilder – Grafiken, Abbildungen und eingebettete SVG-Diagramme – werden als Ganzes reviewt.

Wenn sich ein Element ändert

deciwa erkennt ein Element wieder, nachdem die Datei bearbeitet wurde, auch wenn es verschoben wurde. Was mit deinem Feedback passiert:

Das Element …

Angezeigt als

ist unverändert

dein Urteil, wie es ist

wurde geändert, nachdem du es freigegeben hast

stale – mit alter und neuer Formulierung

wurde geändert, obwohl es eingefroren ist

frozen, but changed – ein Alarm

ist nicht mehr auffindbar

orphaned – im Panel aufgeführt

Ein neu gezeichnetes Bild zählt ebenfalls als geändert.

Eine veraltete Freigabe: der Verlauf zeigt die alte und die neue Formulierung

Freigegeben, dann geändert: der Verlauf zeigt, was sich geändert hat.