erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-05 00:15:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

docs(developer): update New Project Parameters dialog

Browse source 
Update the Description, refresh other fields, and use the new dialog
layout.
This commit is contained in:
Marc Durdin 2025-09-01 14:10:15 +02:00
parent d61bcf23da
commit a9ed458bdc
3 changed files with 92 additions and 39 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

95
developer/docs/help/context/new-project-parameters.md
View file

@ -14,46 +14,79 @@ Projects can also be created from the command line with
### Parameters
Keyboard Name
: The descriptive name of the keyboard. This will be set in the
[`&Name`](/developer/language/reference/name) store in the keyboard,
in the package name, and where appropriate in documentation and
metadata.
: The name of the keyboard presented to end users. This will be set in the
[`&Name`](/developer/language/reference/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`](/developer/language/reference/copyright) store in the
keyboard, in the package metadata, and where appropriate in
documentation and metadata.
Choose the keyboard name carefully; while it is possible to change it later,
you will have to update the name in a number of locations.
Version
: The initial version number of the keyboard. This should follow the
format specified in the
[`&Keyboardversion`](/developer/language/reference/keyboardversion)
store for the keyboard. This will be set also in the package
metadata, and where appropriate in documentation and metadata.
Description
: This field should describe your keyboard to people who find it online. It
should explain the purpose of the keyboard in a friendly, descriptive way.
The description could include details that will help users to decide if this
keyboard is the appropriate choice for their needs.
: The first paragraph of the description will appear in the keyboard search
result on keyman.com; the full description will be shown in the keyboard
details page on keyman.com. Use
[Markdown](https://www.markdownguide.org/basic-syntax) to include basic
formatting, but not embedded HTML is not allowed.
: To add images to the description, you will need to reference an image on a
server accessible online. For example, to use images from the Keyman
keyboard repository where this keyboard can be uploaded, you can use the
GitHub source. The URL starts with
https://raw.githubusercontent.com/keymanapp/keyboards/master/ + the path to
the image within the repository. For example:
```md
![GFF Mesobe Fidelat keyboard](https://raw.githubusercontent.com/keymanapp/keyboards/master/release/gff/gff_mesobe_fidelat/source/help/images/gff_mesobe_fidelat-default-1.jpeg)
```
> [!IMPORTANT]
> Images should not be included in the first paragraph.
* Learn more about the [keyboard repository](https://help.keyman.com/developer/keyboards/)
* The description can be edited later in the [Package Editor](package-editor).
Author
: The name of the developer of the keyboard. This will be set in the
package metadata, and where appropriate in documentation and
metadata.
: The name of the developer of the keyboard. This will be set in the package
metadata, and where appropriate in documentation and metadata.
Copyright
: A copyright string for the keyboard, excluding copyright year(s). This will
be set in the [`&Copyright`](/developer/language/reference/copyright) store
in the keyboard, in the package metadata, and where appropriate in
documentation and metadata.
Full Copyright
: The same copyright string for the keyboard, including copyright year.
Version
: The initial version number of the keyboard. This should follow the format
specified in the
[`&Keyboardversion`](/developer/language/reference/keyboardversion) store
for the keyboard. This will be set also in the package metadata, and where
appropriate in documentation and metadata.
Targets
: Specifies the default deployment targets for the keyboard, set in
the [`&Targets`](/developer/language/reference/targets) store in the
keyboard, and controls the files added to the package initially.
This also is reflected in documentation and metadata.
: Specifies the default deployment targets for the keyboard, set in the
[`&Targets`](/developer/language/reference/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.
: 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.
: 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.
: 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.

36
developer/docs/help/context/package-editor.md
View file

@ -134,7 +134,11 @@ version" to have the package version automatically track the keyboard version.
**Copyright**
: The Copyright indicates the overall copyright of the package and all its
contents.
contents. It should be included here without the copyright year(s).
**Full Copyright**
: The same copyright string for the keyboard, including copyright year.
**Author, E-mail address**
@ -155,16 +159,32 @@ then selected from the list here.
**Description**
: The first paragraph of the description appears in the keyboard search result on keyman.com, the full description will be shown in the keyboard page. Writing in the right syntax will ensure your keyboard displays correctly in keyman.com. **"[Markdown](https://www.markdownguide.org/basic-syntax) accepted, no embedded HTML description"**.
: This field should describe your keyboard to people who find it online. It
should explain the purpose of the keyboard in a friendly, descriptive way.
The description could include details that will help users to decide if this
keyboard is the appropriate choice for their needs.
: To add images to the description, use the image syntax from Markdown. As long as you know where the images will be, you could specify the path before merging the PR. The URL starts https://raw.githubusercontent.com/keymanapp/keyboards/master/ + the path to the image within the repository.
: The first paragraph of the description will appear in the keyboard search
result on keyman.com; the full description will be shown in the keyboard
details page on keyman.com. Use
[Markdown](https://www.markdownguide.org/basic-syntax) to include basic
formatting, but not embedded HTML is not allowed.
```md
![GFF Mesobe Fidelat keyboard](https://raw.githubusercontent.com/keymanapp/keyboards/master/release/gff/gff_mesobe_fidelat/source/help/images/gff_mesobe_fidelat-default-1.jpeg)
```
: To add images to the description, you will need to reference an image on a
server accessible online. For example, to use images from the Keyman
keyboard repository where this keyboard can be uploaded, you can use the
GitHub source. The URL starts with
https://raw.githubusercontent.com/keymanapp/keyboards/master/ + the path to
the image within the repository. For example:
> [!IMPORTANT]
> Images should not be included in the first paragraph.
```md
![GFF Mesobe Fidelat keyboard](https://raw.githubusercontent.com/keymanapp/keyboards/master/release/gff/gff_mesobe_fidelat/source/help/images/gff_mesobe_fidelat-default-1.jpeg)
```
> [!IMPORTANT]
> Images should not be included in the first paragraph.
* Learn more about the [keyboard repository](https://help.keyman.com/developer/keyboards/)
**Related packages**

BIN
developer/docs/help/images/ui/frmNewProjectParameters.png
View file

Binary file not shown.
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 175 KiB