6
Quali strumenti OSS (o gratuiti) sono disponibili per la creazione di una singola fonte per la documentazione che può essere utilizzata per generare manuali? In particolare, nei seguenti formati:Strumento di documentazione a sorgente singola
- sito HTML
- documento PDF
- incorporato (all'interno di un'applicazione, probabilmente HTML)
- Testo (opzionale)
- pagine man (opzionale)
Requisiti aggiuntivi:
- L'utensile è adatto per gli scrittori tecnici (non è necessario essere WYSIWYG).
- XML/sorgente SGML output PDF
- alta qualità (paragonabile al TeX)
- Multi-piattaforma
Expanded Requisito
La stessa riga di comando applicazione è scritta in due lingue (C e Java). Usando XML per descrivere le opzioni della riga di comando (alcune delle quali sono specifiche per una lingua o l'altra), è semplice trasformare l'XML in una classe Java, o una funzione C, che aiuta l'output standard. Ciò garantisce che l'aiuto possa essere incorporato nel file binario senza dover dipendere da file esterni.
Sembra che AsciiDoc non abbia questa capacità. C'è un'altra opzione?
AsciiDoc sembra eccellente. Come lo integreresti con un'applicazione a riga di comando? –
Un approccio potrebbe essere l'utilizzo di un file di origine XML che descrive le opzioni della riga di comando per l'app, quindi eseguirlo tramite una trasformazione che genera il sorgente AsciiDoc per una particolare configurazione dell'applicazione (C o Java, selezionando solo le parti appropriate) . Non sembra che AsciiDoc sia lo strumento giusto per generare il codice sorgente C/Java attuale; Vorrei usare uno strumento diverso per quello. Ma certamente avere una fonte XML comune per tutti i rendering della tua linea di comando aiuta a sembrare una buona cosa. –