Project Manager at KEA S.r.l. - Soluzioni per la comunicazione tecnica
Jul. 3, 2018•0 likes•5,877 views
1 of 40
Creare help online e user assistance in HTML5 da Argo CMS
Jul. 3, 2018•0 likes•5,877 views
Download to read offline
Report
Software
Da luglio 2018 è disponibile il Plugin per creare da Argo CMS help in linea (help online) e user assistance in formato HTML5, con supporto per video e codici QR.
Creare help online e user assistance in HTML5 da Argo CMS
1. Creare Help OnLine
e User Assistance
da Argo CMS
In formato HTML e HTML5
con supporto di video
e codici QR
Luglio 2018
2. Manuali online da Argo
Dalla versione 2.6.3.0 di Argo è disponibile il modulo Argo
HTML(5) Converter per realizzare help online e user
assistance in formato HTML o HTML5, con supporto di
video e QR code.
Il Converter genera documentazione completa di
sommario interattivo, intestazione, motore di ricerca e
layout personalizzabile.
1
3. Manuali online da Argo
Help online e user assistance esportati da Argo possono
essere:
Pubblicati online, usando qualsiasi server web
Applicando codici QR al packaging del prodotto o a gruppi e
componenti della macchina, il destinatario può accedere
direttamente a informazioni contestualmente rilevanti
Integrati in applicativi installati a bordo macchina
Salvati su chiavette USB e altri supporti offline.
2
4. Come realizzare manuali HTML(5)
Per convertire in HTML(5) la documentazione tecnica
gestita con Argo, seguite questa procedura:
Argo
Esportate i contenuti del manuale da pubblicare sul web
Utilizzate eventualmente i marcatori (le Proprietà di Argo) per esportare
selettivamente i contenuti, per esempio per famiglia, modello, matricola,
mercato, destinatario, tipo di pubblicazione, ecc.
Argo HTML(5) Converter
Convertite in HTML il manuale esportato da Argo
Caricate sul server web il manuale in formato HTML per pubblicarlo online.
5. Che cosa fare in Argo
La prima volta, prima di esportare da Argo i contenuti del
manuale da pubblicare sul web:
Accedete a
C:ProgrammiArgo 2.0Plugin
Verificate che la cartella contenga il file
PluginHtml.dll
Questo file è necessario per convertire in modo corretto il manuale in HTML.
1
7. Che cosa fare in Argo
La prima volta, prima di esportare da Argo i contenuti del
manuale da pubblicare sul web, impostate la
corrispondenza fra stili di Argo e tag HTML.
E’ necessario mappare:
Titoli (6 livelli possibili, da h1 ad h6)
Elenchi (puntati, numerati, lettera).
E’ possibile mappare altri stili per inserire contenuti in intestazione e nel piè di pagina
del manuale online:
Titolo e Sottotitolo del manuale
Riferimenti dell’azienda (Indirizzo 1 e 2)
Logo dell’azienda (LogoFooter)
Indirizzo e-mail e indirizzo Web.
2
8. Mappate gli Stili
1. Cliccate sulla colonna
HTML Tag in
corrispondenza dello stile
da mappare
1. Selezionate il tag HTML da
associare allo stile di Argo
Esempio: Titolo06 = h6
2. Cliccate su OK
1. Cliccate sul bottone Stili
9. Legenda del menu Tag HTML
Stili per il contenuto del manuale online
Titoli
Da h1 (header, cioè titolo di livello 1) ad h6 (header, cioè titolo di livello 6)
Determinano la struttura del sommario del manuale online
Elenchi
Puntato, numerato o lettera
Stili per l’intestazione del manuale online
Titolo e Sottotitolo
Titolo e sottotitolo del manuale
Indirizzo 1 e Indirizzo 2
Riferimenti dell’azienda
Stili per il piè di pagina del manuale online
Logofooter
Logo dell’azienda
Indirizzo e-mail e www
Indirizzo e-mail e indirizzo del sito web dell’azienda.
10. Incorporare video
Per gestire in Argo video da incorporare nell’help online in
formato HTML5:
1.Usando la funzione Stili, create un modulo Testo con stile
«video»
Operazione da compiere 1 sola volta
1.Inserite nel punto desiderato dell’help online il modulo
Testo con stile «video»
È consigliabile inserire i video in un livello a sé stante, in modo
tale da poterli escluderli facilmente dagli output su carta
1.Inserite l’URL del video da incorporare nel formato:
https://www.youtube.com/embed/eELikmo3Kbg
3
12. Che cosa fare in Argo
Ora siete pronti!
Per esportare da Argo i contenuti del manuale da
pubblicare sul web:
Cliccate sul bottone Esporta FrameEditor
Seguite la procedura guidata.
4
13. Esportate i contenuti da Argo
1. Selezionate un file di
configurazione di export
2. Cliccate sul bottone Avanti
15. Esportate i contenuti da Argo
1. Selezionate il documento e
la revisione da cui
esportare i contenuti
2. Cliccate sul bottone Avanti
16. Esportate i contenuti da Argo
Selezionate:
1.Contenuti da esportare (a
mano o richiamando i
marcatori [le Proprietà])
2.Destinatari
3.Lingua
4.Dove salvare il file
5.Cliccate sul bottone Avanti
17. Esportate i contenuti da Argo
1. Selezionate l’opzione Html
2. Se lo desiderate,
selezionate l’opzione
Esporta le immagini
3. Cliccate sul bottone Avanti
18. Esportate i contenuti da Argo
1. Se lo desiderate, salvate il
file di configurazione
2. Cliccate sul bottone Fine
per esportare i contenuti.
Otterrete un file denominato
Database.xml.
19. Che cosa fare nel Converter
Avete completato la prima fase della procedura!
Una volta esportati da Argo i contenuti del manuale da
pubblicare sul web:
Chiudete Argo
Accedete alla cartella che contiene Argo HTML(5)
Converter
La prima volta, create:
Una cartella in cui salvare il Template da modificare
Il Convertitore crea una copia del Template di default, che potete modificare per
personalizzare il layout di pagina e la formattazione dei contenuti dei manuali da
pubblicare online
Una cartella in cui salvare i manuali convertiti in HTML(5)
Aprite il convertitore.
1
20. Aprite il Converter
1. Create 2 cartelle per
salvare:
1. I Template grafici da
modificare
2. I manuali convertiti in
HTML(5)
2. Aprite il convertitore.
21. Per convertire il manuale in HTML(5), selezionate:
Selezionate il tipo di Template
Template 1 = HTML
Template 2 = HTML5
La cartella in cui salvare il Template da modificare
La cartella in cui salvare il manuale
Se desiderate realizzare help online in formato sia HTML, sia
HTML5, create e selezionate cartelle distinte per il Template 1 e
il Template 2
Il file Database.xml esportato da Argo
Si tratta del file con i contenuti del manuale da convertire.
Che cosa fare nel Converter 2
24. Cartella del Template da modificare
Il Convertitore crea una copia
del Template di default.
Potete modificarlo prima di
convertire il manuale per
personalizzare:
1.Layout di pagina (file
PageTemplate e
RicercaTemplate)
2.Formattazione dei contenuti
(fogli di stile CSS).
26. Attivate eventuali opzioni
Opzione per nominare le
pagine web secondo il formato
Numero progressivo + ID
univoco + Titolo della pagina
Opzione per definire ulteriori
corrispondenze fra stili di Argo
e tag di Titolo HTML.
Ulteriori a quelle già definite in
Argo.
28. Al termine della conversione del manuale in HTML(5):
Accedete alla cartella che contiene il manuale
Il manuale è contenuto in una cartella nominata in base alla data
e all’ora di creazione
Potete rinominare la cartella, prima di caricarla sul vostro web server per
pubblicare online il manuale in HTML(5)
Il convertitore segnala eventuali immagini mancanti, che potete
inserire a mano nella cartella Images del manuale, prima di
pubblicarlo sul web.
Che cosa fare nel Converter 3
30. Cartella del manuale in HTML(5)
Il manuale è contenuto in una
cartella nominata in base alla
data e all’ora di creazione.
Potete rinominare la cartella,
prima di caricarla sul vostro
web server per pubblicare
online il manuale.
32. Contenuto della cartella del
manuale in HTML(5)
Pagine HTML(5)
Il convertitore genera le pagine in base ai tag da h1 (header,
cioè titolo di livello 1) ad h6 (header, cioè titolo di livello 6)
impostati in Argo
Il convertitore genera una pagina per ogni tag da h1 ad h6
Cliccate sulla prima pagina HTML(5) per aprire il manuale nel vostro browser
predefinito
Così potete verificare il manuale prima di pubblicarlo online
Cartella Images
Contiene le immagini del manuale
Se necessario, copiate a mano le immagini nel formato e delle
dimensioni idonee alla visualizzazione sul web e/o le immagini
mancanti
Cartella CSS
Contiene i fogli di stile in formato CSS
Potete modificarli per personalizzare, dopo la conversione, la
formattazione dei contenuti del manuale.
33. Esempio di manuale in HTML
Per vedere un esempio di manuale in HTML
esportato da Argo, seguite questo link:
http://
www.keanet.it/realizzare-manuali-in-html-da-arg
34. Esempio di manuale in HTML
Il sommario del manuale è
generato in base ai tag da h1
ad h6 impostati in Argo
Intestazione e piè di pagina
contengono i valori dei tag
Titolo, Sottotitolo, Indirizzo 1 e
2, LogoFooter, Indirizzo e-mail
e www impostati in Argo
35. Esempio di manuale in HTML
Modificando i file Template
potete personalizzare il layout
di pagina:
•Intestazione
•Menu del sommario
•Piè di pagina
Modificando i fogli di stile CSS
potete personalizzare la
formattazione di tutti i
contenuti:
•Titoli
•Testi
•Elenchi
•Immagini
•Warnings
•Tabelle, ecc.
36. Esempio di manuale in HTML
Esempio di formattazione
automatica di una tabella, che
contiene celle concatenate
37. Esempio di manuale in HTML
Il motore di ricerca permette
all’utente di:
•Cercare nel manuale parole ed
espressioni chiave
•Accedere ai risultati della
ricerca
38. Esempio di video incorporato in
un manuale HTML5
Video incorporato in base
all’URL inserito in Argo nel
punto desiderato, in un modulo
Testo, stile «video»
39. Che cosa fare per pubblicare
online il manuale
Ora il manuale è in HTML!
Effettuate le verifiche, per pubblicare online il manuale in
HTML:
Selezionate la cartella che contiene il manuale
Caricate la cartella sul vostro server web
Per caricare la cartella utilizzate, per esempio, un client FTP
Per rendere il manuale accessibile da parte dei destinatari
Pubblicatene il link sul vostro sito internet
… oppure…
Comunicatene il link ai destinatari via e-mail o in una newsletter.
Ora il manuale è online!
1
40. Contatti
Contattateci per maggiori informazioni su Argo CMS e su
Argo HTML Converter!
KEA s.r.l.
Via Strà, 102
37042 Caldiero (VR)
Italia
Tel./Fax: +39 045 6152381
E-mail generale: info@keanet.it
Web: http://www.keanet.it/
Blog: http://blog.keanet.it/