A Paragraph-oriented Document Presentation System

Overview

Paradocs is a paragraph-oriented document presentation system. It is designed to create presentation slides having lots of text materials in the traditional paragraph-writing format. In a typical use of paradocs, one slide contains one paragraph. Every click of a key moves the text highlight forward, sentence by sentence so that both the presenter and the audience are always certain about which part of the text on the screen is being discussed.

Paradocs is capable of pronouncing sentences in many different languages thanks to the Text-to-Speech functionality of modern web-browsers such as Chrome, Firefox, and Safari. When a speaker icon appears on the top of the page, you can click on the icon (or press the . key) to play a TTS read-aloud of the current text fragment.

Paradocs is created by Yoichiro Hasebe using reveal.js, an awesome javascript presentation library by Hakim El Hattab.


Use Paradocs

Input
==== header: Paradocs Demo footer: https://yohasebe.com/paradocs ---- ## Paradocs | A Paragraph-oriented Document Presentation System ---- ### Types of Blocks ---- #### Regular Paragraph This is regular text. Sentences in static text are highlighted when focused. They are printed in grey when not focused. ---- #### Static Paragraph | This is static paragraph. | Sentences in static text are not highlighted | They are always printed in black. ---- #### Unordered List * Unordered list item 1 * Unordered list item 2 * Unordered list item 3 ---- #### Ordered List 1. Ordered list item 1 2. Ordered list item 2 3. Ordered list item 3 a. Ordered list item 1 b. Ordered list item 2 c. Ordered list item 3 ---- #### Numbered Block 365. The number in a numbered block will be printed only once; the left-hand side of the text can have multiple lines the lines are aligned nicely ---- ### Decoration and Annotation ---- #### Text Decoration Bold: *bold* Italic: _italic_ Underline: __underline__ Marker: **marker** ---- #### Annotation This is part of main text. {note: This is a note item} This is also part of main text. {note: This is another note item} ---- #### Quiz | * In static text block, words and phrases in {curly} brackets | * are rendered with overlaying {box} elements | * so that you can create {quizzes} for the audience ---- ### Additional Features ---- #### Header/Footer header: This is header text footer: This is footer text The header↑ and footer↓ can be defined anywhare in the document. The header/fotter text will persist unless a new definition has been made. ---- #### Embed Images ---- image: https://upload.wikimedia.org/wikipedia/commons/thumb/6/69/Human_evolution.svg/1000px-Human_evolution.svg.png ---- #### Embed YouTube Video ---- youtube: https://www.youtube.com/watch?v=Ks-_Mh1QhMc ---- | This is the end of the demo. | Thanks! | https://yohasebe.com/paradocs ====
Textarea is vertically resizable
Font Size
 

Visual Illustration of Paradocs



Figure 1: Overview of Paradocs: input and output


Figure 2: Including different types of blocks in one slide

Key Bindings

  • Move to the next sitem (sentence/list-item/image/video/slide/etc.)
  • Move back to te previous item (sentence/list-item/image/video/slide/etc.)
  • SPACE is also available to move forward
  • j and k are also available to move forward and backword

 

  • Move to next document
  • Move back to previous document

 

  • . Play/Stop read-aloud of videos and audio clips
  • / Enter/Exit screen blackout
  • ESC Enter/Exit overview of slides

TIP

Logitech Wireless Presenter R400/R800, presentation wireless presenter with laser pointer, is highly recommended to be used with Paradocs. "Move next/previous", "read-aloud" and "overview" are operable with physical buttons.


Basic Concepts

  • A document is delimited by four (or more) equal signs and a carriage return ====↩*. A document contains slides.
  • A slide is delimited by four (or more) hyphensa carriage return ----↩. A slide contains blocks.
  • A block is delimited by a blank line ↩↩.
  • A paragraph is a type of block. A paragraph consists of a set of sentences.
  • A sentence is delimited by a carriage return .

* Document delimiters are optional when there is only one document.

Sentences

Pattern

----
Sentence #1 
Sentence #2  
Sentence #3 
----

Blocks

Pattern

----
Block #1
Block #2  

Block #2 
Block #2 
----

Slides

Pattern

----
Slide #1
----
Slide #2
----
Slide #3
----

Documents

Pattern

====
Document #1
====
Document #2
====
Document #1
====

Types of Blocks

Headings

Example

----
# Heading 1 

## Heading 2 

### Heading 3 
----

Regular Paragraphs

Example

This is regular paragraph. 
Sentences in static text are highlighted when focused. 
They are printed in grey when not focused. 

Static Paragraphs

Example

| This is static paragraph. 
| Sentences in static text are not highlighted 
| They are always printed in black. 

or

| This is static paragraph. 
  Sentences in static text are not highlighted 
  They are always printed in black. 

N.B. White spaces on the left-hand side matter.

Unordered Lists

Example

* Unordered list item 1
* Unordered list item 2 
* Unordered list item 3 

Ordered Lists

Example

1. Ordered list item 1
2. Ordered list item 2
3. Ordered list item 3

a. Ordered list item 1
b. Ordered list item 2
c. Ordered list item 3

Numbered Blocks

Example

365. The number in a numbered block will be printed only once; 
     the left-hand side of the text can have multiple lines 
     the lines are aligned nicely

N.B. White spaces on the left-hand side matter.


Decoration and Annotation

Text Decoration

Example

Bold: *bold*

Italic: _italic_

Underline: __underline__

Marker: **marker**

Annotation

Example

This is part of main text. {note: This is a note}
This is also part of main text. {note: This is another note}

N.B. Annotation with note command is available only in regular paragraphs and ordered/unordered lists.

Quizzes

Example

| In a static context, words and phrases in {curly brackets}
| will be rendered as {quize items} overlayed by an opaque box.

Additional Features

Header/Footer

Example

header: This is header text
footer: This is footer text

N.B. The header and footer stay over slides until they are overridden.

Embed Images

Pattern

image: url_to_your_image_file.png

or

img: url_to_your_image_file.png

Embed YouTube Video

Example

youtube: https://www.youtube.com/watch?v=Ks-_Mh1QhMc

or

yt: https://www.youtube.com/watch?v=Ks-_Mh1QhMc

N.B. A YouTube video iframe is embeded when youtube/yt command is the only item (block) of the slide. Otherwise, a clickable link is created instead.

Embed MP4 Video

Pattern

video: url_to_your_video_file.mp4

N.B. A video iframe is embeded when video command is the only item (block) of the slide. Otherwise, a clickable link is created instead.

Embed MP3 Audio

Pattern

audio: url_to_your_audio_file.mp3