-
-
Notifications
You must be signed in to change notification settings - Fork 135
docs(developer): Add Developer walkthrough tutorial #15447
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
0844780
441a385
13626ff
8f36d07
aa6f6d2
0373122
c10a74c
1207a01
4abe55c
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,87 @@ | ||||||||
| --- | ||||||||
| title: Introduction | ||||||||
| --- | ||||||||
|
|
||||||||
| <link href='walkthrough.css' rel='stylesheet'> | ||||||||
| <div class="walkthrough-navigation" markdown="1"> | ||||||||
| Introduction to the [Keyman Developer Walkthrough](.). | ||||||||
|
|
||||||||
| [Next: Part 1 - Creating a Keyboard Project →](01-creating-keyboard-project) | ||||||||
| </div> | ||||||||
|
|
||||||||
| ## Step-by-Step | ||||||||
|
|
||||||||
| The Step-by-Step tutorial starts with an introduction to the Keyman Developer program and instructions on installing it. Then use the link to advance to the next topic and complete the Step-by-Step section there. Continue on through all the topics, completing the Step-by-Step section and moving on to the next topic by using the link at the end of each Step-by-Step section. | ||||||||
|
|
||||||||
| If you encounter unfamiliar terms, please consult the [glossary](glossary). | ||||||||
|
|
||||||||
| ### Introducing Keyman Developer | ||||||||
|
|
||||||||
| Keyman Developer is a powerful tool you can use to create custom software keyboards optimized to type in any language you choose. Keyboard authors can distribute their work for desktop, web, tablet and phone, enabling global communities to quickly benefit from keyboards made for their own language. | ||||||||
|
|
||||||||
| Keyboards created with Keyman Developer can be used on Windows, macOS, Linux, iOS, Android, and the web. | ||||||||
|
|
||||||||
| This tutorial focuses on the Keyman Developer IDE (integrated development environment). | ||||||||
| Currently this software is Windows-only, although the command line tools it uses can run on other platforms (such as Linux and macOS). | ||||||||
|
|
||||||||
| ### Installing Keyman Developer | ||||||||
|
|
||||||||
| Keyman Developer is completely free to download and use. You can download it from [https://keyman.com/developer/download](https://keyman.com/developer/download). | ||||||||
|
|
||||||||
| On the downloads page, just click the big green “Download Now” button to get the latest version of Keyman. Once you have it, run the `keymandeveloper-a.b.c.exe` file you’ve downloaded. The numbers following “keymandeveloper” indicate which version of Keyman Developer you are installing; you can also see the Keyman Developer version in the main installer window, or after installation, in the Help/About dialog. | ||||||||
|
|
||||||||
| After installing Keyman Developer, you should be able to run it on your computer and begin creating projects immediately. | ||||||||
|
|
||||||||
| Note that Keyman Developer is a separate app from Keyman, which is the app that lets you use any keyboard created with Keyman Developer. | ||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We can style "notes" like
Suggested change
and would look like
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. When the text came out of Notion, some of the notes were marked with HTML, others with the
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, let's worry about integration before minor styling details
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. fair enough. I was just looking to have consistency in the styling across the site. But yeah can focus on content now |
||||||||
| In order to use the keyboard you create with Keyman Developer, you'll need to have the Keyman app installed on your computer or device. | ||||||||
| Keyman is available on the following platforms: Windows, macOS, Linux, iOS, Android, and the web. | ||||||||
|
|
||||||||
| The Keyman Developer icon  is a faded version of the Keyman icon . | ||||||||
|
|
||||||||
| <div class="walkthrough-navigation" markdown="1"> | ||||||||
| To continue the Step-by-Step tutorial move to the next page: [Part 1 - Creating a Keyboard Project](01-creating-keyboard-project) | ||||||||
| </div> | ||||||||
|
|
||||||||
| --- | ||||||||
|
|
||||||||
|
|
||||||||
| ## Engaging with the Keyman Community and Resources | ||||||||
|
|
||||||||
| Keyman Developer also has an active community and documentation for each major release of the app. If you need any additional help, be sure to visit the following resources for information: | ||||||||
|
|
||||||||
| ### Keyman Community Forum | ||||||||
|
|
||||||||
| Ask questions and talk with other keyboard authors on the [Keyman Community Forum](https://community.software.sil.org/c/keyman/19) | ||||||||
|
|
||||||||
| ### Keyman online help | ||||||||
|
|
||||||||
| [Keyman Developer Language Guide](https://help.keyman.com/developer/language/guide/) | ||||||||
|
|
||||||||
| Information about the general structure and concepts of the Keyman language. | ||||||||
|
|
||||||||
| [Keyman Developer Language Reference](https://help.keyman.com/developer/language/reference/) | ||||||||
|
|
||||||||
| Reference for keywords and other components of the Keyman language. | ||||||||
|
|
||||||||
| [Keyman Developer Training Videos](https://help.keyman.com/developer/videos) | ||||||||
|
|
||||||||
| Videos from past Keyman Developer workshops hosted by the team. | ||||||||
|
|
||||||||
| ### Keyman Blog | ||||||||
|
|
||||||||
| Read up on Keyman’s latest releases and patch notes on the [Keyman Blog](https://blog.keyman.com/). | ||||||||
|
|
||||||||
| ### Keyman GitHub repositories | ||||||||
|
|
||||||||
| Keyman uses a number of [Github](https://github.com/keymanapp) repositories to store source code, keyboards, lexical models and documentation. | ||||||||
| There is also a mechanism for reporting problems. [Keyman Bug Reports](https://github.com/keymanapp/keyman/issues) | ||||||||
|
|
||||||||
| Report Keyman software bugs and issues here. | ||||||||
|
|
||||||||
| > [!NOTE] | ||||||||
| > GitHub issues are not the best place to ask for help or support questions. The Keyman community forum is a better place to ask for help with keyboard development. Think you’ve found a Keyman bug or a problem with a specific keyboard? Describe what you’ve found on the Keyman community forum and ask whether to report a bug. | ||||||||
|
|
||||||||
| <div class="walkthrough-navigation" markdown="1"> | ||||||||
| [Next: Part 1 - Creating a Keyboard Project →](01-creating-keyboard-project) | ||||||||
| </div> | ||||||||
|
|
||||||||

There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we make all the help.keyman.com links relative?
like
/developer/downloadand all the
/developer/17.0//developer/18.0/links become/developer/current-version/There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is not a relative link. But relative links on help.keyman.com are a good idea with /developer/current-version in order to avoid linking people into old content (and it also means if content shifts around, we will be prompted to update the tutorial accordingly).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tried to follow @mcdurdin 's advice on links, but could easily have goofed it up!