showoff 0.17.2 → 0.18.0

data/lib/showoff/version.rb

@@ -1,3 +1,3 @@
 # No namespace here since ShowOff is a class and I'd have to inherit from
 # Sinatra::Application (which we don't want to load here)
-SHOWOFF_VERSION = '0.17.2'
+SHOWOFF_VERSION = '0.18.0'

data/lib/showoff_utils.rb

@@ -391,24 +391,28 @@ class ShowOffUtils
     [code,lines,width]
   end
 
-  def self.showoff_sections(dir, logger = nil)
+  def self.showoff_sections(dir, data = nil, logger = nil)
     unless logger
       logger = Logger.new(STDOUT)
       logger.level = Logger::WARN
     end
 
-    index = File.join(dir, ShowOffUtils.presentation_config_file)
     begin
-      data = JSON.parse(File.read(index)) rescue ["."] # default boring showoff.json
+      unless data
+        index = File.join(dir, ShowOffUtils.presentation_config_file)
+        data  = JSON.parse(File.read(index)) rescue ["."] # default boring showoff.json
+      end
+
       logger.debug data
       if data.is_a?(Hash)
-        sections = data['sections'] if data.include? 'sections'
+        # dup so we don't overwrite the original data structutre and make it impossible to re-localize
+        sections = data['sections'].dup
       else
-        sections = data
+        sections = data.dup
       end
 
       if sections.is_a? Array
-        sections = showoff_legacy_sections(sections)
+        sections = showoff_legacy_sections(dir, sections)
       elsif sections.is_a? Hash
         raise "Named sections are unsupported on Ruby versions less than 1.9." if RUBY_VERSION.start_with? '1.8'
         sections.each do |key, value|
@@ -437,7 +441,7 @@ class ShowOffUtils
     sections
   end
 
-  def self.showoff_legacy_sections(data)
+  def self.showoff_legacy_sections(dir, data)
     # each entry in sections can be:
     # - "filename.md"
     # - { "section": "filename.md" }
@@ -465,28 +469,36 @@ class ShowOffUtils
           end
         end
       end
-
       section
-    end.flatten.compact.each do |filename|
+    end.flatten.compact.each do |entry|
       # We do this in two passes simply because most of it was already done
       # and I don't want to waste time on legacy functionality.
+
+      # Normalize to a proper path from presentation root
+      filename = File.expand_path(entry).sub(/^#{dir}\//, '')
+      # and then strip out the locale directory, if there is one
+      filename.sub!(/^(locales\/[\w-]+\/)/, '')
+      locale = $1
+
       if File.directory? filename
-        path = filename
+        path = entry
         sections[path] ||= []
         Dir.glob("#{filename}/**/*.md").sort.each do |slidefile|
-          sections[path] << slidefile
+          fullpath = locale.nil? ? slidefile : "#{locale}/#{slidefile}"
+          sections[path] << fullpath
         end
       else
-        path = File.dirname(filename)
+        path = File.dirname(entry)
         sections[path] ||= []
         sections[path]  << filename
       end
     end
+
     sections
   end
 
-  def self.showoff_slide_files(dir, logger = nil)
-    data = showoff_sections(dir, logger)
+  def self.showoff_slide_files(dir, data = nil, logger = nil)
+    data = showoff_sections(dir, data, logger)
     data.map { |key, value| value }.flatten
   end
 

data/locales/README.md

@@ -0,0 +1,25 @@
+# Creating a strings file for a new translation
+
+Thanks for helping translate. It's a big job. Your part should be fairly
+simple though. All you'll need to do is generate a new strings file, or
+update an existing one.
+
+## Generating a new strings file
+
+1. Copy `en.yml` to a new file in the `locales` directory named after the language.
+    * Use the two-letter [ISO_639-1](https://en.wikipedia.org/wiki/ISO_639-1) code.
+    * The extension *must be* `.yml`; for example `de.yml`.
+1. Change the toplevel key from `:en` to the language code as a symbol.
+    * For example, `:de` or `:es`.
+1. Translate each value without changing the file structure.
+    * Quotes around the string are not necessary unless it contains a special character, such as `:`
+1. Submit a PR with your new language!
+
+## Using the GitHub web UI
+
+It might be easiest to just do this in the GitHub UI if you don't already have
+your own fork & clone of the project.
+
+Copying a file isn't very straightforward in the web UI. Instead, you'll need to
+copy the file contents to your clipboard, then create a new file and paste it back
+in. Nevertheless, once the file's created, it's quite easy to update this way.

data/locales/de.yml

@@ -0,0 +1,160 @@
+de:
+  name: Showoff Präsentation
+  menu:
+    title: Showoff Menü
+    table_of_contents: Inhaltsverzeichnis
+    downloads: Downloads
+    feedback: Senden...
+    pace:
+      label: Der Präsentierende soll...
+      slower: Langsamer werden
+      faster: Schneller werden
+    question:
+      label: XFrage stellen
+      placeholder: Frage stellen...
+    feedback:
+      label: Feedback senden
+      description: Diese Folie ist...
+      worst: Schrecklich
+      best: Großartig
+      why: Warum...?
+      send: Senden
+    edit: Aktuelle Folie ändern
+    clear_annotations: Anmerkungen entfernen
+    language: Inhalt Sprache
+    close: Schließen
+    help: Drücke das <code>?</code> für Hilfe.
+    anonymous: Alle Feedbacks sind anonym.
+  navigation:
+    next: Nächste Folie
+    previous: Vorherige Folie
+  loading: laden der Präsentation...
+  activity_complete: Aktivität vollständig
+  follow:
+    label: "Folge dem Präsentierer:"
+  refresh: "Soll der Inhalt der Folie aktualisiert werden?\n\n(Verwende `RELOAD` wenn die gesamte Präsentation neu geladen werden soll)"
+  reload: Soll Showoff neu geladen werden?
+  preshow:
+    prompt: Beginn in Minuten?
+    resume: "Fortsetzen in Minuten:"
+
+  downloads:
+    title: Datei Downloads
+
+  help:
+    title: Hilfe
+    next: Zur nächsten Folie.
+    prev: Zur vorherigen Folie.
+    contents: Anzeigen des Inhaltsverzeichnisses.
+    follow: Mitverfolgen ein/aussschalten.
+    help: Anzeigen der Hilfe.
+    refresh: Inhalte neu laden.
+    reload: Showoff vollstämdig neu laden.
+    blank: Bildschirm leeren.
+    footer: Fußzeite eun/ausschalten.
+    notes: Hinweise ein/ausschalten.
+    clear: Ergebnisse löschen.
+    pause: Pausieren der Präsentation.
+    preshow: Anzeigen der Präsentation <tt>preshow</tt> mit einem Timer.
+    execute: Ausführen des ersten sichtbaren Blocks.
+    debug: Anzeigen von Debug Informationen.
+    close: Schließen.
+
+  stats:
+    title: Ansischtsstatistiken.
+    stray: der Teilnehmer sehen eine andere Folie.
+    idle: der Teilnehmer sind inaktiv.
+    current: Aktuelle Folien.
+    elapsed: Zeit pro Folie.
+    nodata: Keine Daten zum Anzeigen vorhanden.
+    allcurrent: Alle Teilnehmer sehen die Folie des Präsentierenden.
+
+  forms:
+    display: Anzeige der Ergebnisse
+    save: Speichern
+
+  presenter:
+    topbar:
+      annotations: Anmerkungen
+      edit: Folie bearbeiten
+      report: Fehler mit Folie melden
+      stats: Ansichtsstatistiken
+      downloads: Downloads
+      display: Anzeigefenster
+      print: Folien drucken
+      settings: Einstellungen
+      newpage: Im neuen Fenster öffnen...
+      tooltip:
+        annotations: Aktivieren des Anmerkungssystems.
+        edit: Bearbeiten der Folie in einem neuen Fenster.
+        report: Einen Fehler der aktuellen Folie melden.
+        stats: Anschauen, welche Folien von den Teilnehmern betrachtet wurden.
+        downloads: Öffnen des Download Bereiches im Menü oder in einem neuen Fenster.
+        display: Aktivieren des Präsentationsfenster; dieses sollte über den Projektor gezeigt werden.
+        print: Folien in einem neuen Fenster drucken.
+        settings: Öffnen der Einstellungen.
+    preview:
+      next: Nächste Folie
+      previous: Vorherige Folie
+    mobile:
+      update: Aktualisierung
+    notes:
+      label:  Showoff Notizen
+      personal: Persönliche Notizen
+    timer:
+      label: "Timer:"
+      start: Start
+      pause: Pause
+      resume: Fortsetzen
+      cancel: Abbrechen
+      unit: Minuten
+    pace:
+      faster: Langsamer!
+      slower: Schneller!
+    questions: Frage von Teilnehmern
+    annotation:
+      tools: Werkzeuge
+      lines: Linien
+      shapes: Formen
+    status:
+      label: "Folien:"
+    settings:
+      label: Einstellungen
+      close: Schließen
+      follower:
+        label: Aktualisierung Schüler Folien
+        tooltip: Benachrichtigung üder Änderung versenden
+        description: Wenn dies aktiviert ist, bekommt der Showoff Server Informaitonen über Aktualisierungen. Deaktivieren, um versehentlicher Aktualiserungen zu verhindern.
+      remote:
+        label: Remote aktivieren
+        tooltip: Aktiviert das Update durch einen weiteren Präsentierer.
+        description: Wenn dies aktiviert ist, dann kann man die Präsentationvon einem anderen Geräterfolgen (üblicherweise ein Mobiles Endegerät).
+      layout:
+        label: Anordnung
+        default: Default Ansicht
+        thumbs: Anzeigen von Miniaturansichten der nächsten und vorherigen Folie.
+        beside: Anzeigen der nächsten Folie als Großansicht n der Präsentierer Ansicht.
+        floating: Öffnen der nächsten Folie in einem neuen Fenster.
+        confirmation: Die Sicherheitseinstellungen des Browsers machen es erforderlich, dass das Öffnen eines neuen Fensters bestätigt wird.
+        open: Fenster öffnen
+        cancel: Abbrechen
+        reset:
+          label: Löschen der Showoff Einstellungen.
+          tooltip: Zurücksetzen der Showfoff Einstellungen auf die Standardwerte.
+      language:
+        label: Inhalt Sprache
+        tooltip: Wählen Sie aus den verfügbaren Übersetzungen aus oder wählen Sie basierend auf Ihren Browsereinstellungen.
+        description: Diese Präsentation ist in verschiedenen Sprachen verfügbar. Wählen Sie die Sprache, die Sie anzeigen möchten, oder lassen Sie sie bei <tt>automatisch</tt>, um Ihre Browsereinstellungen zu verwenden.
+    print:
+      label: Wählen Sie die Art der gedruckten Notizen aus
+      description: Wählen Sie den Inhalt aus, den Sie unter den Folien anzeigen möchten.
+      none: Notizen nicht enthalten
+      notes: Präsentierende Notizen
+      handouts: Publikum Handzettel
+
+  language:
+    auto: Automatisch
+    disable: Deaktivieren Sie Übersetzungen
+
+  error:
+    file_not_found: Datei nicht gefunden!

data/locales/en.yml

@@ -0,0 +1,160 @@
+en:
+  name: Showoff Presentation
+  menu:
+    title: Showoff Menu
+    table_of_contents: Table of Contents
+    downloads: Downloads
+    feedback: Sending...
+    pace:
+      label: The presenter should...
+      slower: Slow Down
+      faster: Speed Up
+    question:
+      label: Ask a Question
+      placeholder: Ask a question...
+    feedback:
+      label: Send Feedback
+      description: This slide is...
+      worst: Terrible
+      best: Awesome
+      why: Why...?
+      send: Send
+    edit: Edit Current Slide
+    clear_annotations: Clear Annotations
+    language: Content Language
+    close: Close
+    help: Press <code>?</code> for help.
+    anonymous: All features are anonymous.
+  navigation:
+    next: Next
+    previous: Previous
+  loading: loading presentation...
+  activity_complete: Activity complete
+  follow:
+    label: "Follow Mode:"
+  refresh: "Are you sure you want to refresh the slide content?\n\n(Use `RELOAD` to fully reload the entire UI)"
+  reload: Are you sure you want to reload Showoff?
+  preshow:
+    prompt: Minutes from now to start?
+    resume: "Resuming in:"
+
+  downloads:
+    title: File Downloads
+
+  help:
+    title: Help
+    next: Move to the next slide.
+    prev: Move to the previous slide.
+    contents: Show the table of contents menu.
+    follow: Toggle follow mode.
+    help: Show this help dialog.
+    refresh: Refresh slide content.
+    reload: Completely reload Showoff.
+    blank: Blank the screen.
+    footer: Toggle the display footer.
+    notes: Toggle notes display.
+    clear: Clear code execution results.
+    pause: Pause the presentation.
+    preshow: Display slideshow of <tt>preshow</tt> images on a timer.
+    execute: Execute the first visible code block.
+    debug: Show debugging information.
+    close: Close
+
+  stats:
+    title: Viewing Statistics
+    stray: of your audience is not viewing the same slide you are.
+    idle: of your audience is idle.
+    current: Slides currently being viewed
+    elapsed: Elapsed time spent on each slide
+    nodata: No data to display.
+    allcurrent: All audience members are viewing the presenter's slide.
+
+  forms:
+    display: Display Results
+    save: Save
+
+  presenter:
+    topbar:
+      annotations: Annotations
+      edit: Edit Slide
+      report: Report Issue With Slide
+      stats: Viewing Statistics
+      downloads: Downloads
+      display: Display Window
+      print: Print Slides
+      settings: Settings
+      newpage: Open in a new page...
+      tooltip:
+        annotations: Enable the annotations subsystem.
+        edit: Edit current slide in new window.
+        report: Report an issue with the current slide.
+        stats: See the slides your audience is interacting with.
+        downloads: Open the file downloads in a menu or new page.
+        display: Enable the Display Window; you should put this on the projector.
+        print: Print slides using a new window.
+        settings: Open the Settings dialog.
+    preview:
+      next: Next
+      previous: Previous
+    mobile:
+      update: Update
+    notes:
+      label:  Showoff Notes
+      personal: Personal Notes
+    timer:
+      label: "Timer:"
+      start: Start
+      pause: Pause
+      resume: Resume
+      cancel: Cancel
+      unit: minutes
+    pace:
+      faster: Speed Up!
+      slower: Slow Down!
+    questions: Audience Questions
+    annotation:
+      tools: Tools
+      lines: Lines
+      shapes: Shapes
+    status:
+      label: "Slides:"
+    settings:
+      label: Settings
+      close: Close
+      follower:
+        label: Update Follower
+        tooltip: Send slide change notifications.
+        description: When this is enabled, the Showoff server will track your slide changes. Disable it to observe the presentation without inadvertently causing slide changes.
+      remote:
+        label: Enable Remote
+        tooltip: Enables tracking of other presenters.
+        description: When this is enabled, you can load the presenter in another browser (typically on your mobile phone) to control the presentation.
+      layout:
+        label: Layout
+        default: Default Layout
+        thumbs: Display thumbnail previews of the next and previous slides.
+        beside: Display the next slide as a large preview in the main presenter view.
+        floating: Open the next slide as a floating window.
+        confirmation: Browser security requires confirmation before opening a new window.
+        open: Open Window
+        cancel: cancel
+        reset:
+          label: Clear Showoff settings.
+          tooltip: Reset Showoff UI settings to default values.
+      language:
+        label: Content Language
+        tooltip: Select from available translations, or autoselect based on your browser settings.
+        description: This presentation is available in different languages. Choose the language you would like to view or leave it at <tt>automatic</tt> to use your browser settings.
+    print:
+      label: Choose type of printed notes
+      description: Select the content you'd like to show under the slides.
+      none: Don't include notes
+      notes: Presenter Notes
+      handouts: Audience Handouts
+
+  language:
+    auto: Automatic
+    disable: Disable Translations
+
+  error:
+    file_not_found: File Not Found!

data/locales/es.yml

@@ -0,0 +1,160 @@
+es:
+  name: Presentación en Showoff
+  menu:
+    title: Menú de Showoff
+    table_of_contents: Tabla de Contenidos
+    downloads: Descargas
+    feedback: Enviando...
+    pace:
+      label: El Presentador Debería...
+      slower: Ir Más Despacio
+      faster: Ir Más Rápido
+    question:
+      label: Hacer una Pregunta
+      placeholder: Hacer una pregunta...
+    feedback:
+      label: Enviar Sugerencias
+      description: Esta Diapositiva es...
+      worst: Terrible
+      best: Genial
+      why: Por Qué...?
+      send: Enviar
+    edit: Editar Esta Diapositiva
+    clear_annotations: Limpiar Notas
+    language: Idioma del contenido
+    close: Cerrar
+    help: Presionar <code>?</code> para ver ayuda.
+    anonymous: Todas las funciones son anónimas.
+  navigation:
+    next: Siguiente
+    previous: Anterior
+  loading: cargando presentación...
+  activity_complete: Actividad completa
+  follow:
+    label: "Modo de Seguimiento:"
+  refresh: "Está seguro que desea refrescar el contenido de la diapositiva?\n\n(Use `RELOAD` para refrescar la interfaz entera)"
+  reload: Está seguro que desea refrescar Showoff?
+  preshow:
+    prompt: Minutos desde ahora al comienzo?
+    resume: "Continuando en:"
+
+  downloads:
+    title: Descarga de Archivos
+
+  help:
+    title: Ayuda
+    next: Mover a la siguiente diapositiva.
+    prev: Mover a la diapositiva anterior.
+    contents: Mostrar el menú de la tabla de contenidos.
+    follow: Habilitar el modo de seguimiento.
+    help: Mostrar éste dialogo de ayuda.
+    refresh: Refrescar el contenido de la diapositiva.
+    reload: Refrescar el contenido total de Showoff.
+    blank: Oscurecer la pantalla.
+    footer: Habilitar/Deshabilitar las notas de pie de página.
+    notes: Habilitar/Deshabilitar notas de Showoff.
+    clear: Limpiar los resultados de la ejecución de código.
+    pause: Pausar la presentación.
+    preshow: Mostrar las diapositivas de imágenes de <tt>preshow</tt> con un contador de tiempo.
+    execute: Ejecutar el primer bloque de código visible.
+    debug: Mostrar información de debug.
+    close: Cerrar
+
+  stats:
+    title: Ver Estadísticas
+    stray: tu audiencia no está viendo la misma diapositiva que tú.
+    idle: tu audiencia no está activa.
+    current: Diapositivas que están siendo vistas
+    elapsed: Tiempo transcurrido en cada diapositiva
+    nodata: No hay información para mostrar.
+    allcurrent: Todos los miembros de la audiencia están viendo la diapositiva del presentador.
+
+  forms:
+    display: Mostrar Resultados
+    save: Guardar
+
+  presenter:
+    topbar:
+      annotations: Notas
+      edit: Editar Diapositiva
+      report: Reportar Problema con Diapositiva
+      stats: Ver Estadísticas
+      downloads: Descargas
+      display: Ventana de Presentación
+      print: Imprimir Diapositivas
+      settings: Configuraciones
+      newpage: Abrir en una nueva página...
+      tooltip:
+        annotations: Habilitar el subsistema de notas.
+        edit: Editar diapositiva actual en nueva ventana.
+        report: Reportar un problema con diapositiva actual.
+        stats: Ver las diapositivas que tu audiencia está viendo.
+        downloads: Abrir descargas en un menú o en una nueva página.
+        display: Habilitar la ventana de presentación; esta ventana debería ser mostrada en el proyector.
+        print: Imprimir diapositivas usando una nueva ventana.
+        settings: Abrir menú de Configuraciones.
+    preview:
+      next: Siguiente
+      previous: Anterior
+    mobile:
+      update: Actualizar
+    notes:
+      label:  Notas de Showoff
+      personal: Notas Personales
+    timer:
+      label: "Contador de Tiempo:"
+      start: Iniciar
+      pause: Pausar
+      resume: Continuar
+      cancel: Cancelar
+      unit: minutos
+    pace:
+      faster: Ir Más Rápido!
+      slower: Ir Más Despacio!
+    questions: Preguntas de la Audiencia
+    annotation:
+      tools: Herramientas
+      lines: Líneas
+      shapes: Figuras
+    status:
+      label: "Diapositivas:"
+    settings:
+      label: Configuraciones
+      close: Cerrar
+      follower:
+        label: Actualizar Seguidor
+        tooltip: Enviar diapositiva de cambio de notificaciones
+        description: Cuando esta opción está habilitada, el servidor de Showoff rastreará los cambios de tu diapositiva. Deshabilítalo para ver la presentación sin causar cambios inesperados.
+      remote:
+        label: Habilitar Remoto
+        tooltip: Habilita el rastreo de otros presentadores.
+        description: Cuando esta opción está habilitada, puedes cargar la presentación en otro navegador (usualmente tu teléfono celular) para controlar la presentación.
+      layout:
+        label: Actualizar Seguidor
+        default: Diseño Estándar
+        thumbs: Mostrar miniatura de las diapositivas siguiente y anterior.
+        beside: Mostrar la siguiente diapositiva en la vista principal del presentador.
+        floating: Abrir la siguiente diapositiva en una ventana flotante.
+        confirmation: La seguridad del navegador require confirmación para abrir una ventana nueva.
+        open: Abrir Ventana
+        cancel: cancelar
+        reset:
+          label: Limpiar configuraciones de Showoff.
+          tooltip: Cambia las configuraciones de Showoff a sus valores iniciales.
+      language:
+        label: Idioma del contenido
+        tooltip: Seleccione de las traducciones disponibles o autoseleccione en función de la configuración de su navegador.
+        description: Esta presentación está disponible en diferentes idiomas. Elija el idioma que desea ver o déjelo en <tt>automático</tt> para usar la configuración de su navegador.
+    print:
+      label: Elija el tipo de notas impresas
+      description: Selecciona el contenido que quieras mostrar en las diapositivas.
+      none: No incluir notas
+      notes: Notas del presentador
+      handouts: Folletos de la audiencia
+
+  language:
+    auto: Automático
+    disable: Deshabilitar Traducciones
+
+  error:
+    file_not_found: Archivo No Encontrado!