Skip to content

Commit a4a8265

Browse files
aplteamaplteam
committed
Bring help files back with correct spelling
1 parent 965251f commit a4a8265

16 files changed

+207
-0
lines changed

‎APLSource/Cider/UC/help/level_1/AddNuGetDependencies.apla‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
(
2+
'Requires one mandatory argument: a comma-separated list of NuGet packages to be installed.'
3+
''
4+
'The second argument is optional. If it is omitted, Cider acts on any open project, or lets the'
5+
'user select in case there is more than one project open.'
6+
''
7+
'If the second argument is specified it must be one of:'
8+
'* A project [alias]'
9+
'* A path pointing to a Cider project'
10+
''
11+
'In case the project''s config file does not carry a definition for a NuGet dependency folder'
12+
'the user is given the oportunity to edit the config file.'
13+
''
14+
'-target= Use this to specify a target namespace. This is added to the "dependencies" or the'
15+
' "dependencies_dev" parameter with a "=". If there is already such a target namespace'
16+
' an error is thrown; you need to edit the project''s config file in such a case.'
17+
''
18+
)

‎APLSource/Cider/UC/help/level_1/AddTatinDependencies.apla‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
(
2+
'Requires one mandatory argument: a comma-separated list of Tatin packages to be installed.'
3+
''
4+
'The second argument is optional. If it is omitted, Cider acts on any open project, or lets the'
5+
'user select a project in case there is more than one open.'
6+
''
7+
'If the second argument is specified it must be one of:'
8+
'* A project [alias]'
9+
'* A path pointing to a Cider project'
10+
''
11+
'In case the project''s config file does not carry a definition for a Tatin dependency folder'
12+
'the user is given the oportunity to edit the config file.'
13+
''
14+
'-development By default the packages are added as project dependencies. The -development'
15+
' flag can be used to make them development dependencies instead.'
16+
'-target= Use this to specify a target namespace. This is added to the "dependencies" or the'
17+
' "dependencies_dev" parameter with a "=". If there is already such a target namespace'
18+
' an error is thrown; you need to edit the project''s config file in such a case.'
19+
)

‎APLSource/Cider/UC/help/level_1/CloseProject.apla‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
(
2+
'Breaks the Link between one or more projects and their associated files on disk.'
3+
''
4+
'You may specify one of:'
5+
' 1. One or more projects via a fully qualified namespace name'
6+
' 2. One or more projects via an [alias]'
7+
' 3. One or more projects via project path(s)'
8+
' 4. A mixture of 1, 2 and 3'
9+
' 5. Nothing; if only one project is open it will be closed.'
10+
' If multiple projects are opened a list will be presented to the user'
11+
' 6. The -all flag, which closes all projects without further ado'
12+
''
13+
'Multiple projects must be separated by spaces or by commas.'
14+
''
15+
' * In case a particular project was specified, a Boolean is reported, 1 indicating success'
16+
' * Otherwise the closed projects are reported in detail'
17+
''
18+
'-fast Use this to tell CloseProject that is should not perform any checks, see global Cider'
19+
' config parameter `CheckForDropboxConflicts`.'
20+
)

‎APLSource/Cider/UC/help/level_1/Config.apla‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
(
2+
'Puts the content of Cider''s global config file into the editor and allows the user to change it.'
3+
'By specifying the -print flag you can force the user command to print the content of the file'
4+
'to the session rather than putting it into ⎕ED.'
5+
''
6+
'You may change the data, but those changes will only be written to the file if you confirm that.'
7+
'Note that changing the config file does not affect the currently running instance of Cider.'
8+
)

‎APLSource/Cider/UC/help/level_1/CreateProject.apla‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
(
2+
'Requires a path to a folder ("source") that is about to become a project.'
3+
'You might also specify a namespace. If no namespace is provided then the name of the namespace'
4+
'is derived from the path. If the namespace does not yet exist it will be created.'
5+
'The namespace will be LINKed to "source", and a namespace CiderConfig, holding the configuration'
6+
'data, will be injected into the namespace.'
7+
'For a root project (the whole of #, NOT recommended) you must specify # as 2nd argument.'
8+
''
9+
' * Creates a file "cider.config" in that folder'
10+
' * Lets the user edit that file and makes sure that all mandatory settings are specified correctly'
11+
' * In case an alias is specified, the alias is saved'
12+
' * Finally it attempts to open the new project'
13+
''
14+
'If no path is specified it acts on the current directory, but in that case the user is prompted'
15+
'for confirmation to avoid mishaps.'
16+
''
17+
'-acceptConfig: By default a file cider.config is created, and an error is thrown in'
18+
' case it already exists. You can use -acceptConfig to force CreateProject'
19+
' to accept an already existing config file.'
20+
'-noEdit: With -noEdit you can prevent the user from being asked to edit the config file.'
21+
'-alias: In case you are going to work on the new project frequently you may specify'
22+
' -alias=name; from then on you can use the [alias] rather than the path.'
23+
' Note that aliases are not case sensitive.'
24+
'-batch After a project has been created successfully, the user will be asked whether she'
25+
' wants to open the project as well. You can enforce that without the user being'
26+
' questioned by setting the -batch flag. Mainly useful for test cases and possibly'
27+
' an automated build process.'
28+
'-ignoreUserExec Suppress execution of a user function defined in Cider''s config file on this occasion.'
29+
)

‎APLSource/Cider/UC/help/level_1/Help.apla‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
(
2+
'Cider comes with two HTML files with documentation. This user command offers to put'
3+
'one or both of them on display in the default browser.'
4+
)

‎APLSource/Cider/UC/help/level_1/ListAliases.apla‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
(
2+
'Print all defined aliases together with their folders.'
3+
''
4+
'There are two mutually exclusive options available:'
5+
'-edit Cider will allow you to edit the file that keeps the alias information'
6+
'-prune Cider will delete all aliases for which their folders cannot be found'
7+
'-batch When -prune is specified the user will be asked for confirmation in case there'
8+
' is something to prune at all. You prevent this by specifying this flag.'
9+
' All reporting to the session will then be suppressed as well.'
10+
'-scan= You might has a number of projects in a particular folder, and you might want to'
11+
' add all of them (or most/some of them) as aliase. This flag puts all sub-folders'
12+
' into an edit window, and will add all remaining ones as aliase.'
13+
)

‎APLSource/Cider/UC/help/level_1/ListNuGetDependencies.apla‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
(
2+
'Lists all NuGet dependencies in the Nuget dependency folder.'
3+
''
4+
'Takes a path to a project or a project alias as (optional) argument.'
5+
'If no argument is provided the command looks for open Cider projects.'
6+
''
7+
)

‎APLSource/Cider/UC/help/level_1/ListOpenProjects.apla‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
(
2+
'Prints a list with the namespaces of all currently opened projects.'
3+
''
4+
'Add the -verbose flag for more information. Then a matrix is returned with these columns:'
5+
''
6+
' [;1] Namespace name'
7+
' [;2] Path'
8+
' [;3] Number of objects in the project'
9+
' [;4] Alias name (if any)'
10+
)

‎APLSource/Cider/UC/help/level_1/ListTatinDependencies.apla‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
(
2+
'Lists all Tatin packages in all install folders of a given project'
3+
''
4+
' * If no argument is provided a list with all open projects is presented to the user, unless'
5+
' there is only one open anyway.'
6+
' * If an argument is provided then it must be one of:'
7+
' * folder of a Cider-managed project'
8+
' * an alias of a Cider-managed porject'
9+
''
10+
'The package install folder(s) are established from Cider''s config file.'
11+
''
12+
'The main purpose of this user command is to check whether the packages got installed from the'
13+
'desired Tatin Registries, but check the -full flag'
14+
''
15+
'-full Results in a hierarchical report on all dependencies. This does not give what is actually'
16+
' used, it gives you what the packaged themselves requires. Due to minimum version selection'
17+
' they might end up using a later version.'
18+
' This can be useful to figure out why a particular (typically old) package is required.'
19+
'-raw By default beautified data is displayed. With -raw you get just the pure data.'
20+
''
21+
)

0 commit comments

Comments
 (0)