erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-05 16:35:33 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11
spiegel-keyman/developer/docs/help/guides/lexical-models/distribute/tutorial/step-4.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
Raw Blame History

title: Step 4: Filling in package details

In the Package Editor, click on the Details tab. You should fill in as many details as you can on this page.

Package Name

The Package Name will be displayed in the package install dialog and wherever the package is referred to.

Model Version

Update the version (intial version can default to 1.0). A version number for the model and package is important - it helps your users know that they are using the most recent update of your package. The version format you should use is 1.0.

When making a major change to your lexical model package, increment the first part and set the second part to 0, e.g. from 1.0 to 2.0.

When making a bug fix or a minor update, increment the second part, e.g. from 1.0 to 1.1.

Version numbers should be in the form major.minor[.subversion]. Subversion is optional but is helpful for small bug fix releases. Each of the sections of the version should be an integer. Keyman does integer comparisons on the version numbers, so, for example, version 2.01 is regarded as older than version 2.2. Alphabetic or date formats should be avoided as the installer for the model cannot determine which version is older reliably.

Copyright

Enter copyright details for your lexical model package. Keep this reasonably short or it won't be clear for end users.

Author

Enter your name or the name of your company.

Email

Enter a contact email address where package users can contact you. If you don't want to be contacted via email, leave this field empty

Website

Enter the name of the website where you will have information about this lexical model.

Step 5: Compiling, testing and distributing a Package