From c51d483c322a1f536da40e2d7aee63f0c4abeaed Mon Sep 17 00:00:00 2001
From: Samuele Locatelli <samuele@steamware.net>
Date: Fri, 13 May 2022 19:15:11 +0200
Subject: [PATCH] Aggiunta preliminare DocFx in VStudio (da validare e testare
 uso)

---
 .gitignore                   |  4 +++
 Icoel.Soap/Icoel.Soap.csproj | 16 +++++++++
 Icoel.Soap/docfx.json        | 68 ++++++++++++++++++++++++++++++++++++
 Icoel.Soap/index.md          | 20 +++++++++++
 Icoel.Soap/log.txt           |  0
 Icoel.Soap/packages.config   |  4 +++
 Icoel.Soap/toc.yml           |  6 ++++
 7 files changed, 118 insertions(+)
 create mode 100644 Icoel.Soap/docfx.json
 create mode 100644 Icoel.Soap/index.md
 create mode 100644 Icoel.Soap/log.txt
 create mode 100644 Icoel.Soap/packages.config
 create mode 100644 Icoel.Soap/toc.yml

diff --git a/.gitignore b/.gitignore
index afc2b628..5312e298 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,6 +2,10 @@
 ## Ignore Visual Studio temporary files, build results, and
 ## files generated by popular Visual Studio add-ons.
 
+#ignoro (per ora) DoxFx site autogenerato da MSBuild in VStudio
+Icoel.Soap/_site/*
+Icoel.Soap/*/*.md
+
 # User-specific files
 *.suo
 *.user
diff --git a/Icoel.Soap/Icoel.Soap.csproj b/Icoel.Soap/Icoel.Soap.csproj
index 0cc632c5..32c69571 100644
--- a/Icoel.Soap/Icoel.Soap.csproj
+++ b/Icoel.Soap/Icoel.Soap.csproj
@@ -13,6 +13,8 @@
     <AutoGenerateBindingRedirects>true</AutoGenerateBindingRedirects>
     <Deterministic>true</Deterministic>
     <TargetFrameworkProfile />
+    <NuGetPackageImportStamp>
+    </NuGetPackageImportStamp>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
     <PlatformTarget>AnyCPU</PlatformTarget>
@@ -62,7 +64,10 @@
     <Compile Include="Properties\AssemblyInfo.cs" />
   </ItemGroup>
   <ItemGroup>
+    <None Include="api\index.md" />
     <None Include="App.config" />
+    <None Include="articles\intro.md" />
+    <None Include="articles\toc.md" />
     <None Include="batch.ini">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
@@ -134,6 +139,10 @@
     <None Include="Connected Services\SizerService\System.xsd">
       <SubType>Designer</SubType>
     </None>
+    <None Include="docfx.json" />
+    <None Include="index.md" />
+    <None Include="packages.config" />
+    <None Include="toc.yml" />
   </ItemGroup>
   <ItemGroup>
     <WCFMetadata Include="Connected Services\" />
@@ -154,4 +163,11 @@
     </None>
   </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
+  <Import Project="..\packages\docfx.console.2.59.2\build\docfx.console.targets" Condition="Exists('..\packages\docfx.console.2.59.2\build\docfx.console.targets')" />
+  <Target Name="EnsureNuGetPackageBuildImports" BeforeTargets="PrepareForBuild">
+    <PropertyGroup>
+      <ErrorText>This project references NuGet package(s) that are missing on this computer. Use NuGet Package Restore to download them.  For more information, see http://go.microsoft.com/fwlink/?LinkID=322105. The missing file is {0}.</ErrorText>
+    </PropertyGroup>
+    <Error Condition="!Exists('..\packages\docfx.console.2.59.2\build\docfx.console.targets')" Text="$([System.String]::Format('$(ErrorText)', '..\packages\docfx.console.2.59.2\build\docfx.console.targets'))" />
+  </Target>
 </Project>
\ No newline at end of file
diff --git a/Icoel.Soap/docfx.json b/Icoel.Soap/docfx.json
new file mode 100644
index 00000000..bacb80c9
--- /dev/null
+++ b/Icoel.Soap/docfx.json
@@ -0,0 +1,68 @@
+{
+  "metadata": [
+    {
+      "src": [
+        {
+          "files": [
+            "*.csproj"
+          ],
+          "cwd": ".",
+          "exclude": [
+            "**/obj/**",
+            "**/bin/**",
+            "_site/**"
+          ]
+        }
+      ],
+      "dest": "obj/api"
+    }
+  ],
+  "build": {
+    "content": [
+      {
+        "files": [
+          "api/**.yml"
+        ],
+        "cwd": "obj"
+      },
+      {
+        "files": [
+          "api/*.md",
+          "articles/**.md",
+          "toc.yml",
+          "*.md"
+        ],
+        "exclude": [
+          "obj/**",
+          "_site/**"
+        ]
+      }
+    ],
+    "resource": [
+      {
+        "files": [
+          "images/**"
+        ],
+        "exclude": [
+          "obj/**",
+          "_site/**"
+        ]
+      }
+    ],
+    "overwrite": [
+      {
+        "files": [
+          "apidoc/**.md"
+        ],
+        "exclude": [
+          "obj/**",
+          "_site/**"
+        ]
+      }
+    ],
+    "dest": "_site",
+    "template": [
+      "default"
+    ]
+  }
+}
\ No newline at end of file
diff --git a/Icoel.Soap/index.md b/Icoel.Soap/index.md
new file mode 100644
index 00000000..4c3c687f
--- /dev/null
+++ b/Icoel.Soap/index.md
@@ -0,0 +1,20 @@
+
+# Icoel.Soap Library
+
+Documentazione relativa alla libreria di interfaccia con il Sizer di ICOEL per le operazioni di R/W dei dati di batch di produzione
+
+## Logica di funzionamento impianto ICOEL:
+
+L'impianto Icoel prevede di comunicare in 3 modalita'':
+1. OPC-UA per dati RealTime di processo/automazione
+2. SOAP API per informazioni scambiate riguardo al setup dei batch da produrre (messa in coda) ed in produzione
+3. DB per dati produttivita "nrear-realtime" e tracciatura
+
+La presente libreria si occupa della modalità SOAP.
+
+## Modalita'' impiego libreria
+
+La libreria va chiamata inizializzando un oggetto Connector, e poi invocando i suoi metodi messia  disposizione che si occupano di
+ - aprire canale di comunicazione
+ - effettuare chaimate
+ - chiudere canale
\ No newline at end of file
diff --git a/Icoel.Soap/log.txt b/Icoel.Soap/log.txt
new file mode 100644
index 00000000..e69de29b
diff --git a/Icoel.Soap/packages.config b/Icoel.Soap/packages.config
new file mode 100644
index 00000000..6b239d6f
--- /dev/null
+++ b/Icoel.Soap/packages.config
@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
+<packages>
+  <package id="docfx.console" version="2.59.2" targetFramework="net462" developmentDependency="true" />
+</packages>
\ No newline at end of file
diff --git a/Icoel.Soap/toc.yml b/Icoel.Soap/toc.yml
new file mode 100644
index 00000000..7eee9ffb
--- /dev/null
+++ b/Icoel.Soap/toc.yml
@@ -0,0 +1,6 @@
+
+- name: Articles
+  href: articles/
+- name: API Documentation
+  href: obj/api/
+  homepage: api/index.md