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.