# point-and-tell

> Help system / page guide

Latest version **1.0.0** (published 2017-04-13) · ISC license · 0 weekly downloads

## Install

```sh
npm install point-and-tell
pnpm add point-and-tell
yarn add point-and-tell
bun add point-and-tell
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2017-04-13 |
| First published | 2017-04-13 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | 011systems |
| Maintainers | 011systems |
| Keywords | help, guide |

## Links

- npm: https://www.npmjs.com/package/point-and-tell
- Repository: https://github.com/011Systems/point-and-tell
- Homepage: https://github.com/011Systems/point-and-tell#readme
- Issues: https://github.com/011Systems/point-and-tell/issues
- npm.io page: https://npm.io/package/point-and-tell

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2017-04-13

## README

# point-and-tell

  Help system / page guide

## Installation

  ```
  <script src="PATH_TO_FILE/Help.js"></script>
  ```
## Usage

  In your .js file init library
  ```
  var help = new Help();
  help.init();
  ```
  Connect HTML element with content from help.md
  ```
  Help.Attach(ELEMENT, CONTENT_ID_FROM_MD_FILE);
  ```
  add button to HTML to activate point-and-tell
  <button onclick="help.activate().helpEvent(null);">HELP</button>

## Hello World Example - check directory 'example'
  index.html
  ```
  <!DOCTYPE html>
  <html lang="en">
  <head>
    <title>Example</title>
    <link href="https://fonts.googleapis.com/css?family=Lato:400,700" rel="stylesheet">
    <link href="../Help.css" rel="stylesheet">
    <link href="example.css" rel="stylesheet">
  </head>
  <body>
  <button class="helpButton" onclick="help.activate().helpEvent(null);" id="help">HELP</button>
  <header>
    <div class="container">
      <h1 id="pageTitle">Page Title</h1>
    </div>
  </header>
  </div>
  <script src="../Help.js"></script>
  <script>
    var pageTitle = document.getElementById('pageTitle');
    Help.Attach(pageTitle, 'pageTitle');
    var help = new Help();
    help.init();
  </script>
  </body>
  </html>
  ```
  help.md
  ```
  #help
  = Help System

  <div style='background:beige'>
  Click [:Info->Help:] or hit |F1| to activate help.
  Then hover mouse over views and controls to get help for that element.
  Click anywhere outside this box or hit any button to deactivate help.
  </div>

  ---

  Short Help System Description

  == Getting Started

  About Help System Copy


  #help::mobile
  = Help System Mobile

  Tap on an element to get help for that element.

  #pageTitle
   = Page Title

  Page Title
  ```
## License
### ISC
https://en.wikipedia.org/wiki/ISC_license

---
_Source: https://npm.io/package/point-and-tell · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._