docs: ssg: update docs for new classes

This commit is contained in:
Nick Vella 2019-07-19 20:11:20 +10:00
parent 844881a840
commit e34474d996
3 changed files with 7 additions and 5 deletions

View File

@ -11,7 +11,9 @@ Please note that this diagram only describes classes created as part of the Stat
|Name|Role and description|Dependency summary|
|---|---|---|
|StaticSiteClient|Serves as the primary interface between Open Live Writer and the Static Site Generator support. Implements Blog functions such as CRUD on posts and pages.|<ul><li>Implements IBlogClient</li><li>Inherits BlogClientBase</li><li>Creates a private `StaticSiteConfig` and loads its contents from the provided `IBlogClientCredentialsAccessor` on initiation.</li></ul>|
|StaticSiteConfig|Defines and handles the storage and processing of configuration settings for the Static Site Generator support.|<ul><li>Instantiated in `StaticSiteClient`</li><li>Used-by-reference in `StaticSiteConfigDetector`.</li><li>Instantiates a `StaticSitePostFrontMatterKeys`, to be loaded from stored config values.</li></ul>|
|StaticSitePost|Represents a published or yet-to-be-published post to `StaticSiteClient`. Contains methods related to loading from disk, saving to disk, and generating safe on-disk slugs and IDs, as well as other functionality.|<ul><li>Contains a `BlogPost` (from `OpenLiveWriter.Extensibility.BlogClient`)</li><li>Generates a `StaticSitePostFrontMatter` on attribute request</li></ul></ul>|
|StaticSitePostFrontMatter|Defines and stores all possible static post front matter keys. Implements loading and saving from YAML, as well as loading and saving from a `OpenLiveWriter.Extensibility.BlogClient.BlogPost` instance.|<ul><li>Instantiated by `StaticSitePost` on request.</li><li>Retrieves and stores a `StaticSitePostFrontMatterKeys` from `StaticSiteConfig` on construction.</li></li></ul>|
|StaticSitePostFrontMatterKeys|A subset of the static site config, `StaticSitePostFrontMatterKeys` contains the key names for each of the supported front-matter attributes. Used to support different static site generators.|<ul><li>Instantiated by StaticSiteConfig.</li><li>Used-by-reference in StaticSitePostFrontMatter</li></ul>|
|StaticSiteConfig|Defines and handles the storage and processing of configuration settings for the Static Site Generator support.|<ul><li>Instantiated in `StaticSiteClient`</li><li>Used-by-reference in `StaticSiteConfigDetector`.</li><li>Instantiates a `StaticSiteItemFrontMatterKeys`, to be loaded from stored config values.</li></ul>|
|StaticSiteItem|Abstract class which represents a published or yet-to-be-published generic item to `StaticSiteClient`. Contains methods related to loading and saving, as well as generic methods which are based upon through sub-classes.|<ul><li>Contains a `BlogPost` (from `OpenLiveWriter.Extensibility.BlogClient`)</li><li>Generates a `StaticSiteItemFrontMatter` on attribute request</li><li>Abstract class, never instantiated.</li></ul>|
|StaticSitePost|Sub-class of `StaticSiteItem` representing a Post item.|Sub-classes `StaticSiteItem`|
|StaticSitePage|Sub-class of `StaticSiteItem` representing a Page item.|Sub-classes `StaticSiteItem`|
|StaticSiteItemFrontMatter|Defines and stores all possible static item front matter keys. Implements loading and saving from YAML, as well as loading and saving from a `OpenLiveWriter.Extensibility.BlogClient.BlogPost` instance.|<ul><li>Instantiated by `StaticSiteItem` on request.</li><li>Retrieves and stores a `StaticSiteItemFrontMatterKeys` from `StaticSiteConfig` on construction.</li></li></ul>|
|StaticSiteItemFrontMatterKeys|A subset of the static site config, `StaticSiteItemFrontMatterKeys` contains the key names for each of the supported front-matter attributes. Used to support different static site generators.|<ul><li>Instantiated by StaticSiteConfig.</li><li>Used-by-reference in StaticSiteItemFrontMatter</li></ul>|

View File

@ -1 +1 @@
<mxfile modified="2019-07-14T12:45:14.764Z" host="www.draw.io" agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/77.0.3843.0 Safari/537.36 Edg/77.0.218.0" etag="L-J8EW54X759AdE5xb7X" version="10.9.6" type="device"><diagram id="x-93gLlAT9IVamWt818S" name="Page-1">7Vldb9sgFP01flxk8Gcem6TdtLXapFTaM7OJzYbBwqRJ9ut3iXEc12mTdqniSpUqFc69xnDOvRdMHG9arD8rUuZ3MqXcwW66dryZgzHyMXbMn5tuaiRyxzWQKZZapxaYs7/Ugq5FlyylVcdRS8k1K7tgIoWgie5gRCm56rotJO++tSQZ7QHzhPA++pOlOq/ROHBb/AtlWd68GbnWUpDG2QJVTlK52oO8a8ebKil13SrWU8oNeQ0v9XM3T1h3E1NU6FMe0EgmXzORotU0qKIHuZ7R4BOK62EeCF/aFdvZ6k1DQabksrRuVGm6PkQ8+dW4u/2Jod1yIU6oLKhWG3CxA4X2CRshvu2uWrojFNRYvke13zBNrMTZbuSWBWhYIl5CinecFFCzNE0TUFQ53mQhhZ5bO4J+VZKEiexelgZwAQGOmhDycFgDu9gxBBngh6yYZlIAxOkCLJNcF9yO+aQI+2Q/o3NfgguSfIDjkJsFM2hkppFwUlWOCajaAO/Z2eaaaJbMmaZTzszaHwu0R9sqB7c56GFMK6hTb0LlumFs5EcoHMcIediNgqAT3EE/uFGIRnEcRmPsBzj2XNxXIXgrEfDZRJBiwbLBiIDDaBSEOB57boyiEA1Zg6jHGk1hC7JdqXQuMykIv27RCVRkkVIzqiksrc+trMsNgL+p1hu7n5Kllt1KQkV6ZXZH6KaMFFKk9zkTteGGmQVsR4aeHQK7O73M9F6jFqxRLlVCj8ejJiqjzw54WH1FOQTkQ3d2Zxfs0O7wH0kzoxr2T6kGkzz+2B+Fge/GsRu4HvIHXcHiHm0f2XMse7xLZs94oIKhCwjmv4dy55+r3MHR9r0c0zw8rCrXfA1/ZA04BidmjX/JrAnOmTU3Cj4u74jWdDinhGeP2IPLHzTQ/LnEMSE8MX/wJfMH9a9cPhQ7plhwScXC4xWv0mqZ6JeWvG90U72PsoeiV5W96M3K3gmaCFLQakveYVm+l1TcQvD8VMCyGk24zOobt1H9rxq1wvVUAvYfXWFCCMg/8OXL4YPXmwkpTN4uILUeQYSzzFyCJvCK7f2q0ZIlhF9ZQ8HSdJv0h+TvFoLzB8Oevrutbl9R/HJFodv+FrC17f2i4l3/Aw==</diagram></mxfile>
<mxfile modified="2019-07-19T09:40:37.237Z" host="www.draw.io" agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/77.0.3851.0 Safari/537.36 Edg/77.0.222.0" etag="wgDhGxTTou8UyHA1W7yy" version="11.0.0" type="device"><diagram id="x-93gLlAT9IVamWt818S" name="Page-1">7Vpbb6M4FP41eZwIm/vjNG13Z7fdqZSRKs2bCw54x9jIOLf59WMHEyCQNG0uZVcjVQ0+PhhzvvN9PmBG9iRb/SFQnj7yGNMRtOLVyL4dQQgcCEf6z4rXpSWwjCERJDZOtWFKfmJjtIx1TmJctBwl51SSvG2MOGM4ki0bEoIv224zTttXzVGCO4ZphGjX+kximZq7cK3a/icmSVpdGVimJ0OVszEUKYr5smGy70b2RHAuy6NsNcFUB6+KS3ne/Z7e7cQEZvKYEyTg0V8Ji8Fy4hb+gq9usfsJBOUwC0Tn5o7NbOW6CkEi+DzvXs1MYIGFxKs+LNBLNUJ9uypPMM+wFGvlZ84KTYBMhjimuazD7QO3tKWNUDtVpJGBONmOXEdBHZhAvCUo9utBUWjm+lAnFBYj+2bGmZyafqDaRY4iwpJvPNcGS1lUQKoUsqFXGra5owOkDU+8IJJwpkwUz1TPTSozasbsgnAY1F1ouhBcJciP0P7n50NBJtPk+yydL7Ivt84npxNSHCvmmSYXMuUJZ4je1dYblYgsxnpUHc/a54GXUVbGf7GUayMjaC55O4CYxZ+1KKhmTFDGWfwtJazsuCe04WaGgNY27Hp6e6l3EIeCz0WED8TC5JtEIsEHB+wHUWCKJFm0Z9cH2OZUFQC0bjjknDBZNEZ+0oaantD3WvwE/o7O7PiDABzyVwflDOrU2d7KCZTtYaxHNX2IOkj0QURRoW7TqjrUdbZ9U6kCGE2JxBNKNKi7udnIoWWq3KaK3bprqVa9ixCz0sZwHPrACwMAbGj5rtsKrduVSuCBcRB4fggdFwZ2tdo2Oe1eSjfh2UDgbEaSwYBg23DsejAIbSsAvgeGjIE/UFm19snqu1T0UPodp6IdPT9BVk8CrK/WOIE0t1iq0ouLwZDHdawxUP+CwHItGziDVrCgE7bf7OnP14GwJxwoYHuryPMVjR8md3vKPtheF+Huk0N5Q+asGva3lqPhwepyGNWo87qmq1+UaeGl3RZ6KaRAkdxa22dUrY3vi3jbKvFF4mwwa8Ph6taGw1ocqldS/3Ox6XV0jxQbZ1Crg3uu2kqz5l5wJh+RlHhYxZW178lkcPwBA+XPFaor70j+wEHxB3Tfe/5GrF9jBoKY97riqdpirmuLt0ne33hd/DdkD3jue2TPv5jsHYEJQxkuNsHrh+VrjtmDSp5noaIsxjeUJ+WLynH5U4xr4DooqaDu7COoFOA/8IRTLpSFcaZ5O1PU2jEhShK9ExGpS2w2OTREJEL0s+nISBxvSN8Hf1sIzp8MDXy3S10TUXiprQv3g1XxhfLoR68mlsBWu0ztuhDY19jKOPap1LmSSh6a5Ol14RMv3rlX0LNteiQI+5+mdh6mYEsWYSV6168GezHwBkuiHcp0OXVxEh27H/ihJDrbi+sn/QnGUEgEQnfsNGnkfBCLVLP+NqR8MVV/YWPf/QI=</diagram></mxfile>

Binary file not shown.

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 25 KiB