Rilascio di MarkDownHelpViewer, e aggiornamento di MarkDown Text Editor

Siamo lieti di annunciare il rilascio della prima versione di MarkDownHelpViewer, un progetto Open-Source per fornire un sistema di help integrato in Delphi che utilizza i file markdown per la creazione del “manuale” online.
Il progetto prevede un Viewer già pronto con il suo setup da installare sulla macchina dell’utente (in pratica l’equivalente di hh.exe per gli help in formato .chm (vedi immagine) e un file di “interfaccia” da aggiungere alla propria applicazione che aggancia il viewer agli “HelpContext” o “HelpKeyword” impostati sui componenti di Delphi.
Oltre a questo anche un componente che può essere usato internamente all’applicazione Delphi per mostrare i file di help.

Qui il link al progetto:
Questa è una “Preview” del viewer che mostra l’help della “wiki” del progetto InstantObjects:

Nel progetto c’è anche una piccola demo che spiega come integrare l’help con la propria applicazione Delphi, compresa la possibilità di utilizzare un componente MarkDownViewer direttamente dentro l’applicazione:

Oltre al viewer, consigliamo di utilizzare l’editor di file MarkDown, fornito con l’altro nostro progetto disponibile qui:

https://github.com/EtheaDev/MarkdownShellExtensions

con il quale è possibile editare i file MarkDown e vedere subito l’anteprima del risultato finale:

Unendo i due progetti potrete offrire ai vostri applicativi Delphi un sistema di Help per l’utente finale, completamente integrato e di facile manutenzione: quando dovete aggiornare le immagini della vostra applicazione perché è cambiata la GUI sarà sufficiente aggiornare l’immagine presente su disco e aggiornare il file markdown associato, senza la necessità di ulteriori aggiornamenti, in modo da avere l’help sempre aggiornato all’ultimo rilascio. Inoltre il formato MarkDown permette di essere facilmente pubblicato (ad.esempio come “wiki” su Git-Hub) ed è facilmente manutenibile perché si può sottoporre a version-control.

Spread the word. Share this post!