Skip to content

Commit

Permalink
Squashed commit of the following:
Browse files Browse the repository at this point in the history
commit d085964
Author: iJungleboy <[email protected]>
Date:   Wed Dec 20 17:57:24 2023 +0100

    build

commit 1ceb4d0
Author: iJungleboy <[email protected]>
Date:   Wed Dec 20 17:57:07 2023 +0100

    minor

commit b4209ea
Author: iJungleboy <[email protected]>
Date:   Wed Dec 20 08:18:15 2023 +0100

    update logos/images/favicon

commit a76b5e0
Author: iJungleboy <[email protected]>
Date:   Tue Dec 19 23:50:00 2023 +0100

    wip v17 - can't get razor-highligting to work...

commit ad1d102
Author: iJungleboy <[email protected]>
Date:   Tue Dec 19 22:39:48 2023 +0100

    ongoing enhancements for v17

commit 79ff32f
Author: iJungleboy <[email protected]>
Date:   Tue Dec 19 21:45:17 2023 +0100

    fix docfx changes src instead of cwd

commit fcf20be
Author: iJungleboy <[email protected]>
Date:   Tue Dec 19 20:19:13 2023 +0100

    improve toc design / spaces / titles

commit ace7f89
Author: iJungleboy <[email protected]>
Date:   Tue Dec 19 18:35:38 2023 +0100

    docfx template originals for working

commit 75833e5
Author: iJungleboy <[email protected]>
Date:   Tue Dec 19 18:34:34 2023 +0100

    add version selector

commit 15f2fca
Author: iJungleboy <[email protected]>
Date:   Tue Dec 19 18:02:58 2023 +0100

    correct float to Bootstrap 5

commit 1b53f80
Author: iJungleboy <[email protected]>
Date:   Tue Dec 19 17:22:11 2023 +0100

    wip v17 with new docfx
  • Loading branch information
iJungleboy committed Dec 20, 2023
1 parent a5e687e commit 691b218
Show file tree
Hide file tree
Showing 2,147 changed files with 205,205 additions and 382,070 deletions.
6 changes: 5 additions & 1 deletion 2sxc Docs Generator/2sxc Docs.code-workspace
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@
"templating",
"VARCHAR"
],
"dotnet.defaultSolution": "2sxc Docs Generator.sln"
"dotnet.defaultSolution": "2sxc Docs Generator.sln",
"files.associations": {
"*.json": "jsonc",
"*.tmpl": "mustache",
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
uid: Custom.DataSource
summary: Classes to inherit from when creating custom DataSources in Dnn ☢️ & Oqtane 🩸.
# title: Custom.Hybrid Namespace
---

# Custom.DataSource Namespace Dnn ☢️ & Oqtane 🩸

This contains all the base classes for your own DataSources.
8 changes: 4 additions & 4 deletions 2sxc Docs Generator/api/dot-net/Custom/Dnn/_Dnn.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
uid: Custom.Dnn
summary: Namespace for base classes of custom code, razor and WebApis in DNN
summary: Base classes for custom Razor / C# which only runs on Dnn ☢️.
# title: Custom.Dnn Namespace
---

# Custom.Dnn Namespace for Dnn ☢️

This contains all the base classes for your own solutions, which are targeted to Dnn ☢️.
This contains all the base classes for your own solutions, which are targeted to Dnn ☢️.

## Versioned Base Classes

All the base classes in this have a version number, so it will become easier to document differences between versions and also to give guidance how to upgrade in case of future breaking changes or security issues.
All the base classes in this have a version number, so it will become easier to document differences between versions and also to give guidance how to upgrade in case of future breaking changes or security issues.

## Previous Base Classes

Expand All @@ -23,7 +23,7 @@ Previously other base classes were recommended. They will continue to work, but

#### [Api12](xref:Custom.Dnn.Api12)

The base class for APIs which only need to work in Dnn. They internally inherit from [DnnApiController](https://dnndocs.com/api/DotNetNuke.Web.Api.DnnApiController.html) which inherits from `ApiController` [System.Web.Http.ApiController](https://docs.microsoft.com/en-us/dotnet/api/system.web.http.apicontroller) and in addition to all the [DynamicCode](xref:NetCode.DynamicCode.Index) properties also have all the features of that base class.
The base class for APIs which only need to work in Dnn. They internally inherit from [DnnApiController](https://dnndocs.com/api/DotNetNuke.Web.Api.DnnApiController.html) which inherits from `ApiController` [System.Web.Http.ApiController](https://docs.microsoft.com/en-us/dotnet/api/system.web.http.apicontroller) and in addition to all the [DynamicCode](xref:NetCode.DynamicCode.Index) properties also have all the features of that base class.

#### [Code12](xref:Custom.Dnn.Code12)

Expand Down
8 changes: 4 additions & 4 deletions 2sxc Docs Generator/api/dot-net/Custom/Hybrid/_Hybrid.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
uid: Custom.Hybrid
summary: *content
summary: Recommended Base Classes for all your Razor and C# files which work on Dnn ☢️ & Oqtane 🩸.
# title: Custom.Hybrid Namespace
---

Expand All @@ -11,19 +11,19 @@ They are meant to work across platforms (Dnn ☢️, Oqtane 🩸, NopCommerce

## Versioned Base Classes

All the base classes in this have a version number, so it will become easier to document differences between versions and also to give guidance how to upgrade in case of future breaking changes or security issues.
All the base classes in this have a version number, so it will become easier to document differences between versions and also to give guidance how to upgrade in case of future breaking changes or security issues.


### Classes

#### [Api12](xref:Custom.Hybrid.Api12)

The base class for hybrid APIs. They internally inherit either from from [DnnApiController](https://dnndocs.com/api/DotNetNuke.Web.Api.DnnApiController.html) or from [Microsoft.AspNetCore.Mvc.Controller](https://docs.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.mvc.controller) and in addition to all the [DynamicCode](xref:NetCode.DynamicCode.Index) properties also have all the features of that base class - but you should be careful using base-class properties, as they will probably not be hybrid any more.
The base class for hybrid APIs. They internally inherit either from from [DnnApiController](https://dnndocs.com/api/DotNetNuke.Web.Api.DnnApiController.html) or from [Microsoft.AspNetCore.Mvc.Controller](https://docs.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.mvc.controller) and in addition to all the [DynamicCode](xref:NetCode.DynamicCode.Index) properties also have all the features of that base class - but you should be careful using base-class properties, as they will probably not be hybrid any more.

#### [Code12](xref:Custom.Hybrid.Code12)

The base class for custom hybrid code. If you inherit from this class, you'll automatically have all the properties from [DynamicCode](xref:NetCode.DynamicCode.Index).

#### [Razor12](xref:Custom.Hybrid.Razor12)

The base class for custom Razor. If you inherit from this class, you'll automatically have all the properties from [DynamicCode](xref:NetCode.DynamicCode.Index).
The base class for custom Razor. If you inherit from this class, you'll automatically have all the properties from [DynamicCode](xref:NetCode.DynamicCode.Index).
Binary file modified 2sxc Docs Generator/assets/favicon.ico
Binary file not shown.
Binary file added 2sxc Docs Generator/assets/logos/v16/1000.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added 2sxc Docs Generator/assets/logos/v16/150.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added 2sxc Docs Generator/assets/logos/v16/50.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added 2sxc Docs Generator/assets/logos/v16/500.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified 2sxc Docs Generator/assets/logos/vcurrent/1000.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified 2sxc Docs Generator/assets/logos/vcurrent/150.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified 2sxc Docs Generator/assets/logos/vcurrent/50.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified 2sxc Docs Generator/assets/logos/vcurrent/500.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 11 additions & 8 deletions 2sxc Docs Generator/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
{
"src": [
{
"src": "../..",
"files": [
// docfx v2.59.4 is required for vs2022 17.3+ msbuild to work with *.csproj
"2sxc/**.csproj",
Expand All @@ -11,7 +12,6 @@
// "2sxc/Src/Dnn/ToSic.Sxc.Dnn/bin/Release/ToSic.Sxc*.dll",
// "eav-server/ToSic.Eav/bin/Release/net6.0/*.dll"
],
"cwd": "../..",
"exclude": [
"**/obj/**",
"**/bin/**",
Expand All @@ -21,7 +21,7 @@
"**/XOLD-*/**",
"**Mvc/Website/**",
"**/ToSic.Sxc.Mvc/**",
"Comment about the next oqtane line - we would rather just exclude oqtane.framework but ATM it results in errors because of diff .net versions",
// "Comment about the next oqtane line - we would rather just exclude oqtane.framework but ATM it results in errors because of diff .net versions",
"**/Oqtane/**",
"**/ToSic.Sxc.Razor/**",
"**/Integration/**"
Expand All @@ -36,7 +36,8 @@
"TargetFramework": "net472", // must be net472 because of DNN and 2sxc/eav *.csproj configurations
"GenerateDocumentationFile": true,
"ProduceReferenceAssembly": true
}
},
"namespaceLayout": "nested",
}
],
"build": {
Expand Down Expand Up @@ -166,20 +167,22 @@
"dest": "../docs",
"template": [
"default",
"statictoc",
"material/material",
"templates/2sxc"
// "statictoc",
"modern",
"templates/2sxc",
// "material/material",
],
"cleanupCacheHistory": true, // If set to true, docfx create a new intermediate folder for cache files, historical cache data will be cleaned up.
"disableGitFeatures": false, // Disable fetching Git related information for articles. By default it is enabled and may have side effect on performance when the repo is large.
"globalMetadata": {
"_appTitle": "2sxc 16 / EAV 16",
"_appTitle": "2sxc 17 for Dnn and Oqtane",
"_appLogoPath": "assets/logos/vcurrent/50.png",
"_appFaviconPath": "assets/favicon.ico",
"_enableNewTab": true,
"_enableSearch": true,
"_gitUrlPattern": "github",
"_disableContribution": false // Disabling the "View Source" and "Improve this Doc" buttons.
"_disableContribution": false, // Disabling the "View Source" and "Improve this Doc" buttons.
"_googleAnalyticsTagId": "GTM-PH2TVNW",
}
}
}
2 changes: 1 addition & 1 deletion 2sxc Docs Generator/docs-versions.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img src="assets/logos/vcurrent/500.png" width="100px" align="right" class="float-right">
<img src="assets/logos/vcurrent/500.png" width="100px" align="right" class="float-end">

<script>
// get url parameters version and path
Expand Down
15 changes: 13 additions & 2 deletions 2sxc Docs Generator/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

<img src="assets/logos/vcurrent/500.png" width="250px" align="right" class="float-right">
<img src="assets/logos/vcurrent/500.png" width="250px" align="right" class="float-end">

# 2sxc and EAV Docs v16.07 [LTS](xref:Abyss.Releases.Management.PolicyLts) / v16.09
# 2sxc and EAV Docs v17.00 Pre-Release

This is the technical documentation for EAV and 2sxc. If you're new to 2sxc, start with [2sxc.org](https://2sxc.org/).

Expand Down Expand Up @@ -62,3 +62,14 @@ These topics are insufficiently documented...
1. etc.


## To Doc about Docs

1. All kinds of customizations
1. How Illustrations work (SVGs, CSS, JS etc.)
1. Lightbox
1. Possibly activation of additional languages
1. How version switcher works
1. How TOC customizations work
1. icons in .net API
1. HR splitters

70 changes: 59 additions & 11 deletions 2sxc Docs Generator/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 6 additions & 4 deletions 2sxc Docs Generator/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,30 @@
"version": "14.0.0",
"description": "",
"scripts": {
"main": "npx tsc --watch",
"// import": "Note: This is not yet working",
"import": "npm run import-js && npm run import-jsng",

"// import-js": "This is the import that already works. It will get the docs from the sxc-typings project and generate YAML for DocFx",
"import-js": "npm run import-js1-pre-clean && npm run import-js2-typedoc && npm run import-js3-docfx",
"import-js1-pre-clean": "cd import && delete.cmd \".\\api.js.sxcjs\"",
"import-js2-typedoc": "cd \"../../2sxc-ui/projects/sxc-typings/\" && typedoc --tsconfig ./tsconfig.typedoc.json --json \"../../../2sxc-docs/2sxc Docs Generator/import/api.js.sxcjs/typedoc.json\"",
"import-js3-docfx": "type2docfx ./import/api.js.sxcjs/typedoc.json ./import/api.js.sxcjs/docFx",

"import-jsng": "npm run import-jsng1-pre-clean && npm run import-jsng2-typedoc && npm run import-jsng3-docfx",
"import-jsng1-pre-clean": "cd import && delete.cmd \".\\api.js.sxc-angular\"",
"import-jsng2-typedoc": "cd \"../../2sxc-ui/projects/dnn-sxc-angular\" && typedoc --tsconfig ./tsconfig.typedoc.json --json \"../../../2sxc-docs/2sxc Docs Generator/import/api.js.sxc-angular/typedoc.json\"",
"import-jsng3-docfx": "type2docfx ./import/api.js.sxc-angular/typedoc.json ./import/api.js.sxc-angular/docFx"

},
"author": "",
"license": "ISC",
"devDependencies": {
"@2sic.com/2sxc-typings": "^11.0.0",
"@types/jquery": "^2.0.33",
"@types/node": "^20.10.5",
"type2docfx": "^0.10.5",
"typedoc": "^0.15.8",
"typescript": "^4.7.4"
"typescript": "^4.9.5"
},
"dependencies": {
"highlightjs-cshtml-razor": "^2.1.1"
}
}
6 changes: 3 additions & 3 deletions 2sxc Docs Generator/pages/abyss/cdn/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,9 @@ You can also just keep the parts you need and copy them to your site, eg. to `/c

The easiest way to do it is by using a simple setting in the UI like this:

<img src="./assets/cdn-settings-1.jpg" width="32%" class="img.float-left">
<img src="./assets/cdn-settings-2.jpg" width="32%" class="img.float-left">
<img src="./assets/cdn-settings-3.jpg" width="32%" class="img.float-left">
<img src="./assets/cdn-settings-1.jpg" width="32%" class="img.float-start">
<img src="./assets/cdn-settings-2.jpg" width="32%" class="img.float-start">
<img src="./assets/cdn-settings-3.jpg" width="32%" class="img.float-start">

This is a [Patrons Sentinel](xref:Patrons.Sentinel) only feature.
So if you want it fast, simple and fire/forget, just become a patron 🦸🏽‍♀️.
Expand Down
2 changes: 1 addition & 1 deletion 2sxc Docs Generator/pages/abyss/data-formats/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
- name: XML for Tables
topicUid: Basics.DataFormats.Xml.Table.Index

- name: "<hr>"
- name: " "

- name: Internal JSON V1 format
topicUid: Basics.DataFormats.JsonV1.Index
Expand Down
Loading

0 comments on commit 691b218

Please sign in to comment.