Docs Italia beta

Documenti pubblici, digitali.

8.13. Box

Nel corpo dei documenti è possibile inserire i seguenti tipi di box.

Tabella 8.2 Tipi di box in Docs Italia
Box Sintassi
Nota
.. note::
Errore
.. error::
Suggerimento
.. hint::
Attenzione
.. attention::
Importante
.. important::
Approfondimento (il box, che può essere espanso, mostra solo una parte del testo
.. admonition:: deepening
   :class: admonition-deepening display-page
Esempio
.. admonition:: example
   :class: admonition-example display-page

   .. role:: admonition-internal-title
      :class: admonition-internal-title

   `Titolo interno al box`:admonition-internal-title:
RFC 2119: la semantica di questi box è quella espressa nel Request for Comments 2119.
.. admonition:: must
.. admonition:: should
.. admonition:: may
.. admonition:: must-not
.. admonition:: should-not
Usa e non usare
.. admonition:: use
.. admonition:: use-not
Generico con titolo arbitrario
.. admonition:: titolo del box

8.13.1. Il box Approfondimento

Nel box Approfondimento è possibile decidere quale parte del contenuto è sempre visibile e quale deve essere mostrata soltanto con il pulsante «Mostra tutto». È possibile indicare il contenuto nascosto con la direttiva .. container:: more, come nell’esempio seguente.

Nel caso in cui non venga usato questo parametro, verranno mostrati automaticamente soltanto i primi quattro elementi del contenuto (paragrafi <p>, elenchi <ul> o altro tipo di tag).

.. admonition:: deepening
   :class: admonition-deepening display-page

   Paragrafo di testo visibile.

   Paragrafo di testo visibile.

   .. container:: more

      Paragrafo di testo nascosto. Può essere mostrato cliccando su "Mostra tutto".

      Paragrafo di testo nascosto. Può essere mostrato cliccando su "Mostra tutto".

Questo codice genera il seguente risultato.

deepening

Paragrafo di testo visibile.

Paragrafo di testo visibile.

Paragrafo di testo nascosto. Può essere mostrato cliccando su «Mostra tutto».

Paragrafo di testo nascosto. Può essere mostrato cliccando su «Mostra tutto».