Creazione di fileguida in HTML

Question

Sono di fronte il compito divertimento di creare un file di Guida per un grande progetto. Ho scartato i file CHM a causa dei vincoli e sono ora alla ricerca in file HTML base ma sono ancora indecisi sul formato ....

Ci sono 3 zone mi sto concentrando su:

riutilizzo delle sezioni (molte pagine può fare riferimento a un testo) Dal momento che alcune sezioni saranno utilizzati più di una volta nel fileguida, ho bisogno di creare una sezione master e quindi collegare alle sezioni di master in ciascuna sottosezione. Questo in modo da evitare di dover modificare la didascalia più posti quando si fa modifiche.

Searchfunctionality Vorrei essere in grado di ricerca a testo libero nel file.

stampabilità. L'utente può scegliere di sezioni di stampa o documento wholde.

Mi è stato appoggiato l'approccio wiki dover plugin per esportare il wiki in pagine statiche per la distribuzione, ma non ho trovato questa soluzione ...

Qualche suggerimento da voi ragazzi in questa materia? Sto facendo helpfiles di complicato?

Grazie in anticipo!

Answer 1

Riusabilità

Vedo due approcci. È possibile creare pagine individuali per le sezioni che si desidera riutilizzare, e poi semplicemente collegare a loro, ove opportuno. Questo è banale in HTML.

E 'possibile in alternativa creare un frammento o un frammento di codice HTML con le informazioni per quella sezione, e quindi utilizzare Server-Side Includes (o una tecnologia simile) per includerlo in linea ovunque sia necessario. In questo modo apparirà il contenuto sia stato scritto su ogni singola pagina, ma quando è necessario effettuare una modifica che è ancora solo in un unico luogo.

Cerca

Se il sito è pubblico, e tanto indice di Google, e solo offrire una casella di ricerca di Google. Tu non sei probabilità di ottenere risultati migliori di quello.

Printability

Un "foglio di stile di stampa" in CSS è facile mettere insieme, e in grado di eliminare tutti gli elementi grafici che rendono il sito attraente sul web, conservando tutti i contenuti per l'utilizzo su carta.

Stampa dell'intero documento contemporaneamente richiederebbe qualche piccolo po 'di programmazione di combinare tutti i contenuti insieme in una singola pagina con lo scopo di stampa. Personalmente, preferirei di offrire anche questo servizio, per scoraggiare le persone di sprecare carta.

Naturalmente, siamo in grado di offrire tutti i tipi di comprensione di come raggiungere una qualsiasi di queste cose, ma dal momento che suona come siete dopo consulenza generale in questo momento, questo è il mio.

Answer 2

Credo che i wiki sono perfetti per la documentazione, soprattutto quando più di una persona è (o sarà) coinvolta nel progetto. Il collegamento tra le pagine wiki o spazi dei nomi è facile da realizzare. Rinominare una pagina cambierà tutti i collegamenti ipertestuali in altri documenti. Vorrei evitare la duplicazione di contenuti per quanto possibile, però, se questo è quello che stavi suggerendo.

DokuWiki che supporta la pagina di esportazione. È possibile scaricare l'intero wiki in testo normale, XHTML o corpo XHTML (per mettere dentro il proprio modello, o per aggiungere in un unico file per la stampa, ecc).

Speranza che aiuta!