generator/AWSPSGeneratorLib/Writers/Help/ServiceCmdletsPageWriter.cs

using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Xml;
using AWSPowerShellGenerator.Generators;

namespace AWSPowerShellGenerator.Writers.Help
{
    internal class ServiceCmdletsPageWriter : BasePageWriter
    {
        readonly string _moduleName;
        readonly string _title;
        private readonly IEnumerable<TOCCmdletEntry> _cmdlets;

        public ServiceCmdletsPageWriter(GeneratorOptions options, string outputFolder, string moduleName, string title, IEnumerable<TOCCmdletEntry> cmdlets)
            : base(options, outputFolder)
        {
            this._moduleName = moduleName;
            this._title = title;
            this._cmdlets = cmdlets;
        }

        public override string GetTOCID()
        {
            return string.Format("{0}_cmdlets", _moduleName.Replace(' ', '_').Replace('/', '_'));
        }

        public override string GenerateFilename()
        {
            return string.Format("{0}_cmdlets.html", _moduleName.Replace(' ', '_').Replace('/', '_'));
        }

        protected override string GetTitle()
        {
            return _title;
        }

        protected override string GetName()
        {
            return "AWS Tools for PowerShell - " + GetTitle();
        }

        protected override string GetService()
        {
            return GetModuleAvailability(_moduleName);
        }

        protected override string GetMetaDescription()
        {
            return string.Format("{0} Cmdlets", _moduleName);
        }

        protected override void WriteContent(System.IO.TextWriter writer)
        {
            AddCmdlets(writer);
        }

        void AddCmdlets(TextWriter writer)
        {
            var legacyAliases = new List<TOCCmdletEntry>();

            // might want sectioned output in future, eg to document type extensions
            AddMemberTableSectionHeader(writer, "Cmdlets", false);
            foreach (var cmdlet in _cmdlets.OrderBy(x => x.CmdletName))
            {
                AddRow(writer, cmdlet, "class");
                if (!string.IsNullOrEmpty(cmdlet.LegacyAlias))
                    legacyAliases.Add(cmdlet);
            }
            AddMemberTableSectionClosing(writer);

            if (legacyAliases.Count > 0)
            {
                AddMemberTableSectionHeader(writer, "Aliases", false);
                foreach (var cmdlet in legacyAliases.OrderBy(x => x.LegacyAlias))
                {
                    AddLegacyAliasRow(writer, cmdlet, "class");
                }
                AddMemberTableSectionClosing(writer);
            }
        }

        void AddRow(TextWriter writer, TOCCmdletEntry cmdlet, string cssImageClass)
        {
            writer.WriteLine("<tr>");

            writer.WriteLine("<td>");
            writer.WriteLine("<a href=\"./{0}.html\">{0}</a>", cmdlet.CmdletName);
            writer.WriteLine("</td>");

            writer.WriteLine("<td>");
            writer.WriteLine(cmdlet.Synopsis);
            writer.WriteLine("</td>");

            writer.WriteLine("</tr>");
        }

        void AddLegacyAliasRow(TextWriter writer, TOCCmdletEntry cmdlet, string cssImageClass)
        {
            writer.WriteLine("<tr>");

            writer.WriteLine("<td>");
            writer.WriteLine("<a href=\"./{0}.html\">{1}</a>", cmdlet.CmdletName, cmdlet.LegacyAlias);
            writer.WriteLine("</td>");

            writer.WriteLine("<td>");
            writer.WriteLine(cmdlet.Synopsis);
            writer.WriteLine("</td>");

            writer.WriteLine("</tr>");
        }
    }
}