Alla manifestazione IT-DevCon 2023 Carlo Barazzetta ha tenuto uno speech sulla creazione di un sistema di Help contestuale in Delphi basato su “MarkDown”, utilizzando i 2 progetti Open-Source:
– MarkDownHelpViewer
All’interno di quest’ultimo è contenuto un comodo Editor “MarkDown” con preview immediata della trasformazione (markdown -> html) compresa la possibilità di vedere le immagini presenti su WEB. Di questo componente è appena stata rilasciata una nuova versione, con nuove funzionalità per facilitare l’editing.
Nella applicazioni Delphi-VCL esiste un sistema di Help integrato per la visualizzazione di file help “chm”: è un sistema molto flessibile, che permette di essere sostituito facilmente. Vedremo come funziona l’integrazione con i classici file chm ma anche come è possibile utilizzare un sistema alternativo open-source basato sulla sintassi “markdown” (MarkDownHelpViewer), dando anche una occhiata veloce alla sintassi del popolare linguaggio di markup, per integrare l’help nelle proprie applicazioni e semplificare l’editing tramite un’altro tool open-source (MarkDown shell extensions), oltre alla possibilità di creare un sistema di help integrato internamente all’applicazione.
MarkDownShellExtensions fornisce una estensione alla Shell di Windows per mostrare in Explorer i file in formato Markdown.
Inoltre viene fornito un utilissimo Editor di file markdown (ora ottimizzato per il “dialetto” CommonMark), in grado di fornire un feed-back immediato a ciò che si sta scrivendo, oltre a facilitare l’input del testo markdown, compreso l’inserimento delle immagini. Il progetto è già compatibile con Delphi 12.
Attraverso un comodo Setup è possibile installare facilmente l’estensione e l’editor senza dover ricompilare il progetto.
Carlo Barazzetta mostrerà anche come utilizzare il formato Markdown per gestire un sistema di Help integrato in Delphi, utilizzando un altro progetto OpenSource: MarkDownHelpViewer che fornisce un comodo Visualizzatore per file Markdown, compreso il file “indice”, partendo da una cartella di lavoro che contiene l’help in formato markdown.
Inoltre viene fornito un utilissimo Componente per mostrare il contenuto dei file markdown direttamente nelle applicazioni Delphi. Il progetto è già compatibile con Delphi 12.
Attraverso un comodo Setup è possibile installare facilmente l’estensione e l’editor senza dover ricompilare il progetto.
