2 votes

Bonne façon de gérer le code dans les présentations pour l'atelier de programmation

Je suis actuellement en train de créer un atelier de programmation (en fait, il s'agit d'OOD, mais cela ne devrait pas avoir trop d'importance).

Je dispose principalement de deux types de ressources :

  • diapositives (HTML / reveal.js)
  • exemples de projets (Java)

À de nombreux endroits, le code des projets d'exemple devrait apparaître dans la présentation.

Quel est le meilleur moyen d'y parvenir ?

Mes exigences sont les suivantes

  • un moyen facile de spécifier un extrait de code à utiliser dans une présentation et l'endroit où il doit apparaître.

  • les modifications apportées au code sont reflétées automatiquement dans la présentation (l'utilisation d'un outil de construction est acceptable, mais pas le copier-coller manuel).

  • les liens brisés (par exemple, essayer d'intégrer un extrait de code qui n'existe pas ou marquer un extrait qui n'est pas utilisé dans la présentation) doivent donner lieu à un avertissement.

  • Points bonus pour avoir des liens entre le code et la présentation

0 votes

Il serait vraiment utile de connaître la raison de ces votes serrés.

3voto

ahus1 Points 145

Asciidoctor http://asciidoctor.org/ pourrait résoudre la plupart de vos besoins :

  • utiliser l'ASCII pour écrire le contenu
  • inclure des extraits de code provenant de véritables fichiers de code source
  • Les liens brisés créeront un avertissement lors de la construction de la sortie.
  • création de présentations dans reveal.js et deck.js

Vous trouverez à https://github.com/asciidoctor/asciidoctor-gradle-examples quelques exemples d'utilisation d'Asciidoctor avec gradle (mais d'autres outils de construction fonctionnent également).

Puedes consultez l'exemple de sortie ici et vous trouverez une présentation rendue avec deck.js et reveal.js (cherchez les sous-chapitres 3.4 et 9.4 intitulés "Outputs")

Une autre source d'inspiration pourrait être le jeu de cartes de Dan Allan : https://github.com/mojavelinux/decks

Vous avez également demandé des liens du code vers la présentation. Le mieux qu'Asciidoctor puisse vous fournir AFAIK est que la balise que vous avez utilisée pour marquer votre extrait de code dans le code ( // tag::XXX[] ) sera également présent dans la source de votre présentation ( include::Class.java[tags=XXX] )

SistemesEz.com

SystemesEZ est une communauté de sysadmins où vous pouvez résoudre vos problèmes et vos doutes. Vous pouvez consulter les questions des autres sysadmins, poser vos propres questions ou résoudre celles des autres.

Powered by:

X