-
-
Notifications
You must be signed in to change notification settings - Fork 111
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(developer): add user interface for kmc copy
to TIKE
#13076
Merged
mcdurdin
merged 3 commits into
master
from
feat/developer/13073-kmc-copy-ui-in-developer
Feb 5, 2025
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
34 changes: 34 additions & 0 deletions
34
developer/docs/help/context/clone-github-project-parameters.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
--- | ||
title: Clone GitHub Project Parameters Dialog | ||
--- | ||
|
||
![Clone GitHub Project Parameters dialog](../images/ui/frmCloneGitHubProjectParameters.png) | ||
|
||
Allows you to clone a project from a GitHub repository, giving the project a | ||
new id, and organizing project files following the | ||
[file layout](/developer/keyboards/) used in the | ||
[Keyman keyboards repository](https://github.com/keymanapp/keyboards). | ||
|
||
Keyboard and lexical model projects can be cloned. | ||
|
||
Projects can also be cloned from the command line with [`kmc copy`](kmc). | ||
|
||
### Parameters | ||
|
||
GitHub URL: | ||
: The full URL to a source project .kpj file to copy, on github.com. | ||
|
||
Destination 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. | ||
|
||
New project ID | ||
: The base filename of the keyboard/model, project and package. This must | ||
conform to the Keyman keyboard or lexical model identifier rules. | ||
|
||
Relocate external files into new project folder | ||
: When selected, if the project references files that are not inside the same | ||
folder as the .kpj file, move these files into an `external` subfolder | ||
|
37 changes: 37 additions & 0 deletions
37
developer/docs/help/context/clone-keyman-cloud-project-parameters.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
--- | ||
title: Clone Keyman Cloud Project Parameters Dialog | ||
--- | ||
|
||
![Clone Keyman Cloud Project Parameters dialog](../images/ui/frmCloneKeymanCloudProjectParameters.png) | ||
|
||
Allows you to clone a project from Keyman Cloud, giving the project a | ||
new id, and organizing project files following the | ||
[file layout](/developer/keyboards/) used in the | ||
[Keyman keyboards repository](https://github.com/keymanapp/keyboards). | ||
|
||
Projects can also be cloned from the command line with [`kmc copy`](kmc). | ||
|
||
Only keyboard projects can be cloned from Keyman Cloud at this time via this | ||
dialog. Lexical model projects can be cloned from Keyman Cloud via the command | ||
line. | ||
|
||
Search for a keyboard using the standard keyman.com keyboard search in the upper | ||
pane. Once you select a keyboard, and fill in the New Project Details, the OK | ||
button will be enabled to allow you to finish the cloning process. | ||
|
||
### Parameters | ||
|
||
Destination 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. | ||
|
||
New project ID | ||
: The base filename of the keyboard, project and package. This must | ||
conform to the Keyman keyboard identifier rules. | ||
|
||
Relocate external files into new project folder | ||
: When selected, if the project references files that are not inside the same | ||
folder as the .kpj file, move these files into an `external` subfolder | ||
|
34 changes: 34 additions & 0 deletions
34
developer/docs/help/context/clone-local-project-parameters.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
--- | ||
title: Clone Local Project Parameters Dialog | ||
--- | ||
|
||
![Clone Local Project Parameters dialog](../images/ui/frmCloneLocalProjectParameters.png) | ||
|
||
Allows you to clone a project from your local filesystem, giving the project a | ||
new id, and organizing project files following the | ||
[file layout](/developer/keyboards/) used in the | ||
[Keyman keyboards repository](https://github.com/keymanapp/keyboards). | ||
|
||
Keyboard and lexical model projects can be cloned. | ||
|
||
Projects can also be cloned from the command line with [`kmc copy`](kmc). | ||
|
||
### Parameters | ||
|
||
Source project filename | ||
: The full path of the source project .kpj file to copy. | ||
|
||
Destination 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. | ||
|
||
New project ID | ||
: The base filename of the keyboard/model, project and package. This must | ||
conform to the Keyman keyboard or lexical model identifier rules. | ||
|
||
Relocate external files into new project folder | ||
: When selected, if the project references files that are not inside the same | ||
folder as the .kpj file, move these files into an `external` subfolder | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+43.2 KB
developer/docs/help/images/ui/frmCloneKeymanCloudProjectParameters.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What happens if the user tries to clone
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good questions. The legacy keyboard would generate an error in the kmc-copy log, so the user would get feedback that way. An open source multi-keyboard package should copy fine -- the .kpj and .kps would get the new id, but the keyboards within would retain their original names. Would be worth a test for each of these, and so I'll give that a go.