From cf6665e2ce4d2ab19591bdba7cb1dde99fe9133f Mon Sep 17 00:00:00 2001 From: Meng-Heng Date: Thu, 13 Jun 2024 13:13:27 +0700 Subject: [PATCH] docs(developer): context help for new project parameters in keyman developer Fixes: #2131 --- developer/src/tike/xml/help/contexthelp.xml | 86 +++++++++++++++++++++ 1 file changed, 86 insertions(+) diff --git a/developer/src/tike/xml/help/contexthelp.xml b/developer/src/tike/xml/help/contexthelp.xml index 62bd8677ae..0c338aba98 100644 --- a/developer/src/tike/xml/help/contexthelp.xml +++ b/developer/src/tike/xml/help/contexthelp.xml @@ -710,4 +710,90 @@

To close the dialog, click the Close button or press Shift + Esc.

+ + +
+ +

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.

+
+ +

A brief or long description about the keyboard's functionality, background, script, language, community, + or any information related to showcase to users.

+
+ +

The name of the developer of the keyboard. This is either your full name or + the organization you're creating the keyboard for.

+
+ +

This field should contain the word "Copyright", the copyright symbol "©", and the full name of the rights + owner. Do not put the year of copyright in this field (see Full Copyright). Typically, + you can use the automatically generated default value: "Copyright © Your Full Name or + Your Organization".

+

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.

+
+ +

Who owns the rights to this keyboard? This field should + contain the word "Copyright", the copyright symbol "©", the first year of copyright, + and the full name of the rights owner. Do include the year of copyright in this field. + Typically, you can use the automatically generated default value: + "Copyright © Current-Year Your-Full Name or Your Organization".

+
+ +

If this is the first time you've created a keyboard for the language, you should + leave the version as 1.0. Otherwise, your version number must conform to the following + rules: A version string made of major revision number.minor revision number.

+
+ +

+ 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. +

+
+ +

+ 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. +

+
+ +

+ Specifies a different path to store the project folder. +

+
+ +

+ 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. +

+
+ +

+ A Keyboard Project (.kpj) file is store inside the base path, this cannot be changed to anywhere else. +

+
+ +

This button will open up the BCP 47 Tag window to add the keyboard's language tag, script tag, + region tag, and language name.

+
+ +

+ Click on Edit... to open up the BCP 47 Tag window with the language information. +

+
+ +

+ Delete the selected language. +

+
+ +

+ Once everything is ready, click OK and enjoy developing the keyboard. +

+
+ +

Click Cancel to close the dialog and reset the process entirely.

+
+
\ No newline at end of file