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/context/new-project-parameters.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

2.2 KiB
Raw Blame History

title
New Project Parameters Dialog

New Project Parameters dialog

Allows you to quickly fill in common parameters for a new keyboard project, adding keyboard, package, documentation and metadata files, following the file layout used in the Keyman keyboards repository.

Projects can also be created from the command line with KMConvert.

Parameters

Keyboard Name
The descriptive name of the keyboard. This will be set in the &Name store in the keyboard, in the package name, and where appropriate in documentation and metadata.
Copyright
A copyright string for the keyboard. This will be set in the &Copyright store in the keyboard, in the package metadata, and where appropriate in documentation and metadata.
Version
The initial version number of the keyboard. This should follow the format specified in the &Keyboardversion store for the keyboard. This will be set also in the package metadata, and where appropriate in documentation and metadata.
Author
The name of the developer of the keyboard. This will be set in the package metadata, and where appropriate in documentation and metadata.
Targets
Specifies the default deployment targets for the keyboard, set in the &Targets store in the keyboard, and controls the files added to the package initially. This also is reflected in documentation and metadata.
Languages
Specifies the default BCP 47 language tags which will be added to the package metadata and project metadata.
Path
Specifies the base path where the project folder will be created. The project folder name will be the keyboard ID. If the folder already exists, then you will be prompted before Keyman Developer overwrites files inside it.
Keyboard ID
The base filename of the keyboard, project and package. This must conform to the Keyman keyboard identifier rules, using the characters a-z, 0-9 and _ (underscore) only.