{"id":13549204,"url":"https://github.com/regebro/impress-console","last_synced_at":"2025-04-13T00:36:41.485Z","repository":{"id":2861287,"uuid":"3866184","full_name":"regebro/impress-console","owner":"regebro","description":"Speaker notes for impress.js","archived":false,"fork":false,"pushed_at":"2018-10-06T17:34:40.000Z","size":957,"stargazers_count":134,"open_issues_count":3,"forks_count":27,"subscribers_count":16,"default_branch":"master","last_synced_at":"2025-04-13T00:36:36.761Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/regebro.png","metadata":{"files":{"readme":"README.rst","changelog":"HISTORY.txt","contributing":null,"funding":null,"license":"license.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-03-29T13:14:08.000Z","updated_at":"2025-03-08T07:48:19.000Z","dependencies_parsed_at":"2022-09-08T11:11:52.060Z","dependency_job_id":null,"html_url":"https://github.com/regebro/impress-console","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regebro%2Fimpress-console","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regebro%2Fimpress-console/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regebro%2Fimpress-console/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regebro%2Fimpress-console/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/regebro","download_url":"https://codeload.github.com/regebro/impress-console/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248650415,"owners_count":21139671,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T12:01:19.376Z","updated_at":"2025-04-13T00:36:41.465Z","avatar_url":"https://github.com/regebro.png","language":"JavaScript","readme":"impress-console is now a part of impress.js\n===========================================\n\nFurther development is done at https://github.com/impress/impress.js/\nThis repository will remain here for backwards compatibility.\n\n\nimpress-console\n===============\n\n.. image:: https://github.com/regebro/impress-console/raw/master/screenshot_thumb.png\n   :align: right\n   :target: https://github.com/regebro/impress-console/raw/master/screenshot.png\n\nThis module provides a speaker console for impress.js. It shows speaker\nnotes, a small view of the current slide, a preview of the next slide in\norder, a clock and a resettable timer.\n\nThis started as an update of David Souther's notes.js, but is now not longer\nrecognizable as such, but some parts of his code may remain.\n\nIt can be seen in action at http://regebro.github.io/hovercraft/\n\n\nUsage\n=====\n\nTo use it put impressConsole.js in the js directory under your presentation,\nand put impressConsole.css in the css directory under your presentation. The\nconsole will look for css/impressConsole.css, so you need to locate it there.\n\nThen add the following to the bottom of your presentation HTML::\n\n    \u003cscript src=\"js/impressConsole.js\"\u003e\u003c/script\u003e\n\nAnd add this to the script where you call impress.init()::\n\n    impressConsole().init();\n\nYou can then open the speaker window with the \u003cP\u003e key. You can also open it\nautomatically with::\n\n    impressConsole().open();\n\n\nAll in all, the impress.js initialization at the end of the file hence should\nlook something like this::\n\n    \u003cscript src=\"js/impress.js\"\u003e\u003c/script\u003e\n    \u003cscript src=\"js/impressConsole.js\"\u003e\u003c/script\u003e\n    \u003cscript\u003e\n        impress().init();\n        impressConsole().init();\n        impressConsole().open(); // If you want them to open automatically\n    \u003c/script\u003e\n\nThe timer at the bottom of the screen starts automatically, and will reset if\nyou click on it.\n\n\nAdding notes\n============\n\nYou add presenter notes to your impress.js presentation by simply\nadding a \u003cdiv class=\"notes\"\u003eThe notes go here\u003c/div\u003e to any\nstep/slide that you want to have notes. The contents of that \u003cdiv\u003e\nwill be picked up by the console.\n\nYou will also need to hide these notes with CSS in the main presentation.\nYou can for example include the following rule in your CSS::\n\n   .step .notes {\n     display: none;\n   }\n\n\nNavigation\n==========\n\nThe main key to move \"forward\" is \u003cspace\u003e. It will move to the next slide,\nunless there is more text in the Notes window than can be displayed without\nscrolling. If there is, it will instead scroll down one page.\n\n\u003cright\u003e, \u003cdown\u003e and \u003cpage down\u003e will move to the next slide, even when the\ntext needs scrolling. \u003cleft\u003e, \u003cup\u003e and \u003cpage up\u003e will move to the previous\n\u003cslide.\n\n\u003cg\u003e Will ask for a slide number and then move to that slide.\n\nThe preview is based on the assumption that the presentation is linear and\nthat the next slide is well, the next slide. If it isn't and you move around\nthe presentation by clicking with the mouse, then the preview will not be\nvery useful, for obvious reasons.\n\n\nAdvanced Usage\n==============\n\nThe default css file location is ``css/impressConsole.css``, but you can now\npass in a css parameter to ``init()`` to change this::\n\n    impressConsole().init(css=\"/path/to/my.css\");\n\nYou can also add special css that will only affect the presentation previews.\nThis is only necessary if you for some reason need to have different styles in\nthe previews and the actual presentation.\n\n    impressConsole().init(cssPreview=\"/path/to/myPreview.css\");\n\nYou can now also easily register extra key-events with the\n``registerKeyEvent()`` function. This is just a convenience method, but it is\nconvenient. The function takes three parameters, of which the last one is\noptional, the first is a list of key values that should trigger the event,\nthe second is the function that should be called, and the third is the window\nthe even should be bound to. This defaults to the console window.\n\nThis code will make the \u003cN\u003e key (value 78) call the showSlideNumbers function\nfor both the console window and the main window::\n\n      impressConsole().registerKeyEvent([78], showSlideNumbers);\n      impressConsole().registerKeyEvent([78], showSlideNumbers, window);\n\n\nCredits\n=======\n\n* Alberto Sartori and Frederik Möllers for additions to what became 1.4.\n\n* Heiko Richler, Aico.Richler@gmx.net, major changes in rev. 1.3\n\n* Lennart Regebro, regebro@gmail.com, main author of impressConsole\n\n* David Souther, davidsouther@gmail.com, author of the original notes.js\n","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fregebro%2Fimpress-console","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fregebro%2Fimpress-console","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fregebro%2Fimpress-console/lists"}