infodisplay

command module
v0.0.0-...-4adec02 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 19, 2026 License: AGPL-3.0 Imports: 11 Imported by: 0

README

demo

Info Display

Go Report Card

go install github.com/benraz123/infodisplay@latest 

What

the purpose of infodisplay is to generate a looping slideshow that can easily incorporate dynamic data like the current time and other things with javascript that runs in the browser.

Infodisplay uses a custom format that aims for simplicity and terseness.

Here is an example that shows one slide, with a header and 3 bullet points:

Header
- Bullet One
- Bullet Two
- Bullet Three

The first non-bullet point line is inferred to be a header.

This slide would also work, showing one headerline and a text line below it:

Header
Text Line

A system of directives is used for more functionality. For example, to make a slide with the id "hello", a custom duration of 5 seconds, and including a custom image "image.png", write:

!id hello
!time 5
!image image.png
Header
Text Line

Slides are seperated by whitespace. Thus this makes two slides:

Slide One
- Hello
- World

Slide Two
Foo
Bar

You can also use << >> to embed a live clock:

Today is <<%A>>
- Current hour: <<%H>>

And you can use * * for bold text:

This text is *bold*

Most slides have one header, but you can change that by using the !title layout

!title
Header One
Header Two

A slideshow can also have one or more global blocks which can have the following directives:

Attr Purpose
!time Global slide duration
!exec Script to be run when presentation loops (for more see infodisplay -R!exec
!styles Stylesheet to be used
!pfoot Primary Footer
!sfoot Secondary Footer
!noautoplay Dont run the presentation automatically

Running a file

infodisplay <in> -o <out>

Getting Help

infodisplay --help

to get help

infodisplay -r

to get a list of directives

or

infodisplay -R <specific directive>

Feature Checklist

  • Get stable working version
  • Add support for comments
  • Add support for slides with both bullet points and normal lines
  • Add richer formatting
    • Italic
    • Bold
    • Code

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL