Getting help - Revision history

Daniel Castaño: /* By name: dlookfor */

2016-05-20T13:35:12Z

By name: dlookfor

Daniel Castaño: /* Online help */

2016-04-28T10:54:43Z

Online help

Daniel Castaño at 10:54, 28 April 2016

2016-04-28T10:54:22Z

Daniel Castaño at 10:54, 28 April 2016

2016-04-28T10:54:06Z

Daniel Castaño: Created page with " ==Online help== We aim at centralizing the information in our wiki. You can open it from the command line as: `dwiki` or indicating and article. `dwiki table<>..."`

2016-04-28T10:51:29Z Created page with " ==Online help== We aim at centralizing the information in our wiki. You can open it from the command line as: <tt>dwiki</tt> or indicating and article. <tt>dwiki table<>..." New page ==Online help== We aim at centralizing the information in our wiki. You can open it from the command line as: <tt>dwiki</tt> or indicating and article. <tt>dwiki table<> Even if you don't if the article exists, you can also try your look and launch searches in the wiki. <tt>dwiki table tilt</tt> ==Help on commands== Every command in ''Dynamo'' has a header that explains its syntax. This help can be visualized with (for instance, for the <tt>dfsc</tt> function) <tt> help dfsc</tt> to see the help on the command line, or with <tt> doc dfsc</tt> to generate the help in a browser. This option may be useful for commands with many syntax options. == Finding commands == Very often the problem is not the syntax of the command, but remembering the command itself. ===By functionality=== <tt>dapropos</tt> finds commands grouped by their areas of functionality. <tt>>> dapropos</tt> lists the functionality areas defined in ''Dynamo'', and <tt>>> dapropos table</tt> will list the main commands attached to the {{t|table}} functionality area. ===By name: <tt> dlookfor </tt>=== <tt>dlookfor</tt> will look for commands that contain a string in the name. This commands might take some time for execution, as it will search in all the packages inside ''Dynamo'', and not only on the user level functions (those starting with <tt>dynamo_</tt>. ===By code content: <tt>dgrep</tt> === <tt>dgrep</tt> will look for appearances of a given string ''inside the code'' of any ''Dynamo'' function. This commands might take some time for execution, and is typically used by developers. ==Help center== This help center comes in handy when using ''Dynamo'' without internet connection. <tt>dhelp</tt> opens a GUI where the user can check different conventions (i.e., for tables, missing wedge codes), access the list of shipped pdf tutorials and check the syntax of commands, project parameters or database elements.

← Older revision		Revision as of 10:54, 28 April 2016
Line 60:		Line 60:
	opens a GUI where the user can check different conventions (i.e., for tables, missing wedge codes), access the list of shipped pdf tutorials and check the syntax of commands, project parameters or database elements.		opens a GUI where the user can check different conventions (i.e., for tables, missing wedge codes), access the list of shipped pdf tutorials and check the syntax of commands, project parameters or database elements.

−	[[File:dhelp.png\|thumb\|~~right~~\|500px\| <tt>dhelp</tt> window showing the list of available pdf tutorials]]	+	[[File:dhelp.png\|thumb\|center\|500px\| <tt>dhelp</tt> window showing the list of available pdf tutorials]]

@@ Line 43: / Line 43: @@
 ===By name: <tt> dlookfor </tt>===
-<tt>dlookfor</tt> will look for commands that contain a string in the name.
+<tt>dlookfor</tt> will look for commands that contain a given string in the name.
-This commands might take some time for execution, as it will search in all the packages inside ''Dynamo'', and not only on the user level functions (those starting with <tt>dynamo_</tt>.
+This commands might take some time for execution, as it will search in all the packages inside ''Dynamo'', and not only on the user level functions (those starting with <tt>dynamo_</tt>).
 ===By code content: <tt>dgrep</tt> ===

@@ Line 8: / Line 8: @@
 or indicating and article.
-<tt>dwiki table<>
+<tt>dwiki table</tt>
 Even if you don't if the article exists, you can also try your look and launch searches in the wiki.

@@ Line 31: / Line 31: @@
 Very often the problem is not the syntax of the command, but remembering the command itself.
-===By functionality===
+===By functionality: <tt>dapropos</tt>===
 <tt>dapropos</tt> finds commands grouped by their areas of functionality.
@@ Line 59: / Line 59: @@
 opens a GUI where the user can check different conventions (i.e., for tables, missing wedge codes), access the list of shipped pdf tutorials and check the syntax of commands, project parameters or database elements.

Getting help - Revision history

Daniel Castaño: /* By name: dlookfor */

Daniel Castaño: /* Online help */

Daniel Castaño at 10:54, 28 April 2016

Daniel Castaño at 10:54, 28 April 2016

Daniel Castaño: Created page with " ==Online help== We aim at centralizing the information in our wiki. You can open it from the command line as: dwiki or indicating and article. dwiki table<>..."

Daniel Castaño: Created page with " ==Online help== We aim at centralizing the information in our wiki. You can open it from the command line as: `dwiki` or indicating and article. `dwiki table<>..."`