From bd72c7efe687dfaca6d4fd3c0fc2b5a39d57df55 Mon Sep 17 00:00:00 2001 From: Roy Ben Shabat Date: Wed, 12 Aug 2020 02:12:46 +0300 Subject: More work on proc_doc. Fixed app crash on code editor selection. --- .../Content/Welcome.aml | 160 +- .../Help/proc-doc.chm | Bin 165989 -> 204761 bytes .../Tango.FSE.Procedures.Documentation.shfbproj | 25 +- .../Tango.FSE.Procedures/ArrayParsingStyle.cs | 10 + .../Examples/AddResult/Program.cs | 91 + .../Examples/Connection/Program.cs | 38 + .../Tango.FSE.Procedures/Examples/Csv/Program.cs | 63 + .../Examples/Diagnostics/Program.cs | 44 + .../Examples/RequestUserInputFor/Program.cs | 48 + .../Tango.FSE.Procedures/Examples/Sql/Program.cs | 78 + .../Tango.FSE.Procedures/IProcedureContext.cs | 123 +- .../FSE/Modules/Tango.FSE.Procedures/SqlResult.cs | 19 - .../Tango.FSE.Procedures.csproj | 11 +- .../Tango.FSE.Procedures/Themes/Generic.xaml | 6 +- .../FSE/Modules/Tango.FSE.Procedures/UserInput.cs | 11 + .../Views/ProcedureDesignerView.xaml.cs | 1 + .../Diagnostics/DiagnosticsPackage.cs | 35 +- .../FSE/Tango.FSE.Common/SQL/IRemoteSqlProvider.cs | 22 + .../FSE/Tango.FSE.Common/SQL/RemoteSqlCommand.cs | 25 + .../Tango.FSE.Common/SQL/RemoteSqlCommandMode.cs | 10 +- .../Tango.FSE.Common/SQL/RemoteSqlCommandResult.cs | 50 +- .../Tango.FSE.UI/SQL/DefaultRemoteSqlProvider.cs | 2 +- .../PPC/Tango.PPC.Shared/SQL/RemoteSqlColumn.cs | 28 + .../SQL/RemoteSqlColumnCollection.cs | 31 + .../PPC/Tango.PPC.Shared/SQL/RemoteSqlDataSet.cs | 35 + .../PPC/Tango.PPC.Shared/SQL/RemoteSqlRow.cs | 55 + .../PPC/Tango.PPC.Shared/Tango.PPC.Shared.csproj | 4 + .../Tango.Scripting.Editors/TextEditor.cs | 2343 ++++++++++---------- 28 files changed, 2147 insertions(+), 1221 deletions(-) create mode 100644 Software/Visual_Studio/FSE/Modules/Tango.FSE.Procedures/Examples/AddResult/Program.cs create mode 100644 Software/Visual_Studio/FSE/Modules/Tango.FSE.Procedures/Examples/Connection/Program.cs create mode 100644 Software/Visual_Studio/FSE/Modules/Tango.FSE.Procedures/Examples/Csv/Program.cs create mode 100644 Software/Visual_Studio/FSE/Modules/Tango.FSE.Procedures/Examples/Diagnostics/Program.cs create mode 100644 Software/Visual_Studio/FSE/Modules/Tango.FSE.Procedures/Examples/RequestUserInputFor/Program.cs create mode 100644 Software/Visual_Studio/FSE/Modules/Tango.FSE.Procedures/Examples/Sql/Program.cs delete mode 100644 Software/Visual_Studio/FSE/Modules/Tango.FSE.Procedures/SqlResult.cs (limited to 'Software/Visual_Studio') diff --git a/Software/Visual_Studio/FSE/Modules/Tango.FSE.Procedures.Documentation/Content/Welcome.aml b/Software/Visual_Studio/FSE/Modules/Tango.FSE.Procedures.Documentation/Content/Welcome.aml index 29e0c47c7..eb51fa37f 100644 --- a/Software/Visual_Studio/FSE/Modules/Tango.FSE.Procedures.Documentation/Content/Welcome.aml +++ b/Software/Visual_Studio/FSE/Modules/Tango.FSE.Procedures.Documentation/Content/Welcome.aml @@ -1,59 +1,111 @@ - - -This is a sample conceptual topic. You can use this as a starting point for adding more conceptual -content to your help project. -T:Tango.FSE.Procedures.IProcedureContext -Success! - - - -
- Getting Started - - To get started, add a documentation source to the project (a Visual Studio solution, project, or -assembly and XML comments file). See the Getting Started topics in the Sandcastle Help -File Builder's help file for more information. The following default items are included in this project: - - - - ContentLayout.content - Use the content layout file to manage the -conceptual content in the project and define its layout in the table of contents. - - - - The .\media folder - Place images in this folder that you will reference -from conceptual content using medialLink or mediaLinkInline -elements. If you will not have any images in the file, you may remove this folder. - - - - The .\icons folder - This contains a default logo for the help file. You -may replace it or remove it and the folder if not wanted. If removed or if you change the file name, update -the Transform Args project properties page by removing or changing the filename in the -logoFile transform argument. Note that unlike images referenced from conceptual topics, -the logo file should have its BuildAction property set to Content. - - - - The .\Content folder - Use this to store your conceptual topics. You may -name the files and organize them however you like. One suggestion is to lay the files out on disk as you have -them in the content layout file as shown in this project but the choice is yours. Files can be added via the -Solution Explorer or from within the content layout file editor. Files must appear in the content layout file -in order to be compiled into the help file. - - - - See the Conceptual Content topics in the Sandcastle Help File Builder's -help file for more information. See the Sandcastle MAML Guide for details on Microsoft -Assistance Markup Language (MAML) which is used to create these topics. - -
- - - T:Tango.FSE.Procedures.IProcedureContext - + +
+ Welcome + + Welcome to the Tango FSE Procedures API documentation. + This document contains a detailed description of each part of the API with some examples. + + + The best way to start exploring the main capabilities of a procedure is the T:Tango.FSE.Procedures.IProcedureContext interface. + + +
+ +
+ What is a Procedure ? + + + + + A procedure is a sequence of a pre-programmed actions/commands. + + + + + + A procedure can have one or more user input parameters. + + + + + + A procedure can have one or more output values. + + + + + + Procedures are not legacy “stubs”. They are a completely different creature. + + Procedures are a way for providing immediate and dynamic response for almost any scenario or issue that is being raised by customers/technicians. + + Procedure programmers can leverage an intuitive and extensive API and accomplish almost any requirement. + + Programming and managing Procedures is done through the “Procedure Designer” module. + + +
+ +
+ The Procedure Designer + + + The procedure designer module can be seen as a fully fledged IDE (Integrated Development Environment), designed to provide the best development experience for the “procedure programmer”. + + + The procedure designer is basically a project editor. In the technical sense, a “Procedure” is basically a project. + + + A project can be composed of one or more script files that are automatically linked together. + + + A project, is represented as a single file (.pproj) and is designed to encapsulate all the files and information about the project. + + + A project can have multiple assembly references and make use of them. An assembly reference can be any DLL file from the entire .NET framework, or from Twine’s libraries. + + + A “Procedure” in the “Procedures Module” is actually a single published procedure project. + + A published procedure is a project that is saved on Twine’s global database (per environment). + + Each published project has a name, description and version, while preserving the history of the last 10 versions. + + When the user navigates to the Procedures Module, Tango FSE will retrieves all published projects from the server. + + + Accessing the procedure designer module requires the “Run Procedure Designer” permission. + + Publishing a procedure project requires the “Publish Procedure Projects” permission. + + + + + Summery: + + + + + + + Published procedure projects are intended for all users and can be executed using the Procedures Module. + + + + + + Procedure Project files are intended for Twine’s programmers and technicians and can be executed/edited using the Procedure Designer. + + + + + + We can say that once a procedure project that is being designed for end-users, is well-tested and optimized, it can be published and be available as a “Procedure” for end-users. + + +
diff --git a/Software/Visual_Studio/FSE/Modules/Tango.FSE.Procedures.Documentation/Help/proc-doc.chm b/Software/Visual_Studio/FSE/Modules/Tango.FSE.Procedures.Documentation/Help/proc-doc.chm index 24e7db2e2..3ac22ce67 100644 Binary files a/Software/Visual_Studio/FSE/Modules/Tango.FSE.Procedures.Documentation/Help/proc-doc.chm and b/Software/Visual_Studio/FSE/Modules/Tango.FSE.Procedures.Documentation/Help/proc-doc.chm differ diff --git a/Software/Visual_Studio/FSE/Modules/Tango.FSE.Procedures.Documentation/Tango.FSE.Procedures.Documentation.shfbproj b/Software/Visual_Studio/FSE/Modules/Tango.FSE.Procedures.Documentation/Tango.FSE.Procedures.Documentation.shfbproj index 78ae89b52..16251df8f 100644 --- a/Software/Visual_Studio/FSE/Modules/Tango.FSE.Procedures.Documentation/Tango.FSE.Procedures.Documentation.shfbproj +++ b/Software/Visual_Studio/FSE/Modules/Tango.FSE.Procedures.Documentation/Tango.FSE.Procedures.Documentation.shfbproj @@ -33,6 +33,7 @@ + HtmlHelp1 C# @@ -102,7 +103,6 @@ - @@ -110,13 +110,13 @@ - + @@ -124,20 +124,37 @@ - + + + + + + + + + + + + + + + + + This is the global summery for the help file. This is the global summery for the help file. Contains a collection of interfaces and classes for the main procedures API. - + + Summary, Parameter, Returns, AutoDocumentCtors, TypeParameter, AutoDocumentDispose