Sintassi del linguaggio della documentazione - Introduzione

Il presente documento ha lo scopo di descrivere le specifiche e i costrutti, e dove possibile fornirne degli esempi, disponibili per la composizione della documentazione attiva visualizzabile tramite i componenti della scheda o del browser di Loocup.
Questo a complemento del wizard presente nell'editor e richiamabile premendo CTRL+W sulle specifiche.
Il documento è suddiviso nella varie categoria di elementi supportati dalla sintassi dell'editor.

Elementi di testo

Sono a disposizione elementi per definire titoli, righe o paragrafi con formato definito.

I titoli

Esistono tre livelli gerarchici di titolo di importanza decrescente:

1. ..T01
   
2. ..T02
   
3. ..T03
   

Le righe

Esistono tre tipi di riga:

1. ..R01
   
2. ..R02
   
3. ..R03
   

Esempi

::R01 Riga tipo R01Sintassi:
::R01 Riga tipo R01::R02 Riga tipo R02Sintassi:
::R02 Riga tipo R02::R03 Riga tipo R03Sintassi:
::R03 Riga tipo R03

I paragrafi

::R01 Specifica PAR che deve essere chiusa dalla specifica PAR.ENDEsistono quattro diversi tipi di paragrafo:

1. Piano senza valorizzazione della variabile F
   
2. In evidenza (grassetto): F(01)
   
3. Formato fisso (font monospaced con colore blu): F(02)
   
4. Nota tecnica (italic con font piccolo): F(03)
   
5. Formattazione forzata: F(04)
   

Esempi

Piano
Esempio di PAR
Sintassi:
::PAR T(Piano)
Esempio di PAR
::PAR.END
In evidenza:
Esempio di PAR
Sintassi:
::PAR F(01) T(In evidenza)
Esempio di PAR
::PAR.END
Formato fisso:
Esempio di PAR
Sintassi:
::PAR F(02) T(Formato fisso)
-
Esempio di PAR
::PAR.END
Nota tecnica:
Esempio di PAR
Sintassi:
::PAR F(03) T(Nota tecnica)
Esempio di PAR
::PAR.END

Le liste

::R01 Specifica PAR che deve essere chiusa dalla specifica PAR.ENDIl linguaggio permette di comporre delle liste, anche annidate. Esse possono avere come indicatori punti, numeri o lettere.

• I singoli item delle lista devono essere una riga nuova che comincia con un trattino e uno spazio ("- ")
  
• Le liste supportano gli stessi formati dei paragrafi: F(01), F(02), F(03) e F(04) che rappresentano gli stessi effetti di stile.
  
• Nel caso di liste ordinate (numerate o letterali) è supportata la variabile C che permette di indicare:
  
  • se continuare la numerazione o "letterazione" prendendola dall'elenco precedente *CONT
    
  • se iniziare l'elenco da una specifica lettera o numero
    
• Vengono gestiti anche tre differenti tipi di lista tramite la variabile L
  

Puntate

Esempi

Tipo puntato:

• Riga 3.p
  
• Riga 3.p
  
  • Nested 1
    
• Riga 3.p
  

Sintassi:
::PAR T(Tipo puntato) L(PUN)

• Riga 3.p
  
• Riga 3.p
  
  • Nested 1
    
• Riga 3.p
  

::PAR.END

Numerate

Esempi

Tipo numerato:

1. Riga 1.n
   
2. Riga 2.n
   
3. Riga 3.n
   
   1. Riga 3.1.n
      
      1. Riga 3.1.1.n
         
      2. Riga 3.1.2.n
         
   2. Riga 3.2.n
      
4. Riga 4.n
   

Sintassi:
::PAR L(NUM) T(Tipo numerato)
- Riga 1.n
- Riga 2.n
- Riga 3.n
-- Riga 3.1.n
--- Riga 3.1.1.n
--- Riga 3.1.2.n
-- Riga 3.2.n
- Riga 4.n
::PAR.END

Alfabetiche

L(LET)

Esempi

- Riga 2.l
-- Riga 2.l
--- Riga 2.l
- Riga 2.l
- Riga 2.l
- Riga 2.l

---

P.S.: all'interno delle liste vengono mal gestite le immagini, quindi tag IMG all'interno di liste possono dare origine a comportamenti non lineari nel posizionamento delle immagini, soprattutto nella generazione del PDF.

Le tabelle

::R01 Specifica TAB che deve essere chiusa dalla specifica TAB.ENDLa sintassi è simile alle liste:

• Nota, c'è un tag aggiuntivo rispetto alle liste che permette di qualificare le colonne (es. la dimensione) e la loro intestazione ed è il tag ..TAB.COL che deve essere specificato per ogni colonna. Attenzione, per una corretta gestione nella stampa Latex l'ultima colonna deve avere Allineamento = "L".
  
• Ogni riga di contenuto contiene i valori delle celle separati da pipe (|)
  
• Nella specifica TAB viene gestito il parametro R, che determina la percentuale di riduzione della larghezza della tabella rispetto alla larghezza pagina (default 60%)
  
• Nella specifica TAB.COL viene gestito il parametro Lun, che determina la percentuale di larghezza della colonna rispetto alla larghezza pagina (se manca o se = 0 il parametro Lun viene saltato e si utilizzano Allineamento e LunAut. Nota Bene la somma dei parametri Lun della varie colonne non può essere superiore al parametro R della tabella.
  

Con colonne omogenee

Esempi

Test	tabella	HTML
riga	dati	esempio

---

Con colonne disomogenee

E' attivo solo nell'esportazione in PDF ma non vale nella visualizzazione HTML

Esempi

Test	tabella	HTML
riga	dati	esempio

---

Le immagini

E' possibile includere nel documento immagini utilizzando la specifica IMG

Inclusioni esplicite

::R01 Specifica IMGLa specifica IMG gestisce quattro parametri:

1. Il parametro P permette di indicare il percorso
   
2. Il parametro H permette di indicare l'altezza con cui verrà rappresentata l'immagine
   
3. Il parametro W permette di indicare la larghezza con cui verrà rappresentata l'immagine
   
4. Il parametro R permette di indicare la percentuale di scalatura, che mantiene le proporzioni della stessa, con cui verrà rappresentata l'immagine. E' attivo solo nell'esportazione in PDF, ma non vale nella visualizzazione HTML
   

Esempi

Vedi (J1PATHFILE-
Smea.it\dfs_r)

Sintassi:
..IMG P(
SRV005.smeup.com\smeup\LOOCUP_IMG\CN\COL\default.jpg) H(0000000180) W(0000000200)
oppure
..IMG P(
SRV005.smeup.com\smeup\LOOCUP_IMG\CN\COL\default.jpg) R(90)

Le funzioni

::R01 Specifica DECLa specifica DEC permette di rappresentare delle chiamate funzione.

La specifica DEC supporta i seguenti parametri:

• T: tipo oggetto
  
• P: parametro oggetto
  
• K: codice oggetto
  
• D: descizione dell' oggetto
  
• I: intestazione del link
  
• X: eventuale funzione da richiamare sul click anzichè il default
  
• O: configurazione dell' output del link: essa può assumere uno o più di dei seguenti valori:
  
  • T riporta il tipo del documento linkato nel link
    
  • P riporta il parametro del documento linkato nel link
    
  • K riporta il codice del documento linkato nel link
    
  • I riporta il campo I nel link
    
  • D riporta il campo D nel link
    
  • G riporta l'immagine dell'oggetto T-P-K nel link
    
  • R non permette l'inclusione del file puntato nella generazione del PDF
    

La funzione di default è la chiamata della scheda dell'oggetto T-P-K.
In alcuni casi però il comportamento si discosta da tale standard:

• Nei tipi oggetto MB-DOC, infatti viene richiamato il file di documentazione.
  
• Nei tipi oggetto J1-PATHFILE viene richiamato il file PC.
  

N.B.: nel caso di tipo di ogggetto MB-DOC, bisogna considerare le seguenti caratteristiche:

1. viene riportata sempre e solo la descrizione del membro. Il parametro O, in questo caso, viene trascurato.
   
2. se non viene specificato il parametro I viene incluso il membro in oggetto, diversamente viene formato il link al membro.
   

Chiamate di funzioni

Esempi

Vedi Prova 2 descrizione normale standar (AR-A01)

---

Vedi Prova 2 descrizione normale standar (AR-A01)
Vedi (-)

---

Chiamate a link esterni

https://mail.softia.com
https://mail.softia.com
http://www.smeup.com
http://www.smeup.com
Vedi (J1PATHFILE-AZI.HOM.01\Do)

Sintassi:
http://www.smeup.com/images/home_centro_sx.jpg

Chiamate a documentazione

Sintassi:

I popup

::R01 Specifica INT che deve essere chiusa con FINE' possibile costruire delle finestre di popup contenenti testo. La prima riga viene considerata come titolo del popup ed il resto viene utilizzato come contenuto dello stesso. Nelle sezioni della scheda il popup viene rappresentato in piano, mentre nel componente Browser appare in finestra separata.

Rappresentazione popup

Esempi

Titolo del popup
Contenuto del popup stesso

Sintassi:
::INT Titolo del popupContenuto del popup stesso
::FIN

Salto pagina

Esiste la possibilità di forzare il salto pagina in qualunque punto del testo. Questa specifica avrà efficacia nei documenti PDF:
..::NPG
Sintassi:

Formattazione testo inline

Per formattazione inline si intende la possibilità di cambiare il formato del testo all'interno di frasi, elementi complessi come liste, tabelle, ecc...

Effetto	Specifica
Rosso Grande	1
Blu Grande	2
Verde scuro Grande	3
Rosa Grande	4
Verde chiaro Reverse	5
Rosso	7
Blu	8
Verde scuro	9
Rosa	B
Verde chiaro	R
Sottolineato	u
Alta intensità	h
Italic	i
Rosso sottolineato	r

All'interno di un testo si può cambiare il formato del testo ponendo prima del testo oggetto del cambio una delle specifiche sopra indicate racchiuse fra _ e chiudendo la porzione di testo interessata dal cambio con la specifica n racchiusa fra _.
Quindi queste parole saranno in italic
Questo, a capo e bold

Documenti collegati:

Costruzione output PDF

Specifica aggiuntiva - Le inclusioni

::R01 Specifica I.INC.MBRPermette di includere in un documento di testo un altro documento di testo. La specifica gestisce due parametri:

1. Il parametro Fil che stabilisce in quale file è contenuto il membro di testo da includere
   
2. Il parametro Mem che è il nome membro da includere
   

Esempio di compilazione

..I.INC.MBR Fil(DOC_OGG) Mem(P_V5STA01)

Caratteri speciali

verifica di riga che caratteri speciali {\\ [\\ {\\ "key":"auxiliary1",\\ "label":"Saldo Punti",\\ "value":"%PUNTI%",\\ "textAlignment":"PKTextAlignmentLeft"\\ },\\ {\\ }\\ ]\\