spiegel-keyman/developer/docs/help/guides/lexical-models/distribute/tutorial/step-3.md
Marc Durdin b751336c13 refactor(developer): copy dev 17.0 help into repo
1. Copy help.keyman.com/developer/17.0/* into /developer/docs/help
2. Update references to 18.0 where appropriate
3. Copy all referenced images from /cdn/dev into
   /developer/docs/help/images and update links in documentation

Next commit: add deployment to help-keyman-com.sh. Note: simplest way to
test links at this point is to use the help.keyman.com auto deploy and
wait for the PR on help.keyman.com to be validated; we could look at an
internal link validation tool that verifies markdown links?

Relates-to: #12347
2024-09-16 08:46:24 +07:00

1.8 KiB


title: Step 3: Checking a package and adding files

We are finally ready to open up the Package Editor and check the package contents. In the Project Window in Keyman Developer, click the Packaging tab.

Tip

This tutorial makes a package named nrc.str.sencoten.model.kps, but you should substitute the name with your own model.

A lexical model package source file will have the extension .model.kps, and will be compiled in a file with extension .kmp.

Files

In the Package Editor, click on the Files tab.

Lexical Model Package Files

Keyman Developer already included your lexical model, welcome.htm, and readme.htm files in your package. In the Files tab, click Add to add all the additional files we discussed in the previous step to the package. For example, if your welcome or readme files use embedded files, include them in your package. You can add multiple files at once, and from multiple folders. When the package is compiled, all the files will be placed in the same folder within the package.

While keyboards can also be distributed in packages, do not include them in a lexical model package.

Lexical Models

In the Package Editor, click on the Lexical Models tab.

Lexical Model Info

Language Tag

A valid BCP 47 language tag must be set or the lexical model will not install on your mobile device. Update the list of languages you want to associate with your lexical model.

You could stop here. This would be a completely valid package, but it would not be as good as it could be. So let's continue on to the next step, and fill in some descriptions of the package.

Step 4: Filling in package details