Web Html CLI

List of Starsky Projects

• By App documentation database photo index & import index project
  • starsky web api application / interface
    • clientapp react front-end application
  • starskyImporterCli import command line interface
  • starskyGeoCli gpx sync and reverse 'geo tagging'
  • starskyWebHtmlCli publish web images to a content package
  • starskyWebFtpCli copy a content package to a ftp service
  • starskyAdminCli manage user accounts
  • starskySynchronizeCli check if disk changes are updated in the database
  • starskyThumbnailCli speed web performance by generating smaller images
  • Starsky Business Logic business logic libraries (.NET)
  • starskyTest mstest unit tests (for .NET)
• starsky-tools nodejs tools to add-on tasks
• Starsky Desktop Desktop Application
  • Download Desktop App Windows and Mac OS version
• Changelog Release notes and history

starskyWebHtmlCli docs

Introduction:

For example to generate content for a blog, the 'Web HTML Cli' can be used. This application is used to create thumbnail web images and 'pre render' html files. All actions are customizable in the appsettings.json. There is a section called publishProfiles in appsettings.json. The publishProfiles are executed during runtime.

To the help dialog:

./starskywebhtmlcli --help

The StarskyWebHtmlCli --Help window:

Starksy WebHtml Cli ~ Help:
--help or -h == help (this window)
--path or -p == parameter: (string) ; fullpath (select a folder), use '-p' for current directory
--name or -n == parameter: (string) ; name of blogitem
--verbose or -v == verbose, more detailed info
  use -v -help to show settings:

Configuration

ContentType

There are options to do predefined tasks

• html, uses razor to generate html files
• jpeg, resizes images to smaller files
• moveSourceFiles, move action to child folder
• publishContent move content from WebHtmlPublish/PublishedContent to the output directory
• publishManifest include manifest in output folder. Manifest is needed to use starskyWebFtpCli
• onlyFirstJpeg, resize only the first Image, useful for og:images

SourceMaxWidth

The width in pixels of the output image. This is used only for ContentType jpeg.

OverlayMaxWidth

The width of the overlay image (you can add a logo as overlay) over the output image. This is used only for ContentType jpeg.

Path

When using ContentType html this is the filename of the rendered html file. With ContentType jpeg, this is the 'full file path' of the image used in OverlayMaxWidth

Replacer in Path

There is option to replace the {AssemblyDirectory} value with the path of the starsky assemblies. This is not using AppSettings.BaseDirectoryProject but the assemblies inside StarskyWebHtmlCli

Template

Used with ContentType html to select the Razor template file

'Pre pend'

In ContentType html this is used to add text before the urls used in the html output.

Replacer in 'Pre pend'

There is option to replace the {Name} value with the slug-name of the item. A slug name is the name in lowercase and the spaces are replaced with dashes.

Append

In ContentType jpeg this used to add text after the current filename

Folder

When using ContentType jpeg there are child folders created with this name. In the example there are 'sub folders' created with names 1000 and 500. In ContentType moveSourceFiles this is the folder to move the file to. The only exception is when using it from the WebUI, then move means copy

Example configuration

{
    "app" :{
        "publishProfiles": {
            "_default": [
                {
                    "ContentType":  "html",
                    "SourceMaxWidth":  0,
                    "OverlayMaxWidth":  0,
                    "OverlayFullPath": "",
                    "Path": "index.html",
                    "Template": "Index.cshtml",
                    "Prepend": "",
                    "Copy": "true"
                },
                {
                    "ContentType":  "html",
                    "SourceMaxWidth":  0,
                    "OverlayMaxWidth":  0,
                    "OverlayFullPath": "",
                    "Path": "index.web.html",
                    "Template": "Index.cshtml",
                    "Prepend": "https://media.qdraw.nl/log/{name}",
                    "Copy": "true"
                },
                {
                    "ContentType":  "html",
                    "SourceMaxWidth":  0,
                    "OverlayMaxWidth":  0,
                    "OverlayFullPath": "",
                    "Path": "autopost.txt",
                    "Template": "Autopost.cshtml",
                    "Prepend": "https://media.qdraw.nl/log/{name}",
                    "Copy": "true"
                },
                {
                    "ContentType":  "jpeg",
                    "SourceMaxWidth":  1000,
                    "OverlayMaxWidth":  380,
                    "Path": "{AssemblyDirectory}/WebHtmlPublish/EmbeddedViews/qdrawlarge.png",
                    "Folder": "1000",
                    "Append": "_kl1k",
                    "Copy": "true"
                },
                {
                    "ContentType":  "jpeg",
                    "SourceMaxWidth":  500,
                    "OverlayMaxWidth":  200,
                    "Path": "{AssemblyDirectory}/WebHtmlPublish/EmbeddedViews/qdrawsmall.png",
                    "Folder": "500",
                    "Append": "_kl",
                    "Copy": "true",
                    "MetaData": "false"
                },
                {
                    "ContentType":  "moveSourceFiles",
                    "Folder": "orgineel",
                    "Copy": "false"
                },
                {
                    "ContentType":  "publishContent",
                    "Folder": "",
                    "Copy": "true"
                },
                {
                    "ContentType": "publishManifest",
                    "Folder": "",
                    "Copy": "true"
                },
                {
                    "ContentType":  "onlyFirstJpeg",
                    "SourceMaxWidth":  213,
                    "Folder": "",
                    "Append": "___og_image",
                    "Copy": "true",
                    "MetaData": "false"
                }
            ],
            "no_logo_2000px": [
                {
                    "ContentType":  "jpeg",
                    "SourceMaxWidth":  2000,
                    "OverlayMaxWidth":  0,
                    "Folder": "",
                    "Append": "_kl2k",
                    "Copy": "true"
                }
            ]
        }
    }
}