Skip to content

IEDIB/atto-snippet-libjs

Repository files navigation

atto-snippet-libjs

Estructura de directoris

Cada component snippet dinàmic vindrà definit per un nom identificador, per exemple dynamic_sample

Dins del directori src/ ubicam el fitxer js que defineix cada snippet dinàmic (amb nom sample.js).

Una vegada establerta l'estructura de sample.js, tots els altres snippets seguiran exactament la mateixa forma.

Dins de la carpeta build un script anomenat build.js s'encarregarà de minificar tots els fitxers de dins la carpeta src. Així, doncs, en el llibre moodle, l'usuari apuntarà a <script src="https://servidor/arrel/sample.min.js"></script>

El markup HTML junt amb la meta-informació associada amb l'snippet anirà dins la carpeta presets. Cada snippet tindrà un fitxer de configuració yaml amb nom dynamic_sample.yaml. Aquest fitxer és el que s'empra a posteriori per ésser importat dins el plugin "iedib-atto-snippets" de Moodle.

En el markup HTML, class="iedib-snippetd" permetrà donar una aparença uniforme a tots els contenidors dels snippets dinàmics. D'altra banda role="dynamic_sample" identifica el tipus de component dinàmic que ha d'ésser processat.

Instal·lar per a desenvolupament

Requisits nodejs + npm npm install

Per compilar les font npm run build

Estructura HTML d'un component

Un component dinàmic tindrà la següent estructura

  <div class="iedib-snippetd{{#ifCond printable 'eq' 0}} d-print-none{{/ifCond}}" role="dynamic_NAME" data-param1="{{param1}}" data-param2="{{param2}}" ···>
        ···
    </div>  

Una classe iedib-snippetd per donar un estil comú a tots els snippets dinàmics. Una condició sobre si l'snippet ha d'aparèixer imprès o no. El role que identifica el tipus de snippet dinàmic (canviar NAME pel nom real). Finalment una sèrie de paràmetres tipus data que permetran configurar l'snippet.

Fixeu-vos que els placeholders {{paramn}} són els noms dels paràmetres que es defineixen dins del presets/dynamic_NAME.yaml. Aquests placeholders es converteixen en inputs en el plugin iedib-atto-snippets de l'editor atto.

About

JS Components for atto-ibsnippet

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •