diff --git a/client/src/components/Form/FormDisplay.vue b/client/src/components/Form/FormDisplay.vue index f6e22c76fb7c..9e8b7d0fdbb8 100644 --- a/client/src/components/Form/FormDisplay.vue +++ b/client/src/components/Form/FormDisplay.vue @@ -15,8 +15,11 @@ diff --git a/client/src/stores/helpmode/helpModeTextStore.js b/client/src/stores/helpmode/helpModeTextStore.js index bcab6fbde29b..cf0eacb36c38 100644 --- a/client/src/stores/helpmode/helpModeTextStore.js +++ b/client/src/stores/helpmode/helpModeTextStore.js @@ -1,6 +1,6 @@ import { defineStore } from "pinia"; -import config from './helpTextConfig.yml'; +import config from "./helpTextConfig.yml"; export const useHelpModeTextStore = defineStore("helpModeText", { state: () => { diff --git a/client/src/stores/helpmode/helpTextConfig.yml b/client/src/stores/helpmode/helpTextConfig.yml index e642a0096709..72ed77f95570 100644 --- a/client/src/stores/helpmode/helpTextConfig.yml +++ b/client/src/stores/helpmode/helpTextConfig.yml @@ -1,2 +1,26 @@ --- -quotaMeterHelpString: This is your Quota storage meter. It is an indication of how much storage you are using. To learn more about Quota Storage, check out this GTN tutorial.s \ No newline at end of file +quotaMeterHelpString: This is your Quota storage meter. It is an indication of how much storage you are using. To learn more about Quota Storage, check out this GTN tutorial. +unix_terms: + exitCodeHelpString: Some text about exit codes. + stdoutHelpString: Some text about stdout. + stderrHelpString: Some text about stderr. + commandLineHelpString: Some text about command line. + tracebackHelpString: Some text about traceback. + +galaxy_terms: + historyIDHelpString: Some text about history ID. + historyContentIDHelpString: Some text about history content ID. + historyDatasetCollectionAssociationHelpString: Some text about history dataset collection association. + historyDatasetAssociationHelpString: Some text about history dataset association. + datasetHelpString: Some text about dataset. + invocationHelpString: Some text about invocation. + datatypeHelpString: Some text about datatype. + dbkeyHelpString: Some text about dbkey. + jobStatesHelpString: Some text about job states. + +tool_form_base: | + ## [HelpMode] How to use a tool form + + 1. Select data **inputs** + 2. Set tool **parameters** + 3. Click **Run Tool** diff --git a/client/src/stores/helpmode/helpTextMarkdown/tool_form_markdown.md b/client/src/stores/helpmode/helpTextMarkdown/tool_form_markdown.md new file mode 100644 index 000000000000..f8a64176a787 --- /dev/null +++ b/client/src/stores/helpmode/helpTextMarkdown/tool_form_markdown.md @@ -0,0 +1,60 @@ +# [Help] How to use a tool form + +1. Select data **inputs** +2. Set tool **parameters** +3. Click **Run Tool** + +:::info +More about this tool... + +- Tool name `**name** description` +- Tool version `**version**` +- This tool has **N** required inputs + - input1 with datatype format of `**list of datatypes**` + - input2 with datatype format of `**list of datatypes**` +- See the **tool help** `scrolls tool form down to help section` + ::: + +-- > _Reference tool wrapper_ + +``` + + + columns from a table + +``` + +## :question: Help + +:::success +Galaxy concepts +::: + +### Input Data + +- Inputs are data _files_ +- Inputs are commonly named **[datasets](https://training.galaxyproject.org/training-material/search2?query=dataset)** in Galaxy +- Inputs on tool forms are chosen from the _currently active_ **[history](https://training.galaxyproject.org/training-material/search2?query=history)** +- **[Upload](https://training.galaxyproject.org/training-material/search2?query=upload)** or **[copy](https://training.galaxyproject.org/training-material/faqs/galaxy/histories_copy_dataset.html)** datasets into your history to use them + +:flashlight: Switch which history is active with `fa-exchange` or view all of your histories with `history-selector-icon` + +### Inputs: one or many? + +- Input data can be ... + - a single dataset `fa-file` + - a set of multiple datasets `fa-files` + - a set of multiple datasets in a [dataset collection](https://training.galaxyproject.org/training-material/search2?query=collection) `fa-folder` + +### Input format: Datatype + +- Inputs have a file format commonly named a **datatype** in Galaxy +- Datatypes are metadata that describe what a file contains. +- Datatypes are similiar to a file extention but are not a part of the file name. +- When the _expected_ datatype on the form matches an _assigned_ datatype, a dataset becomes available to select on the tool form. + +### Learn + +- [Introduction to Galaxy Analyses](https://training.galaxyproject.org/training-material/topics/introduction/) +- [Collections are folders of similiar files!](https://training.galaxyproject.org/training-material/search2?query=collection) +- [Upload: Getting Data into Galaxy](https://help.galaxyproject.org/t/getting-data-into-galaxy/10868)