FAQ

SARP fornisce una pagina di FAQ (Frequently Aasked Questions) per l'utente.

L'obiettivo è di fornire una risposta alle domande più ovvie e frequenti che gli utenti di SARP potranno avere

Allo stessso modo deve essere anche facile per lo svilupaptore aggiungere una FAQ quando necessario

Per questo è possibile aggiungere un FAQ semplicemente creando un file in markdown con estension .md

DIRECTORY FAQ

La directory che contiene le FAQ è specificata nel file .env, tramite la variabile PUBLIC_FAQ_DIR. Al momento impostata a static/faq/

Pertanto per aggiungere una nuova FAQ (solo la parte di risposta) è necessario aggiungere un file .md in questa directory

FILE MD

Il file nella directory PUBLIC_FAQ_DIR deve rispettare la seguente naming ocnvention

faqN_M.md

dove:

• N: è il numero della sezione FAQ
• M: è il numero di FAQ nella sezione M

Il contentuo del file può essere in HTML o MARKDOWN o mix dei due laddove necessario

AGGIUNGERE UNA FAQ A SARP

Per aggiunegre una nuova FAQ bisogna seguire i seguenti passi:

1. editare il file src/routes/faq/+page.svelte
2. aggiungere un nuovo oggetto Faq
3. numerare l'oggetto in modo opportuno all'interno della sua FaqSection

Vediamo un esempio:

<FaqSection title="1. Utenti" number="1">
  <Faq
      show={true}
      number="1-1"
      parent_number="1"
      question="Come posso segnalare un malfunzionamento, un suggerimento o una richiesta di modifica?"
      answer={faq('faq1_1')}
  />

dove:

• show: true|false indica se la FAQ è visualizzata o bisogna fare click per aprirla e leggerla
• number: numero della FAQ che deve coincidere con la parte N e M del nome del file
• parent: indica la faq section di appartenenza
• question: il testo della domanda
• answer: un riferimento, tramite l'helper faq() al nome del file

Questo meccanismo permette di gestire e manutenere le FAQ in modo facile, veloce ed agevole, grazie all'impiego di Markdown come semplice sintassi di markup