markdownview — u_pbt_markdownview #

← Komponentenreferenz · Inhalt des Handbuchs

markdownview zeigt ein Markdown-Dokument schreibgeschützt in den Farben des Themas: Überschriften, Listen, Tabellen, Aufgabenlisten, farbiger Code, Bilder. Sie setzen den Text in is_markdown oder den Pfad einer Datei in is_source; ein Link navigiert nie, er löst ue_link_clicked aus und die Anwendung entscheidet. Rohes HTML eines Dokuments wird nie ausgeführt.

▶ Live sehen — Demoanwendung, Kachel Markdown viewer, mit dem Code und dieser Seite nebeneinander.

Auf einen Blick #

Schnellstart #

// Show a Markdown file : its pictures and relative links are read against its folder
uo_md.is_source = "C:\Acme\Help\guide.md"

// ... or any text the application has
uo_md.is_markdown = "# Release notes~n~n- [x] Orders~n- [ ] Invoices"

// ue_link_clicked : the viewer never navigates, the application decides where to open as_url

Eigenschaften #

Methoden #

Ereignisse #

Beispiel #

Eine Online-Hilfe, die ihre Links öffnet #

// ue_link_clicked of uo_md : the viewer never navigates, the application decides
if Lower(Right(as_url, 3)) = ".md" and FileExists(as_url) then
	uo_md.is_source = as_url                        // another page of the help
else
	ShellExecuteW(0, "open", as_url, "", "", 1)     // a web page, a mail
end if

Markdown bearbeiten: ein codeeditor und ein markdownview #

// The editor colours Markdown ; the viewer shows the page
uo_editor.is_syntax = u_pbt_codeeditor.SYNTAX_MARKDOWN
uo_editor.is_text = ls_notes
uo_md.is_markdown = ls_notes

// ue_changed of uo_editor : the whole recipe
uo_md.is_markdown = uo_editor.is_text

Ein Inhaltsverzeichnis in einer Liste #

// Local variables
string ls_titles[], ls_anchors[]
long ll_levels[], ll_i

// One line per heading, indented by its level
for ll_i = 1 to uo_md.of_toc(/*titles*/ ls_titles, /*levels*/ ll_levels, /*anchors*/ ls_anchors)
	lb_toc.AddItem(Fill(" ", (ll_levels[ll_i] - 1) * 3) + ls_titles[ll_i])
next

// SelectionChanged of lb_toc : bring that heading to the top
uo_md.of_scroll_to(/*anchor*/ ls_anchors[index])

Bewährte Praxis #

• Ein Leser, kein Editor: Um Markdown zu schreiben, daneben ein codeeditor in SYNTAX_MARKDOWN, verbunden durch eine Zeile in seinem ue_changed (siehe Beispiel).
• Die Links gehören Ihnen: Nichts öffnet sich von selbst; ue_link_clicked liefert die Adresse, bereits gegen den Ordner der Datei aufgelöst, und Sie wählen — den Browser, ein anderes Dokument in derselben Komponente, eine Maske der Anwendung.
• Ein Dokument führt nichts aus: rohes HTML wird so angezeigt, wie es geschrieben ist, ein javascript:-Link bleibt Text, ein http://-Bild wird abgelehnt — ein Dokument von anderswo wird gefahrlos gezeigt.
• Bilder: ein relativer Pfad wird gegen den Ordner der Datei gelesen; für ein Bild aus dem Web lieber https://, oder es zuerst herunterladen (restclient.of_download) und seinen Pfad angeben.
• Ein großes Dokument bleibt flüssig: die ersten Blöcke erscheinen sofort, der Rest in den folgenden Augenblicken; die Suche, of_scroll_to und der Druck warten, bis es vollständig ist.
• Von rechts nach links: das Dokument folgt der Richtung der Anwendung (Listen, Zitate und Tabellen drehen sich um), ein Codeblock bleibt von links nach rechts.

Vom gemeinsamen Sockel geerbt #

Diese Mitglieder gibt es bei jeder visuellen Komponente — sie sind nicht dieser eigen. Sie werden einmal in den übergreifenden Kapiteln beschrieben; diese Tabelle sagt nur, wo man sie liest.

← Komponentenreferenz · Inhalt des Handbuchs