Giter VIP home page Giter VIP logo

autohotkey-quick-help-xml's Introduction

AutoHotkey Help Site -- The XML

AutoHotkey Help Site is a web page that loads from an XML file to produce an interactive help experience.

The XML

The XML is the data source for the site. All questions and responces are stored in the XML file. The structure is a bit hard to understand, but would take some work to re-format.

The Format

The format of the file is a root node called 'HELP' which has any number of child OPTION elements.

Each of the OPTION elements has a NAME followed by a DATA. When the user expands an option, by clicking on the NAME, they see the DATA. They also see the NAME elements of each child OPTION.

Example

It looks like this

-help
--option
---name: TextNode Value
---data: TextNode Value
---option
----name
----data
----and so on...

The Editor

XML isn't particularly friendly. So instead you can use an editor written in AutoHotkey.

Structure

It's configured exactly like the XML file. It introduces some more user friendly features.

The Buttons

The Save and Load buttons should be pretty self explainatory. To use the New Option button, select an OPTION or the HELP node first. It will be a child of the selected node.

Testing

Upload your XML file to any web server. You can even host it on your own server. A free file host that has been tested to work is (http://autohotkey.net).

Then navigate your browser to (http://apps.aboutscript.com/ahkhelp/?xmlurl=%3Cfull-address-to-xml-file%3E) where is a publically reachable URI. For example (http://apps.aboutscript.com/ahkhelp/?xmlurl=http://autohotkey.net/~frankie/test.xml).

When you've tested it, and it it works, fork this repo and commit your file. If you can't use git, you can post a link to it here (http://www.autohotkey.com/forum/topic76455.html).

autohotkey-quick-help-xml's People

Contributors

brigand avatar uberi avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

autohotkey-quick-help-xml's Issues

Standard Question Format

Given that multiple people will be adding to the xml file, a standard format needs to be established. I see two possibilities (but am open to more).

  1. Projected 1st person

That means you format questions as if the user is asking them selves. An example would be "I want to automate a game."

  1. Author to user

This way it's the person who writes the questions that it appears to come from. For example "Do you want to automate a game?"

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.