First early version #7

hsablonniere · 2017-02-08T11:09:32Z

This is a proposition for a 0.1.0 version. It addresses #3, #4, #5 and #6.

Content of the PR

An MIT license
A new README
- Do we need the details about how notes are authored? If we do, we'll also have to think about deploying the bespoke plugin and explain that this tool only works with bespoke (for now).
A globally installable command line tool prz (instead of the npm/yarn script)
Some file cleanups (I removed a lot of files that are WIP, there are still in a branch, we'll use them later)

NOTE: Some renaming will be needed between components and the names we use in the doc (presentation console & projector viewport).

TODO (after merge)

Rename the project to ensuite/ensuite-present
Close Global CLI tool #4, Better readme #5 and We need to add a license! #6
Tag/version the release
Publish on npm

* pages * components * remote configs * channels and bus

…rst step

mojavelinux

Can we dim the next slide? Right now it's hard to distinguish the state of the two slides.

I think we should put a placeholder word when a slide has no notes, which we can do with CSS. Otherwise, I find it confusing what the cursor is pointing to. Something like "(no notes)" or "-" would work.

.notes-line:empty::after {
  content: '(no notes)';
  font-style: italic;
  opacity: 0.33;
}

I don't think we should highlight the notes on hover, or at least not so prominently. Perhaps place a border or outline to indicate the boundaries, but the dark background color is confusing.

I think the text in the notes viewer needs to be a little tighter. Here are the settings I propose:

font-size: 28px
padding: 0.5em 1em;
hanging indent: 1.25ex

I think we should hide the scrollbar on Chrome / IE using browser-specific styles. See https://github.com/opendevise/presentation-bespoke-starter/blob/master/src/styles/bespoke-modes.styl#L2-L3

I'd like to have a button to hide the timer bar, but that can be part of a follow-up release.

mojavelinux · 2017-02-13T22:40:04Z

README.adoc


-This project is a Work In Progress
+_ensuite-present_ is part of the *ensuite* toolbelt dedicated to trainers and speakers.


Let's call it a toolkit.

mojavelinux · 2017-02-13T22:40:46Z

README.adoc

+
+== Overview
+
+_ensuite-present_ is a local Web app that allows an instructor to "open" and control a slide-deck.


Let's lowercase Web here. There are different opinions, but I think it makes it more readable.

I had to try

mojavelinux · 2017-02-13T22:45:43Z

README.adoc

+
+To run _ensuite-present_ on your machine, you just need to run this command:
+
+ $ prz


I know I keep going back and forth on this, but I wonder if we should name it prez, es-prez, or es-present instead of prz. Seeing it alone here kind of gives me a feeling of wanting to change the name. We don't have to get it right for this release, just something to think about before 1.0.0.

I would defer that to another release.

I'm happy to defer. My brain is really getting attached to "enpres" though. But no need to rush it. We have time to let it soak.

mojavelinux · 2017-02-13T22:59:04Z

bin/ensuite-present.js

+const http = require('http')
+const nodeStatic = require('node-static')
+
+const PORT = 4242


4242 is the port used by Awestruct. I think we should use 4320 instead (since we're proposing 4321 for the bespoke generator).

I still think bespoke should propose a pseudo-random port but that's another disussion 😄

We'll make 4320 configurable in later releases.

mojavelinux · 2017-02-13T22:59:35Z

bin/ensuite-present.js

+const fileServer = new nodeStatic.Server()
+
+http
+  .createServer((request, response) => {


When installed, this seems to be serving files from the bin directory instead of from ensuite-present.

We need something like:

const fileServer = new nodeStatic.Server(path.dirname(path.dirname(require.resolve('ensuite-present'))))

I implemented it like this:

const webRoot = path.resolve(__dirname, '..') const fileServer = new nodeStatic.Server(webRoot)

mojavelinux · 2017-02-13T23:32:19Z

Do we need the details about how notes are authored?

Not at this time. Perhaps just make a brief reference to https://github.com/asciidoctor/asciidoctor-bespoke#speaker-notes and that more info is coming.

mojavelinux · 2017-02-13T23:42:46Z

I think we should simplify the page URLs. Right now it's:

pages/slide-deck-viewer/slide-deck-viewer-page.html
pages/teleprompter-console/teleprompter-console-page.html

I think this could be simplified to:

pages/viewer/index.html
pages/console/index.html

I also think the query string parameter should be shorten from slide-deck-url to load or deck or url.

mojavelinux · 2017-02-14T00:22:14Z

Another idea for the tool names is to prefix them with "en" and replace "suite" with the name of the tool. For example, "enpres". Roughly translated, that means something related to a business venture in some languages, which is somewhat interesting.

I may be overthinking this. Names tend to create that problem.

I had to improve a bit the trimming/filtering of the notes.

mojavelinux · 2017-02-15T21:46:13Z

Okay, I see that ex and ch are different, but can act the same depending on the font (if x height matches 0 width, which is true in some cases). I'm 100% in support for ch for this usage.

mojavelinux · 2017-02-15T21:48:48Z

I like the new page names and the router. Perfect.

I see more than one console in the future so I added teleprompter.

Once we get to that point, we can certainly rename pages. As you said, the user goes to where we tell them to go, so it's not a huge deal to rename pages in the future. And when the use case comes up, it should be clear what names we need to use.

mojavelinux · 2017-02-16T08:42:59Z

I made a small update so that the left border on the notes does not show for the current notes since they are already highlighted in yellow.

I also changed to the more subtle VIM-style no content. (Just a tilde).

hsablonniere · 2017-02-16T15:41:06Z

I rewrote history to remove a forgotten comment in the VIM style commit.

hsablonniere · 2017-02-16T15:41:53Z

I think we'll have to improve implementation on:

The "router" obviously
The __dirname try/catch

mojavelinux · 2017-02-17T06:45:16Z

I agree the calculation of the web root is not pretty. However, it currently allows the script to work in dev mode (from inside the repository) or installed mode (installed as a bin script with a loadable module). If there's a way to do this correctly in the node/npm ecosystem, I'd love to know. However, I could not find a way other than what I came up with. The catch will never be hit in installed mode, so for me that's pretty safe.

Btw, it's typical to use this trick in the Ruby ecosystem, so for me it's natural. One other approach is to try to detect if the script is relative to another known file. If so, we know what mode we're in.

mojavelinux · 2017-02-17T06:46:14Z

My statement about ch units above was incorrect. I was a victim of my own optical illusion. As it turns out, the characters on different lines are, in fact, lining up correctly.

mojavelinux · 2017-02-17T06:46:36Z

I looks like we're still missing a tag in the repository. Can you add it?

hsablonniere · 2017-02-17T08:51:12Z

😱 Oops, I pushed it to my forked instead of this remote.

https://github.com/ensuite/ensuite-present/releases/tag/v0.1.0

hsablonniere · 2017-02-17T08:52:48Z

I agree the calculation of the web root is not pretty. However, it currently allows the script to work in dev mode (from inside the repository) or installed mode (installed as a bin script with a loadable module). If there's a way to do this correctly in the node/npm ecosystem, I'd love to know. However, I could not find a way other than what I came up with. The catch will never be hit in installed mode, so for me that's pretty safe.

We'll hack a look later. As we said many times (or will say): "make it until your improve it!".

hsablonniere added 17 commits October 29, 2016 02:57

first commit with main design concept in place

a319004

* pages * components * remote configs * channels and bus

change notes indent to exactly 2 characters

6d8a934

add architecture diagram

d4964fa

add missing remotes

c5f4157

start stopwatch and timer at the same time (sfc30)

6850df0

add ratio controls (keyboard)

d71c363

add special move (logitech remote)

a3a9b24

improve footer readability

7172a3d

display black screen when viewer needs to display something before fi…

6d3cd32

…rst step

improve notes readability

5cecce8

fix notes scroll position on resize

a22a105

add notes, questions and thoughts

30eb75a

cleanup files that aren't necessary (for now) for the release

94d0c4d

replace npm script with proper globally installable CLI tool

c101013

add the MIT license ;-)

b462b45

enrich the README with more instructions and context

6ed6575

add restrictions on node/npm versions

4b7eea8

hsablonniere requested a review from mojavelinux February 8, 2017 11:09

hsablonniere self-assigned this Feb 8, 2017

hsablonniere mentioned this pull request Feb 8, 2017

First implementation proposition #2

Closed

mojavelinux requested changes Feb 13, 2017

View reviewed changes

hsablonniere added 6 commits February 14, 2017 11:37

make empty notes visible with a half transparent "(no notes)" line

f9afb82

I had to improve a bit the trimming/filtering of the notes.

change visual indicator of hovered note to a left border

5e33e2c

compact notes a bit

a4cca2f

typos and quick fix in readme

f1e2ede

change port from 4242 to 4320

3775942

fix path from where static web files are served

fc79e9f

hsablonniere force-pushed the first-early-version branch from f0da8f4 to 9ebeb2e Compare February 15, 2017 18:32

hsablonniere mentioned this pull request Feb 15, 2017

Project & tool naming #3

Open

mojavelinux added 2 commits February 16, 2017 01:03

update package description

f4bd7ac

reduce border around slides

318f955

mojavelinux added 11 commits February 16, 2017 16:36

set color instead of opacity for empty notes; use VIM-style blank line

fe15238

don't add hover border for current notes; make border lighter

5d8f378

remove space in shebang line

4417c3a

set web root correct when running from local installation

8991ddb

fix URL router

1c0f034

print URLs to viewer and console on start

f5f7a69

update description of ensuite

610947c

update package description

4eb1b1c

apply revisions to README

2abc564

change bin name to enprez

319a17f

fix titles of windows

7cdc474

hsablonniere force-pushed the first-early-version branch from 9478a07 to 7cdc474 Compare February 16, 2017 15:40

hsablonniere merged commit 73acfb5 into ensuite:master Feb 16, 2017

hsablonniere deleted the first-early-version branch February 16, 2017 15:42

This was referenced Feb 16, 2017

Better readme #5

Closed

We need to add a license! #6

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

First early version #7

First early version #7

hsablonniere commented Feb 8, 2017 •

edited by mojavelinux

Loading

mojavelinux left a comment •

edited

Loading

mojavelinux Feb 13, 2017

mojavelinux Feb 13, 2017

hsablonniere Feb 14, 2017

mojavelinux Feb 13, 2017

hsablonniere Feb 14, 2017

mojavelinux Feb 15, 2017

mojavelinux Feb 13, 2017

hsablonniere Feb 14, 2017

hsablonniere Feb 14, 2017

mojavelinux Feb 13, 2017

mojavelinux Feb 13, 2017 •

edited by hsablonniere

Loading

hsablonniere Feb 14, 2017

mojavelinux commented Feb 13, 2017

mojavelinux commented Feb 13, 2017

mojavelinux commented Feb 14, 2017

mojavelinux commented Feb 15, 2017

mojavelinux commented Feb 15, 2017

mojavelinux commented Feb 16, 2017

hsablonniere commented Feb 16, 2017

hsablonniere commented Feb 16, 2017

mojavelinux commented Feb 17, 2017

mojavelinux commented Feb 17, 2017

mojavelinux commented Feb 17, 2017

hsablonniere commented Feb 17, 2017 •

edited

Loading

hsablonniere commented Feb 17, 2017


		This project is a Work In Progress
		_ensuite-present_ is part of the ensuite toolbelt dedicated to trainers and speakers.


		== Overview

		_ensuite-present_ is a local Web app that allows an instructor to "open" and control a slide-deck.


		To run _ensuite-present_ on your machine, you just need to run this command:

		$ prz

First early version #7

First early version #7

Conversation

hsablonniere commented Feb 8, 2017 • edited by mojavelinux Loading

Content of the PR

TODO (after merge)

mojavelinux left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mojavelinux Feb 13, 2017 • edited by hsablonniere Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mojavelinux commented Feb 13, 2017

mojavelinux commented Feb 13, 2017

mojavelinux commented Feb 14, 2017

mojavelinux commented Feb 15, 2017

mojavelinux commented Feb 15, 2017

mojavelinux commented Feb 16, 2017

hsablonniere commented Feb 16, 2017

hsablonniere commented Feb 16, 2017

mojavelinux commented Feb 17, 2017

mojavelinux commented Feb 17, 2017

mojavelinux commented Feb 17, 2017

hsablonniere commented Feb 17, 2017 • edited Loading

hsablonniere commented Feb 17, 2017

hsablonniere commented Feb 8, 2017 •

edited by mojavelinux

Loading

mojavelinux left a comment •

edited

Loading

mojavelinux Feb 13, 2017 •

edited by hsablonniere

Loading

hsablonniere commented Feb 17, 2017 •

edited

Loading