html to maml converter · html to maml converter using the converter this topic will walk you...

HTMLtoMAMLConverter

WelcomeWelcometotheHTMLtoMAMLConverter.ThisutilityisusedtoconvertHTMLfilestoMicrosoftAssistanceMarkupLanguage(MAML)topicfilessothattheycanbecompiledintohelpfilesusingtheSandcastleHelpFileBuilderwiththeselectedpresentationstyle'slookandfeel.Theutilityislocatedinthe.\Extrasfolderundertheroothelpfilebuilderinstallationfolder(typicallyC:\ProgramFiles(x86)\EWSoftware\SandcastleHelpFileBuilder).

WhatisConceptualContent?Conceptualcontentallowsyoutodefinenon-APIdocumentationthatisincludedinthehelpfileforusagenotes,walkthroughs,tutorials,etc.InsteadofHTML,conceptualcontenttopicsuseMicrosoftAssistanceMarkupLanguage(MAML).ThisisbasicallyXMLconformingtoawelldefinedschemathatdescribesthestructureoftheconceptualcontentmuchlikeXMLcommentsdescribethestructureofthecodecomments.ThereisnolayoutorstyleinformationwithintheMAMLfiles.Instead,theyareranthroughaseriesofXSLtransformationsusingSandcastle'sBuildAssemblertoolsimilartothereference(API)contentsothattheymatchitinappearanceandfeatures.ThisallowsyoutoutilizethevariousSandcastleandthird-partybuildcomponentstoalterandextendthepresentationstyleusedinthetopics.

Theterm"conceptualcontent"isactuallyacatch-alltermusedtorefertothevarioustypesofcontentthatmayappearinthehelpfile.MAMLactuallydefinesseveraldifferentcontenttypes,eachusedforaspecifictypeofdocument(conceptual,glossary,how-to,reference,etc.).EachtypehasaspecificstructurewithvariousrequiredandoptionalXMLelements.FormoreinformationonMAML,thevarioustopictypes,andthevariouselementsthatyoucanusewithinthem,seetheSandcastleMAMLGuide.

TheConverterUtilityThepurposeofthisutilityistoquicklyconvertabatchofHTMLfiles(or.topicfilesusedbytheSandcastleHelpFileBuilder)intoMAMLtopicstosaveyoufromhavingtodoitmanually.SincetheconversiontoMAMLisnotperfect,youwillstillneedtoreviewthetopicsafterwardstocleanupanyunresolvedissuesandToDoitems

notedintheconversionlog.TheconverterwilltransformtheHTMLtopicsintothegenericConceptualtopicformat.IfyourequirethatatopicconformtooneoftheotherMAMLtopicformatssuchasWalkthrough,HowTo,Glossary,etc.youwillneedtomakethenecessaryadjustmentsafterwards.

SeeAlsoOtherResourcesUsingtheConverterVersionHistoryLinkstoResources

SendcommentsonthistopictoEric@EWoodruff.us

HTMLtoMAMLConverter

LicenseThistopiccontainsthefollowingsections:

MicrosoftPublicLicense(Ms-PL)CopyrightNotices

MicrosoftPublicLicense(Ms-PL)Thislicensegovernsuseoftheaccompanyingsoftware.Ifyouusethesoftware,youacceptthislicense.Ifyoudonotacceptthelicense,donotusethesoftware.

1. Definitions

Theterms"reproduce,""reproduction,""derivativeworks,"and"distribution"havethesamemeaninghereasunderU.S.copyrightlaw.

A"contribution"istheoriginalsoftware,oranyadditionsorchangestothesoftware.

A"contributor"isanypersonthatdistributesitscontributionunderthislicense.

"Licensedpatents"areacontributor'spatentclaimsthatreaddirectlyonitscontribution.

2. GrantofRights

(A)CopyrightGrant-Subjecttothetermsofthislicense,includingthelicenseconditionsandlimitationsinsection3,eachcontributorgrantsyouanon-exclusive,worldwide,royalty-freecopyrightlicensetoreproduceitscontribution,preparederivativeworksofitscontribution,anddistributeitscontributionoranyderivativeworksthatyoucreate.

(B)PatentGrant-Subjecttothetermsofthislicense,includingthelicenseconditionsandlimitationsinsection3,eachcontributorgrantsyouanon-exclusive,worldwide,royalty-freelicenseunderitslicensedpatentstomake,havemade,use,sell,offerforsale,import,and/orotherwisedisposeofitscontributioninthesoftwareorderivativeworksofthecontributioninthesoftware.

3. ConditionsandLimitations

(A)NoTrademarkLicense-Thislicensedoesnotgrantyourightstouseanycontributors'name,logo,ortrademarks.

(B)Ifyoubringapatentclaimagainstanycontributoroverpatentsthatyouclaimareinfringedbythesoftware,yourpatentlicensefromsuchcontributortothesoftwareendsautomatically.

(C)Ifyoudistributeanyportionofthesoftware,youmustretainallcopyright,patent,trademark,andattributionnoticesthatarepresentinthesoftware.

(D)Ifyoudistributeanyportionofthesoftwareinsourcecodeform,youmaydosoonlyunderthislicensebyincludingacompletecopyofthislicensewithyourdistribution.Ifyoudistributeanyportionofthesoftwareincompiledorobjectcodeform,youmayonlydosounderalicensethatcomplieswiththislicense.

(E)Thesoftwareislicensed"as-is."Youbeartheriskofusingit.Thecontributorsgivenoexpresswarranties,guaranteesorconditions.Youmayhaveadditionalconsumerrightsunderyourlocallawswhichthislicensecannotchange.Totheextentpermittedunderyourlocallaws,thecontributorsexcludetheimpliedwarrantiesofmerchantability,fitnessforaparticularpurposeandnon-infringement.

HTMLtoMAMLConverter

UsingtheConverterThistopicwillwalkyouthroughusingtheconvertertoconvertabatchofHTMLfilestoMAMLtopics.

UsingtheConverter1. Theconverterisaconsolemodeapplication.Assuch,opena

commandpromptinordertorunit.Theutilityislocatedinthe.\Extrasfolderundertheroothelpfilebuilderinstallationfolder(typicallyC:\ProgramFiles(x86)\EWSoftware\SandcastleHelpFileBuilder).

TheconverterusesanXMLfilethatcontainstheconversionrules.Thisfilemustresideinthesamefolderastheconverter'sexecutable.

2. Theconvertertakesafoldernamecontainingthefilestoconvertasthefirstparameterandthenameofanewfolderinwhichtoplacetheconvertedtopicsandsupportingfilesasthesecondparameter.Thefoldernamesmustbedifferentbutthenewfolderdoesnothavetoexistandwillbecreatedifnecessary.Belowisanexamplecommandline:

Anoptionalparameter,/companion,canalsobespecifiedtocreatecompanionfilesfortheconvertedtopics.Thisisusefulifyourdocumentationtool,suchasDocProject,makesuseofthemtostorethetopictitle,helpattributes,andindexkeywords.

ConvertHtmlToMaml.exeC:\MyLibrary\DocC:\MyLibrary\Content

ConvertHtmlToMaml.exeC:\MyLibrary\DocC:\MyLibrary\Content/companion

ExampleCommandLine

CreateOptionalCompanionFiles

Anoptionalparameter,/moveIntro,canalsobespecifiedtoindicatethattheconvertershouldmoveanytopictextprecedingthefirstsectionelementcreatedintotheintroductionelement.ThisoptionmayproducebetterresultsincaseswhereyourHTMLtopicscontainleadingtextbeforethefirstheaderelement,suchasanH1element,thatshouldappearintheMAMLtopic'sintroductionelement.IfyourtopicslackanHTMLheaderelement,thisoptionwilltypicallymovetheentiretopictextintotheintroductionelementwhichisprobablynotwantedandtheoptionshouldbeomitted.Inthatcase,adefaultintroductionelementisinsertedintoeachtopicandyoucanmovetextintoitduringtheclean-upphase.

Whilethedestinationfolderwillbecreatedifitdoesnotalreadyexist,itwillnotbeclearedofanyexistingcontent.Assuch,youcanconvertmultiplebatchesoffilesintoonefolder.However,youshouldrenametheconversionlogandthesupportingfilesbetweenrunsifyouwanttokeepthem.

3. Astheconverterruns,itwritesinformationtotheconsoleasitgoes.Thisinformationisalsosavedtoalogfileinthedestinationfolder.

4. Oncefinished,thereviewprocesscanbegintocleanupanyissuesandToDoitemsintheconvertedtopics.Thelogfilecanhelpyoulocateitemsthatneedattention.

SeeAlsoOtherResourcesTheConversionProcessAdditionalOutputFilesWarningsandToDoItemsCommonIssuesandSolutions

ConvertHtmlToMaml.exeC:\MyLibrary\DocC:\MyLibrary\Content/moveIntro

CopyMoveLeadingTexttoIntroduction

HTMLtoMAMLConverter

TheConversionProcessUnlikeMAMLtopicswhichmustbewell-formedXML,HTMLfilesarenotnecessarilyasstrictintheirconformancetosuchrules.Endtagsarenotalwayspresent,the"/"inself-closingtagsisnotalwayspresent,entitiesarenotalwaysencodedcorrectlyifatall,etc.Assuch,theHTMLtoMAMLconverterextractskeypartsoftheHTMLfilesandusesaseriesofregularexpressionspairedwithmatchevaluatorstoaltertheHTMLelementsbyreplacingthemwiththeirMAMLequivalentsorremovingthemaltogether.

WhilethiswillnotguaranteeavalidMAMLtopic,itwillguaranteethatnoinformationislostduringtheconversion.Buildingtheconvertedtopicsrevealsanymissingendtags,unencodedentities,etc.whichareeasilyfixedbyeditingthetopics.

TheconversionrulesarestoredinanXMLconfigurationfile.Thisfilemustresideinthesamelocationastheconverter'sexecutable.

TheConversionProcessConversionofatopicfollowsthisgeneralprocedureusingtheruledefinitionsfoundintheconfigurationfile:

1. Extractthekeypartsofthetopic(metadatasuchasthetitle,attributes,andindexkeywords,andthebodytext).

2. Replacenamedentitieswiththeirnumericequivalent.

3. ReplacemarkupwrapperHTMLelementswithaplaceholderinthetextsoasnottoaltertheircontentinlaterprocessing.

4. RemoveallHTMLelementswithnoMAMLequivalent.

5. ReplaceallHTMLelementsthatdohaveMAMLequivalents.

6. ThefollowingHTMLelementsareprocessedbasedonthecontextinwhichtheyareused:

a-LinkstotopicsandexternalURLs

code-Inlinecodeandcodeblocks

h1-h6-Sectionheadings

img-Imagelinks

see-SeeAlsoreferences

Theseelementsshouldnotappearinanyoftheotherrules.

7. Oncedone,themarkupwrapperplaceholdersarereplacedwiththeiractualmarkupenclosedinaMAMLmarkupelement.

8. Theconvertedtopicissavedtothedestinationfolderalongwithsomesupportingfiles.

SeeAlsoOtherResourcesUsingtheConverter

HTMLtoMAMLConverter

MetadataTopicElementsCertaintopicelementsnotrepresentedintherulesfilearesearchedforinordertoextractcommonmetadatathatwillbeassociatedwiththeconvertedtopicfiles:

TheTitleElementIndexKeywordElementsHelpAttributeElementsSandcastleHelpFileBuilderSpecialCommentTags

Allelementnamesarematchedcase-insensitively.

TheTitleElementTheHTMLfileshouldcontainastandardtitleelementthatdefinesthepagetitle.Ifnotfound,itwillbeleftblankinanyofthesupportingcontentfiles.

IndexKeywordElementsIftheparserfindsanyMSHelp:Keywordelements,itwillextracttheindexnameandthetermandwillsavethemtothesupportingcontentfiles.

HelpAttributeElementsIftheparserfindsanyMSHelp:Attrelements,itwillextracttheattributenameandvalueandwillsavethemtothesupportingcontentfiles.Ifthenameoftheattributeis"Abstract",thecontentoftheattributeiswrittenouttothetopicfileinthesummaryelement.Thiselementbecomestheabstractwhenthetopiciscompiledforthehelpfile.

SandcastleHelpFileBuilderSpecialCommentTagsIfthefileparserfindsanyofthespecialcommenttagsusedbytheSandcastleHelpFileBuildersuchas@TOCExclude,@SplitTOC,@DefaultTopic,and@SortOrderitwillextractthemandusethemwhengeneratingthesupportingcontentfilestomaintaintheexistinglayoutofthetopics.

SeeAlsoOtherResourcesTheConversionProcess

HTMLtoMAMLConverter

ConversionRuleElementsTheconversionrulesaredefinedinanXMLfilethatconsistsoffivemainparts.Eachpartisdescribedinthefollowingtopics.Thedefaultrulesetshouldworkquitewellformostdocumentsbutyouarefreetoalterandextendtherulesshouldtheynotmeetyourrequirements.

TheConversionRulesElementsSelectatopicbelowtolearnmoreabouteachelement:

TheBodyExtractElement

EntitiesRules

MarkupWrapperRules

RemoveRules

ReplaceRules

Withtheexceptionofentitynamevalues,allotherattributeandregularexpressionrulevaluesarematchedcase-insensitively.

HTMLtoMAMLConverter

TheBodyExtractElementThiselementdefinestheregularexpressionusedtoextractthebodyoftheHTMLdocument.

RuleProcessingBydefaultitextractsthe<body>(.htmlfiles)or<bodyText>(.topicfiles)elementcontent.The"body"partoftheregularexpressionmustbeanamedgroupcalledBody.Oneexamplewhereyoumightwanttomodifythisisifyourdocumentbodiescontainseveralsectionscontainedwithindivelements.Youcanaltertheexpressiontoextractthespecificdivthatcontainsjustthebodytextthusexcludingtheotherunwantedpartsofthedocument.

SinceitresidesinanXMLfile,anyspecialcharactersintheexpressionsuchas<,>,&,",and'mustbeencodeasshownintheexamplebelow.Theregularexpressionismatchedcase-insensitively.

SeeAlsoOtherResourcesTheConversionProcessConversionRuleElements

<BodyExtractexpression="<\s*div\s*class="Main"[^>]*?>

(?<Body>.*?)<\s*/\s*div?\s*>"/>

CopyExampledivExtract

HTMLtoMAMLConverter

EntitiesRulesThissectiondefinesnamedentitiesthatmustbeconvertedtotheirnumericequivalentintheMAMLtopicfiles.

RuleProcessingThe.NETXMLparseronlyrecognizesthecommonASCIInamedentities(&,<,>,",and').OnceconvertedtoMAML,thetopicsareprocessedasXMLfilesand,assuch,anyothernamedentitiesinthetopicwillcausethebuildprocesstofail.ThissectiondefinesallothernamedentitiescommonlyfoundinHTMLfilesandtheirreplacementnumericequivalent.Duringconversion,anynamedentitiesfromthissectionfoundinatopicarereplacedwiththeirnumericform(i.e.©wouldbecome©).

TheentriesconsistofEntityelementswithanameattributethatdefinesthenamedentityandavalueattributethatdefinesthenumericvaluetouseasitsreplacement.

Unliketheotherrules,entitynamevaluesarematchedcase-sensitivelyasthenumericvaluesforuppercaseandlowercasenamevaluesdifferasshownintheexamplebelow.

SeeAlso

<Entityname="Aacute"value="193"/>

<Entityname="aacute"value="225"/>

<Entityname="Acirc"value="194"/>

<Entityname="acirc"value="226"/>

</Entities>

CopyExampleEntitiesEntries

OtherResourcesTheConversionProcessConversionRuleElements

HTMLtoMAMLConverter

MarkupWrapperRulesThissectiondefinesHTMLelementsthatthemselvesorwhosecontentmustberetainedasHTMLintheconvertedtopics.

RuleProcessingCertainHTMLelementsmayneedspecialhandlinginordertoreplacetheminaMAMLtopicortheymayneedtobeleftas-is.Thissectionletsyoudefinesuchelements.Whenconverted,theaffectedelementiswrappedinaMAMLmarkupelementprecededbya""comment.Duringthereviewprocess,youcandecidewhethertokeeptheelementorremoveitinfavororsomealternatecontent.

TheentriesconsistofTagelementswithanameattributethatdefinestheHTMLelementtobewrapped.

Allnamevaluesarematchedcase-insensitively.

Caution

Itisnotrecommendedthatanyotherelementsbeaddedtothecurrentlydefinedlist.WhileitispossibletopassthroughHTMLusingthemarkupMAMLelement,itshouldnotbeabusednorshoulditbeusedwhereMAMLequivalentsdoexist.

<Tagname="applet"/>

<Tagname="bgsound"/>

<Tagname="button"/>

<Tagname="embed"/>

<Tagname="fieldset"/>

<Tagname="form"/>

CopyMarkupEntries

<Tagname="frameset"/>

<Tagname="iframe"/>

<Tagname="ilayer"/>

<Tagname="input"/>

<Tagname="label"/>

<Tagname="layer"/>

<Tagname="map"/>

<Tagname="noembed"/>

<Tagname="nolayer"/>

<Tagname="noscript"/>

<Tagname="object"/>

<Tagname="script"/>

<Tagname="select"/>

<Tagname="sound"/>

<Tagname="textarea"/>

<Tagname="xml"/>

</MarkupWrapper>

HTMLtoMAMLConverter

RemoveRulesThissectiondefinesHTMLelementsthatmustberemovedfromtheconvertedtopicsbecausetheylackaMAMLequivalent.

RuleProcessingCertainHTMLelementshavenoMAMLequivalentandservenopurposeiftheyappearoutsideofanelementhandledbythemarkupwrapperrules.Insuchcases,theseelementsaresimplyremoved.Anytextwithintheelementswillappearinthetopicasnormaltext.

TheentriesconsistofTagelementswithanameattributethatdefinestheHTMLelementtoberemoved.

Allnamevaluesarematchedcase-insensitively.

<Tagname="area"/>

<Tagname="base"/>

<Tagname="basefont"/>

<Tagname="bdo"/>

<Tagname="blink"/>

<Tagname="center"/>

<Tagname="col"/>

<Tagname="colgroup"/>

<Tagname="del"/>

<Tagname="font"/>

<Tagname="frame"/>

<Tagname="include"/>

<Tagname="ins"/>

<Tagname="isindex"/>

<Tagname="keygen"/>

CopyRemoveEntries

<Tagname="legend"/>

<Tagname="link"/>

<Tagname="marquee"/>

<Tagname="meta"/>

<Tagname="multicol"/>

<Tagname="nextid"/>

<Tagname="nobr"/>

<Tagname="noframes"/>

<Tagname="optgroup"/>

<Tagname="option"/>

<Tagname="param"/>

<Tagname="plaintext"/>

<Tagname="rt"/>

<Tagname="ruby"/>

<Tagname="s"/>

<Tagname="spacer"/>

<Tagname="strike"/>

<Tagname="style"/>

<Tagname="tbody"/>

<Tagname="tfoot"/>

<Tagname="wbr"/>

</Remove>

HTMLtoMAMLConverter

ReplaceRulesThissectiondefinesHTMLelementsthatcanbereplacedwithaMAMLequivalent.

RuleProcessingTherulesinthissectionmakeanattemptatreplacingHTMLelementswiththeclosestMAMLequivalent.TheentriesconsistofTagelementswithvariousattributecombinationsthatdefinetheHTMLelementanditsreplacement.NestedMatchelementscanbeusedtofurtherrefinehowthereplacementoccurs.

TheTagelementcancontainthefollowingattributes:

Attribute Purposename TheHTMLelementtoreplace.Thisattributeis

required.

startTag Thevaluetouseasthereplacementopeningtag.Ifomittedandnonestedmatchrulesaremet,theelementwillberemoved.Ifthereplacementvaluecontains"<"or">",thevalueisusedasaverbatimreplacement.Ifnotpresent,thereplacementiswrappedin"<"and">".Anyattributesandtheself-closing"/"areincludedifnecessary.

endTag Thevaluetouseasthereplacementclosingtag.Normally,thisisomittedandthestartTagvalueisusedfortheclosingtagaswell.However,ifitdiffers,thiscanbeusedtospecifythevalueforit.AswithstartTag,ifthereplacementvaluecontains"<"or">",thevalueisusedasaverbatimreplacement.Ifnotpresent,thereplacementiswrappedin"</"and">".

attributes ThiscanbeusedtodefineareplacementsetofattributesthatwillappearontheMAML

element.Ifomitted,allattributesfromtheHTMLelementareremovedandtheMAMLelementwillnothaveanyattributes.Ifsettothevalue"@Preserve",theHTMLattributeswillbepreservedandwillbeaddedasattributesonthereplacementMAMLelementas-is.Foranyothervalue,thespecifiedtextreplacestheHTMLattributes.IfstartTagcontains"<"or">",thisattributeisignored.

Allnameandregularexpressionvaluesarematchedcase-insensitively.

DefiningAdditionalMatchRulesIncertaincases,itmaybenecessarytodefineadditionalmatchconditionstodefinethereplacementMAMLelement.Todothis,addoneormoreMatchelementsaschildrenoftherelatedTagelement.

TheMatchelementcancontainthesameattributesastheTagelementinanyneededcombination.Inaddition,ithasarequiredexpressionattributethatdefinestheregularexpressionusedtomatchthespecificinstanceofanHTMLelement.Ifamatchismade,theotherattributesontheMatchelementareusedinsteadoftheattributesontheparentTagelement.Ifnoneoftheexpressionsresultinamatch,theattributesontheparentTagelementareevaluatedasusual.

ExampleReplacementRulesNote

SincetheyresidesinanXMLfile,anyspecialcharactersintheexpressionssuchas<,>,&,",and'mustbeencodeasshownintheexamplebelow.

<Tagname="abbr"startTag="phrase"/>

<Tagname="b"startTag="legacyBold"/>

CopyExampleReplaceEntries

<Tagname="br"startTag="<para/>"/>

<Tagname="comment"startTag="<--"endTag="-->"

<Tagname="div">

<!--Ifamatchfor'class="deprecated"'isfound,replaceitwith

analert.Ifnotmatched,theelementisremoved.-->

<Matchexpression="class="deprecated""

attributes="class="warning""/>

</Tag>

<Tagname="pre"startTag="code"attributes="language="none"title="""

<!--However,ifalang/languageattributeisdefined,preserve

theHTMLattributes.-->

<Matchexpression="lang(uage)?="startTag="code"

</Tag>

<Tagname="span">

<Matchexpression="class="code""startTag

<Matchexpression="class="command""startTag

<Matchexpression="class="foreignPhrase""

</Tag>

</Replace>

HTMLtoMAMLConverter

Context-basedConversionsThefollowingHTMLelementsmustbeconvertedbasedontheircontextwithinthetopic.Sincethecontextishardtotranslateintoaneasilydefinedruleintherulesfile,theelementsdescribedinthistopicarehandledbytheapplicationitself.Assuch,theseelementsshouldnotappearinanyofthepreviouslydefinedrules.

AnchorElementsCodeElementsHeadingElementsImageElementsSeeElements

Allelementnamesarematchedcase-insensitively.

AnchorElementsHTMLanchorelements(a)arereplacedasfollows:

Anchorswithanameattributeareassumedtobein-pagelinktargets.TheMAMLequivalentofsuchalinktargetisanaddressattributeonanelementsuchassection,definedTerm,listItem,etc.Tryingtoplaceanaddressattributeontheappropriateelementisalmostimpossiblesotheseanchortypesarereplacedwitha""commentforlaterreview.Awarningisalsowrittentothelogfile.

AnexceptionistargetsinsideofheadingHTMLelements.Ifproperlyformatted,thesewillbeconvertedtoaddresselementsontherelatedsectionelementwhentheheadingelementsareprocessed(seebelow).

Ifthelink'sURLcontains"://",startswith"mailto:",orthelinkspecifiesatargetattributeitisconvertedtoanexternalLink.

Allotherlinksareconvertedtolinkelements.IfthetopicID

cannotberesolvedusingthefilenamefromtheHTMLhrefattribute,itisreplacedwitha""commentforlaterreviewandawarningiswrittentothelogfile.

Linkinnertextwillberetainedifitdiffersfromthetargettopic'stitle.Inaddition,anin-pagelinksuffixwillberetained(i.e.SomePage.htm#InPageLink).

CodeElementsThenormalcodeHTMLelementisequivalenttotheMAMLcodeInlineelement.However,tosupportconversionoftheSandcastleHelpFileBuilderoptionofincludingcodeblocksfromexternalfiles,thiselementisreplacedbasedonthefollowingcontexts:

Ifnoattributesarepresentontheelementandnocarriagereturn/linefeedsarepresentintheelement'sinnertext,itisreplacedwithaMAMLcodeInlineelement.

IfanyattributesarepresentontheHTMLelementorifitsinnertextcontainsmultiplecarriagereturn/linefeeds,itisreplacedwithaMAMLcodeelementandanyattributesarepreserved.

Intheeventthatnoattributesarepresentandonlyasinglecarriagereturn/linefeedpairarepresentintheinnertext,itisassumedthatthevaluesimplyspansalinebreakanditisreplacedwithacodeInlineelementinstead.

HeadingElementsHTMLheadingelements(h1throughh6)arereplacedwithasectionelement.Thecontentoftheheadingelementbecomesthesectiontitleandisplacedinthesection'stitleelement.Thetextfollowingtheheadingbecomesthecontentofthesection.Whenanewheadingelementisencountered,closingsectionelementsareinsertedasneeded.Closingsectionelementsarealsoaddedtotheendofthebodytextifatleastoneheadingwasencounteredtocloseoffthefinalsection.

Anchorelementsareprocessedbeforeheadingelements.Assuch,

ifanamedanchorisreplacedwithaToDocommentanditappearswithintheheadingtag,itwillbeconvertedtoanaddressattributeonthesectionautomaticallyasshownintheexamplebelow.Thissavesyoufromhavingtodoitmanuallybutyoushouldstillreviewtheupdatetomakesurethatitisappropriate.

MAMLsectionscanbenestedwithinoneanother.However,attemptingtodothisduringconversionwouldbeverydifficultandwouldmostlikelyresultinchangesthatwerenotintendedorarenotappropriate.Assuch,noattemptismadetonestsectionswithahigherheadingnumberintoprioroneswithalowerheadingnumber(i.enestingh2sectionswithinanh1section).Theheadingelementthatcausedthesectiontobecreatedisaddedinacommentfollowingthesectionelement.Youcanreviewthetopicafter

Seethe<ahref="#BuildLogFile">BuildLogFile</a>property

<h3><aclass="Reference"name="BuildLogFile">TheBuildLogFileProperty

<p>Sectioncontent</p>

Seethe<linkxlink:href="#BuildLogFile">BuildLogFile

<sectionaddress="BuildLogFile">

<title>TheBuildLogFileProperty</title>

<para>Sectioncontent</para>

</content>

</section>

OriginalHTML

ConvertedMAML

conversiontodecidewhethertoleavethetopicasitisorreworkthecontenttonestsectionswithinoneanother.

ImageElementsHTMLimageelements(img)arereplacedwithanexternalLinkifthesrcattributecontains"://".Ifnot,theimageisassumedtobelocaltotheprojectandisconvertedtoamediaLink.NotethatitisnotpossibletodeterminewhetherornottouseamediaLinkInlineelementinstead.Assuch,youwillneedtoupdatethelinkduringthereviewafterconversion.FormediaLinkelements,youmayneedtoaddacaptionelementifneededandotherattributestoproperlysettheimagealignmentaswell.

Whenanewimageisencountered,itisaddedtothemediacontentfilecreatedbytheconversionprocessandtheimagefileiscopiedtotheMedia\folderunderthedestinationfolder.Thesourceimagelocationisdeterminedbycombiningthesourceconversionfolderwiththepathfromthesrcattribute.Iftheimagefilecannotbefound,thereplacementelementisprefixedwitha""commentnotingthemissingfileandawarningiswrittentothelogfile.

SeeElementsTheSandcastleHelpFileBuildersupportsseeelementswithinadditionalcontentHTMLfiles.Whenencountered,theseareconvertedtolinkstothematchingAPImembertopics.Tomatchthisbehavior,ifaseeelementisencounteredduringconversion,itisconvertedtoanappropriatecodeEntityReferenceelement.

Thehelpfilebuilderhastheabilitytoresolveareferencebasedonapartialname.However,MAMLrequiresthatthenamebefullyqualified.Assuch,ifapartialnameisencountered,itwillstillbeconvertedbutawarningwillbewrittentothelogfile.Thesewillneedtobefixedduringthereviewtoreplacethemwiththeirfullyqualifiednames.

ConversionRuleElements

HTMLtoMAMLConverter

AdditionalOutputFilesThefollowingfilesarecreatedinadditiontotheconvertedtopicfilesandcanbefoundinthedestinationfolderaftertheconversionhascompleted.

_Conversion.logThisfilecontainstheoutputfromtheconversionprocess.RefertoittofindanywarningsandnotesonToDoitemsthatneedattention.

_ContentTokens.tokensTheSandcastleHelpFileBuilderallowscustomtagstoappearintheadditionalcontentfilesthatareresolvedatbuildtimeintoprojectpropertyvalues.SinceitisnotallowabletoplacethemdirectlyinMAMLtopics,theyareextractedandreplacedwithatoken.ThetagsinthetokenfilewillbereplacedatbuildtimewiththeirprojectvaluesandBuildAssemblerwillreplacethetokensinthetopicswiththeresultingtokenvalue.Ifnoreplacementtagsarefound,thetokenfilewillnotbecreated.

_ContentLayout.contentThisfilecontainsthecontentlayoutbasedontheconvertedtopics.Thiscanbeaddedtoahelpfilebuilderproject(version1.8.0.0orlater)alongwiththeconvertedfilesandfoldersandeditedtosetthelayoutofthetopicsinthecompiledhelpfile.Ifusingsomeotherdocumentationtool,youwillneedtoimportthetopicsanddefinetheirlayoutusingwhatevertoolsthatitmayprovide.

TheMediaFolderThisfolderwillcontainthemediafiles(images)foundduringtheconversionprocess.Thesefilescanbeaddedtothehelpproject.

Media\_MediaFiles.xmlThisfileisthemediacontentfilethatcontainstheimageIDsandalternatetextvaluesforimagesreferencedinmediaLinkelementsintheconvertedtopics.Itcanbeaddedtothehelpprojectorimporteddependingonhowyourdocumentationtoolmakesuseofsuchfiles.

SeeAlsoOtherResourcesTheConversionProcessWarningsandToDoItems

HTMLtoMAMLConverter

WarningsandToDoItemsThistopicdescribesthevariouswarningsandToDoitemsyouwillseeintheconversionlogfileandtheconvertedtopics.

WarningsThefollowingwarningsmayappearinthelogfile.

Warning:Foundunknowntag[tag]whichwillberemovedThiswarningappearsifanHTMLelementisencounteredthatisnotcoveredbyoneoftherulesdefinedintheconfigurationfile.Insuchcases,theunknowntagwillberemoved.

Warning:Imagefile'[file]'notfoundThiswarningappearswhenanHTMLimagelinkisconvertedtoamediaLinkandthesourcefilecouldnotbefound.Whilethelinkwillstillbecreatedandanentrymadeinthemediacontentfile,thecorrespondingsourcefilewillnotbefoundinthemediafolderafterconversion.Youwillneedtomanuallylocatethefileandaddittotheproject.

Warning:Namedanchor[id]needsreviewThiswarningappearswhenanHTMLanchorelementwithanameattributeisencountered.ThisisareminderthatyouwillneedtoeditthetopicandapplyanaddressattributewiththespecifiedIDtotheappropriateMAMLelement.RefertotheSandcastleMAMLGuideforinformationonwhichelementssupportanaddressattribute.

Warning:Referencetocodeentity[id]isnotfullyqualifiedThiswarningappearsifacodeEntityReferenceisaddedandthetargetspecifiedinthesourceHTMLfileisnotafullyqualifiedname.Youwillneedtoupdatethesetospecifythefullyqualifiedname.Ifnot,thereferencewillnotberenderedasalinkwhenthetopicisbuilt.

Warning:Unabletoresolvetopiclinkto'[file]'ThiswarningappearswhenthetargetfileofanHTMLanchorcouldnotbefoundinanyoftheconvertedtopics.Insuchcases,aToDoentryinthetopicreplacesthelinkandyouwillneedto

locatethefileandaddthelinkwhenreviewingthetopic.

Warning:Unknownentityencountered:[entity]Thiswarningappearsifanamedentityisencounteredthatisnotdefinedintheentityconversionrules.Insuchcases,theentityispassedthroughtotheconvertedtopicas-is.Whenyoubuildthetopic,itwillmostlikelyfailbecausethe.NETXMLparserwillnotrecognizeit.Theentitywillneedtobecorrectedorremoved.

ToDoItemsWhilereviewingtopicsafterconversion,youwillseevarious""comments.Thefollowingitemsdescribewhateachofthemmeans.

TODO:Addnamedanchor:[id]ThiscommentappearsintheplaceofanamedHTMLanchor.ThisisareminderthatyouwillneedtoapplytheindicatedIDasanaddressattributeontheappropriateMAMLelementlocatednearthecomment.RefertotheSandcastleMAMLGuideforinformationonwhichelementssupportanaddressattribute.

TODO:Missingsourceimage:[file]ThiscommentappearswhenanHTMLimagelinkisconvertedtoamediaLinkandthesourcefilecouldnotbefound.Whilethelinkwillstillbecreatedandanentrymadeinthemediacontentfile,thecorrespondingsourcefilewillnotbefoundinthemediafolderafterconversion.Youwillneedtomanuallylocatethefileandaddittotheproject.

TODO:MoveintroductiontexthereThisToDoitemwillbeseenintherequiredintroductionsectionthatisaddedtoeverytopic.Sincetheconversionprocesscannotguesswhattextyoumightwanttoappearthere,itleavesitforyoutohandleduringthereview.

TODO:ReferencenotfullyqualifiedThiscommentappearsnexttoacodeEntityReferenceinwhichthetargetisnotafullyqualifiedname.Youwillneedtoupdatethereferencetospecifythefullyqualifiedname.Ifnot,thereferencewillnotberenderedasalinkwhenthetopicisbuilt.

TODO:Reviewmarkup

ThiscommentprecedesanyHTMLelementswrappedintheMAMLmarkupelement.Thecontentoftheelementshouldbereviewedtoseeifitshouldberetained,removed,oreditedtouseotherappropriateMAMLelements.

TODO:Unknowntopiclink:[file]ThiscommentappearsinplaceofanHTMLanchorwhentheindicatedtargetfile/IDcouldnotbefoundinanyoftheconvertedtopics.Insuchcases,youwillneedtolocatethefileandaddthelinkwhenreviewingthetopic.

SeeAlsoOtherResourcesTheConversionProcessAdditionalOutputFiles

HTMLtoMAMLConverter

CommonIssuesandSolutionsThistopiccoverssomecommonissuesthatyouwillencounterwhenreviewingtopicsafterconversionalongwithtipsonsolvingthem.

MissingendelementsThesecanbefoundbyperformingabuildwithyourpreferreddocumentationtool.Theerrormessagewilllistthefailingtopicalongwiththeelementname(s)andthelinenumberandcolumnwherethestartingandendingelementsdidnotmatchup.Tofixtheissue,editthetopicandaddthemissingendelementinthecorrectlocation.

Ill-formedorunencodedentitiesHTMLisquiteforgivingwhenitcomestoill-formedorunencodedentitiesbutXMLisnot.Examplesincludemissingtheendingsemi-colon(&ltratherthan<)ornotencodingitatall(using&&inexamplecoderatherthan&&).Thesecanalsobefoundbydoingabuildandlocatingtheoffendingentityviatheinformationprovidedintheerrormessage.

TableheaderformattingislostWhenanHTMLtableisconvertedtoMAML,anythelementsareconvertedtotheequivalententryMAMLelement.Thisresultsintheheadercellbeingrenderedasanormalcellinthetable.Inordertorenderthecellsusingthetableheadingstyle,wrapthecontainingrowelementtoatableHeaderelement.Forexample:

<table>

<entry><para>Column1</para></entry>

<entry><para>Column2</para></entry>

</row>

</tableHeader>

<entry><para>Value1</para></entry>

ImagelinktypeandalignmentAsnotedintheContext-basedConversionstopic,youmayneedtochangemediaLinkelementstomediaLinkInlineelementswhereappropriate.Inaddition,youmayneedtoaddcaptionsand/orsetthealignmentattributesbasedonyourpreferences.

ParagraphspacingisinconsistentOmittingparaelementsaroundparagraphsorusingself-closingparaelementscancausesomeinconsistentspacingbetweenparagraphs.Tomakeitconsistent,wrapallparagraphsinopeningandclosingparaelements.

SeeAlsoOtherResourcesUsingtheConverterTheConversionProcess

<entry><para>Value2</para></entry>

</row>

<entry><para>ValueA</para></entry>

<entry><para>ValueB</para></entry>

</row>

</table>

HTMLtoMAMLConverter

LinkstoResourcesThistopicscontainslinkstovariousresourcesthatyoumayfinduseful.

LinkstoResourcesMicrosoft.NETFrameworksandSDKs.

ThelatestversionoftheSandcastleHelpFileBuilder(currentlythev2015.10.10.0releaseasofOctober10,2015).

TodiscusstheSandcastletoolsandextras,suggestnewfeatures,reportbugs,andrequesthelpusingthem,visittheSandcastleHelpFileBuilderprojectsite.

Fordiscussionandquestionsabouthelpsystemsingeneral,visittheVisualStudioGeneralQuestionsforum.

TheretiredMicrosoftDeveloperDocumentationandHelpSystemforummayalsoprovideinformationonolderhelpsystems.

MAMLInformationandGuidesForacomprehensivelistofMAMLdocumentationtagsandadescriptionoftheirattributesandusageseetheSandcastleMAMLGuidealsoincludedwiththehelpfilebuilder.

Forgeneralbackgroundinformation,seetheWikipediaentryMicrosoftAssistanceMarkupLanguageor,forschemainformation,seetheMAMLinformationathelp-info.de.

HTMLtoMAMLConverter

GlossaryA|B|C|D|E|F|G|H|I|J|K|L|M|N|O|P|Q|R|S|T|U|V|W|X|Y|Z

CconceptualbuildAbuildthatusesSandcastletoproducehelpfiletopicsusinginformationextractedfromconceptualcontenttopicsandtheirrelatedfiles.

SeeAlso:referencebuild,Sandcastle

conceptualcontentAtopicfilethatcontainsconceptualcontent.Thesecanbeusedtoaddusagenotes,walkthroughs,tutorials,etc.toahelpfile.

GGloballyUniqueIdentifier,GUIDAuniquevaluethatisassociatedwitheachconceptualtopicandimageinaproject.Wheninsertinglinkstotopicsorimages,theIDisusedtorefertothem.Thisallowsyoutoalterthenamesorlocationsofthetopicfileswithouthavingtochangethenameorlocationineachtopicthatreferencesthem.

MMAMLAnacronymthatstandsforMicrosoftAssistanceMarkupLanguage.ConceptualcontenttopicsarecomposedofMAMLelements.

mediacontentfile

ThisfilecontainsinformationabouttheimagesreferencedinmediaLinkandmediaLinkInlineelementsinconceptualcontent.

RreferencebuildAbuildthatusesSandcastletoproducehelpfiletopicsusinginformationextractedfrommanagedassembliesandtheirassociatedXMLcommentsfiles.

SeeAlso:conceptualbuild,Sandcastle

SSandcastleSandcastleisasetoftoolsoriginallyproducedbyMicrosoftthatcanbeusedtobuildhelpfilesfor.NETmanagedlibraries,conceptualcontent,oramixofboth.MicrosoftofficiallydiscontinueddevelopmentinOctober2012.TheSandcastletoolshavebeenmergedwiththeSandcastleHelpFileBuilderprojectandaredevelopedandsupportedtherenowaspartofthatproject.

SeeAlso:SandcastleHelpFileBuilder

SandcastleHelpFileBuilder,SHFBTheSandcastleHelpFileBuilderisastandalonetoolusedtoautomateSandcastle.ItconsistsofaGUIfrontendthathelpsyoumanageandbuildhelpfileprojects.ItusesastandardMSBuildformatprojectfilewhichcanalsobybuiltfromthecommandlineusingMSBuildorintegratedintoVisualStudiobuildsorotherbuildscriptstoproduceahelpfilewhenyourapplicationprojectsarebuilt.Inaddition,itprovidesasetofadditionalfeaturesbeyondthosesuppliedwithSandcastlethatcanimproveyourhelpfileandmakeiteasiertodeploy.

SeeAlso:Sandcastle

Ttoken,tokenfile

Atokenisusedasareplaceabletagwithinatopicandisrepresentedusingatokenelement.Theinnertextoftheelementisatokenname.Thetokensaredefinedinaseparatetokenfile.Theyareaneasywaytorepresentcommonitemsthatyouuseregularlysuchasacommonphraseorexternallink.

HTMLtoMAMLConverter

VersionHistoryThetopicsinthissectiondescribethevariouschangesmadetotheHTMLtoMAMLConverteroverthelifeoftheproject.

VersionHistorySelectaversionbelowtoseeadescriptionofitschanges.

Version1.0.0.1

Version1.0.0.0

HTMLtoMAMLConverter

Version1.0.0.1Version1.0.0.1wasreleasedonJuly26th,2010.

ChangesinThisReleaseFixedabugthatcausedacrashwhenaJavaScriptreferencewasencounteredinananchortag'sHREFattribute.Suchreferencesarenowignoredandawarningiswrittentothetopicandthelogfileinstead.

SeeAlsoOtherResourcesVersionHistory

HTMLtoMAMLConverter

Version1.0.0.0Version1.0.0.0wasreleasedonOctober25th,2008.

ChangesinThisReleaseInitialrelease.

SeeAlsoOtherResourcesVersionHistory

HTMLtoMAMLConverter

HtmlToMamlConversionNamespaceThisnamespacecontainstheclassesusedtoconvertHTMLfilestoMAMLtopicfiles.

Classes Class Description

ConversionProgressEventArgs ThisisacustomeventargumentsclassfortheConversionProgressevent.

ConvertHtmlToMaml ThisutilityisusedtoconvertHTMLfilestoMAMLtopicsandcreatesomesupportingfiles.

FileParser ThisisusedtoparseanHTMLfiletoextractthevariouspartsforconversiontoMAML

HtmlToMaml ThisclassisusedtoconvertasetofHTMLfiletotheircloseequivalentasconceptualMAML

topicfiles.

ImageReference Thisrepresentsanimagereference

ImageReferenceCollection Thisisacollectionofimagereferences

TagOptions ThisisusedtocontaintheoptionsandstateforaTagentryfromtheconversionrulesfile.

Topic Thisrepresentsatopicfile

TopicCollection Thisisacollectionoftopicitems

HTMLtoMAMLConverter

ConversionProgressEventArgsClassThisisacustomeventargumentsclassfortheConversionProgressevent.

InheritanceHierarchySystemObjectSystemEventArgsHtmlToMamlConversionConversionProgressEventArgs

Namespace:HtmlToMamlConversionAssembly:ConvertHtmlToMaml(inConvertHtmlToMaml.exe)Version:1.0.0.2

Syntax

TheConversionProgressEventArgstypeexposesthefollowingmembers.

Constructors Name Description

ConversionProgressEventArgs Constructor

Properties

publicclassConversionProgressEventArgs:EventArgs

CopyC# VB C++ F#

Name Description

Message Getthemessageassociatedwiththeprogressreport

Methods Name Description

Equals Determineswhetherthespecifiedobjectisequaltothecurrentobject.(InheritedfromObject.)

Finalize Allowsanobjecttotrytofreeresourcesandperformothercleanupoperationsbeforeitisreclaimedbygarbagecollection.(InheritedfromObject.)

GetHashCode Servesasthedefaulthashfunction.(InheritedfromObject.)

GetType GetstheTypeofthecurrentinstance.(InheritedfromObject.)

MemberwiseClone CreatesashallowcopyofthecurrentObject.(InheritedfromObject.)

ToString Returnsastringthatrepresentsthecurrentobject.(InheritedfromObject.)

SeeAlsoReferenceHtmlToMamlConversionNamespace

HTMLtoMAMLConverter

ConversionProgressEventArgsConstructorConstructor

Syntax

Parameters

progressMessageType:SystemStringTheprogressmessage

SeeAlsoReferenceConversionProgressEventArgsClassHtmlToMamlConversionNamespace

publicConversionProgressEventArgs(

stringprogressMessage

CopyC# VB C++ F#

HTMLtoMAMLConverter

ConversionProgressEventArgsPropertiesTheConversionProgressEventArgstypeexposesthefollowingmembers.

Properties Name Description

Message Getthemessageassociatedwiththeprogressreport

HTMLtoMAMLConverter

ConversionProgressEventArgsMessagePropertyGetthemessageassociatedwiththeprogressreport

Syntax

PropertyValueType:String

publicstringMessage{get;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

ConversionProgressEventArgsMethodsTheConversionProgressEventArgstypeexposesthefollowingmembers.

HTMLtoMAMLConverter

ConvertHtmlToMamlClassThisutilityisusedtoconvertHTMLfilestoMAMLtopicsandcreatesomesupportingfiles.

InheritanceHierarchySystemObjectHtmlToMamlConversionConvertHtmlToMaml

Syntax

TheConvertHtmlToMamltypeexposesthefollowingmembers.

Main Mainprogramentrypoint

publicstaticclassConvertHtmlToMaml

CopyC# VB C++ F#

HTMLtoMAMLConverter

ConvertHtmlToMamlMethodsTheConvertHtmlToMamltypeexposesthefollowingmembers.

Main Mainprogramentrypoint

SeeAlsoReferenceConvertHtmlToMamlClassHtmlToMamlConversionNamespace

HTMLtoMAMLConverter

ConvertHtmlToMamlMainMethodMainprogramentrypoint

Syntax

Parameters

argsType:SystemStringThecommandlinearguments(thesourcefolder,thedestinationfolder,andtheoptional"/companion"optiontocreatecompanionfilesforeachtopicfile).

ReturnValueType:Int32Zeroonsuccess,non-zeroonfailure

SeeAlsoReferenceConvertHtmlToMamlClassHtmlToMamlConversionNamespace

publicstaticintMain(

string[]args

CopyC# VB C++ F#

HTMLtoMAMLConverter

FileParserClassThisisusedtoparseanHTMLfiletoextractthevariouspartsforconversiontoMAML

InheritanceHierarchySystemObjectHtmlToMamlConversionFileParser

Syntax

TheFileParsertypeexposesthefollowingmembers.

FileParser InitializesanewinstanceoftheFileParserclass

Body ThisreturnstheHTML

publicclassFileParser

CopyC# VB C++ F#

bodyparsedfromthefile

BodyExtractExpression Thisisusedtogetorsetthebodyextractregularexpression

HelpAttributes Thisreturnsthehelpattributesparsedfromthefile

HelpKeywords Thisreturnsthehelpkeywordsparsedfromthefile

IsDefaultTopic Thisreturnsthedefaulttopicflagiffoundinthetopic

RevisionNumber Thisreturnstherevisionnumberparsedfromthefile

SortOrder Thisreturnsthesortordervalueiffoundinthetopic

SplitToc ThisreturnsthesplitTOCflagiffoundinthetopic

Title Thisreturnsthetitleparsedfromthefile

TocExclude ThisreturnstheTOCexcludeflagiffoundinthetopic

TopicAbstract Thisreturnstheabstract

parsedfromthefile

TopicId ThisreturnsthetopicIDparsedfromthefile

ParseFile ParsethespecifiedHTMLfile

ReadWithEncoding Thisisusedtoreadinafileusinganappropriateencodingmethod

HTMLtoMAMLConverter

FileParserConstructorInitializesanewinstanceoftheFileParserclass

Syntax

SeeAlsoReferenceFileParserClassHtmlToMamlConversionNamespace

publicFileParser()

CopyC# VB C++ F#

HTMLtoMAMLConverter

FileParserPropertiesTheFileParsertypeexposesthefollowingmembers.

Body ThisreturnstheHTMLbodyparsedfromthefile

BodyExtractExpression Thisisusedtogetorsetthebodyextractregularexpression

HelpAttributes Thisreturnsthehelpattributesparsedfromthefile

HelpKeywords Thisreturnsthehelpkeywordsparsedfromthefile

RevisionNumber Thisreturnstherevisionnumberparsedfromthefile

Title Thisreturnsthetitleparsedfromthefile

TopicAbstract Thisreturnstheabstractparsedfromthefile

TopicId ThisreturnsthetopicIDparsedfromthefile

HTMLtoMAMLConverter

FileParserBodyPropertyThisreturnstheHTMLbodyparsedfromthefile

Syntax

publicstringBody{get;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

FileParserBodyExtractExpressionPropertyThisisusedtogetorsetthebodyextractregularexpression

Syntax

ExceptionsException Condition

InvalidOperationException Thisisthrowniftheregularexpressionisnullorempty.

publicstaticstringBodyExtractExpression{get;set

CopyC# VB C++ F#

HTMLtoMAMLConverter

FileParserHelpAttributesPropertyThisreturnsthehelpattributesparsedfromthefile

Syntax

PropertyValueType:MSHelpAttrCollection

publicMSHelpAttrCollectionHelpAttributes{get;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

FileParserHelpKeywordsPropertyThisreturnsthehelpkeywordsparsedfromthefile

Syntax

PropertyValueType:MSHelpKeywordCollection

publicMSHelpKeywordCollectionHelpKeywords{get;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

FileParserIsDefaultTopicPropertyThisreturnsthedefaulttopicflagiffoundinthetopic

Syntax

PropertyValueType:Boolean

publicboolIsDefaultTopic{get;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

FileParserRevisionNumberPropertyThisreturnstherevisionnumberparsedfromthefile

Syntax

publicstringRevisionNumber{get;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

FileParserSortOrderPropertyThisreturnsthesortordervalueiffoundinthetopic

Syntax

PropertyValueType:Int32

publicintSortOrder{get;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

FileParserSplitTocPropertyThisreturnsthesplitTOCflagiffoundinthetopic

Syntax

publicboolSplitToc{get;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

FileParserTitlePropertyThisreturnsthetitleparsedfromthefile

Syntax

publicstringTitle{get;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

FileParserTocExcludePropertyThisreturnstheTOCexcludeflagiffoundinthetopic

Syntax

publicboolTocExclude{get;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

FileParserTopicAbstractPropertyThisreturnstheabstractparsedfromthefile

Syntax

publicstringTopicAbstract{get;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

FileParserTopicIdPropertyThisreturnsthetopicIDparsedfromthefile

Syntax

PropertyValueType:Guid

publicGuidTopicId{get;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

FileParserMethodsTheFileParsertypeexposesthefollowingmembers.

ParseFile ParsethespecifiedHTMLfile

ReadWithEncoding Thisisusedtoreadinafileusinganappropriateencodingmethod

HTMLtoMAMLConverter

FileParserParseFileMethodParsethespecifiedHTMLfile

Syntax

Parameters

filenameType:SystemStringThefiletoparse

RemarksAfterparsing,thepropertiescanbeusedtoretrievetheinformationparsedfromthefile.

publicvoidParseFile(

stringfilename

CopyC# VB C++ F#

HTMLtoMAMLConverter

FileParserReadWithEncodingMethodThisisusedtoreadinafileusinganappropriateencodingmethod

Syntax

Parameters

filenameType:SystemStringThefiletoload

encodingType:System.TextEncodingPassthedefaultencodingtouse.Onreturn,itcontainstheactualencodingforthefile.

ReturnValueType:StringThecontentsofthefile.

Remarks

publicstaticstringReadWithEncoding(

stringfilename,

refEncodingencoding

CopyC# VB C++ F#

Whenreadingthefile,usethedefaultencodingspecifiedbutdetecttheencodingifbyteordermarksarepresent.Inaddition,ifthetemplateisanXMLfileanditcontainsanencodingidentifierintheXMLtag,thefileisreadusingthatencoding.

HTMLtoMAMLConverter

HtmlToMamlClassThisclassisusedtoconvertasetofHTMLfiletotheircloseequivalentasconceptualMAMLtopicfiles.

InheritanceHierarchySystemObjectHtmlToMamlConversionHtmlToMaml

Syntax

TheHtmlToMamltypeexposesthefollowingmembers.

HtmlToMaml Constructor

BasePath Thisreturnsthesourcepathforuseasthebasepath

publicclassHtmlToMaml:IBasePathProvider

CopyC# VB C++ F#

PathProvider Thisreturnsthebasepathproviderfortheotherclassesinvolvedintheconversionthatneedrelativepaths.

ConvertTopic Thisiscalledtoconvertasingletopicanditschildren

ConvertTopics Thisiscalledtoperformtheactualconversion

CreateCompanionFile Createacompanionfileforatopic

OnConversionProgress ThisraisestheConversionProgressevent.

ReportProgress Thisisusedtoreportprogressduringtheconversion

Events Name Description

ConversionProgress Thiseventisraisedtoreportprogressinformationthroughouttheconversionprocess.

SeeAlsoReference

HtmlToMamlConversionNamespace

HTMLtoMAMLConverter

HtmlToMamlConstructorConstructor

Syntax

Parameters

sourceType:SystemStringThesourcepathcontainingtheHTMLfiles

destType:SystemStringThedestinationpathfortheMAMLtopicsandsupportingfiles

createCompanionType:SystemBooleanTruetocreatecompanionfilesforalltopicfilesorfalsetonotcreatethem.

moveIntroTextType:SystemBooleanIftrue,movetextbeforethefirstsectionintoanintroductionelement.Iffalse,insertaplaceholderintroductionelement.

publicHtmlToMaml(

stringsource,

stringdest,

boolcreateCompanion,

boolmoveIntroText

CopyC# VB C++ F#

SeeAlsoReferenceHtmlToMamlClassHtmlToMamlConversionNamespace

HTMLtoMAMLConverter

HtmlToMamlPropertiesTheHtmlToMamltypeexposesthefollowingmembers.

BasePath Thisreturnsthesourcepathforuseasthebasepath

PathProvider Thisreturnsthebasepathproviderfortheotherclassesinvolvedintheconversionthatneedrelativepaths.

HTMLtoMAMLConverter

HtmlToMamlBasePathPropertyThisreturnsthesourcepathforuseasthebasepath

Syntax

PropertyValueType:StringImplementsIBasePathProviderBasePath

publicstringBasePath{get;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

HtmlToMamlPathProviderPropertyThisreturnsthebasepathproviderfortheotherclassesinvolvedintheconversionthatneedrelativepaths.

Syntax

ReturnValueType:IBasePathProviderTheHtmlToMamlobjectperformingtheconversion.

publicstaticIBasePathProviderPathProvider{get;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

HtmlToMamlMethodsTheHtmlToMamltypeexposesthefollowingmembers.

ConvertTopic Thisiscalledtoconvertasingletopicanditschildren

ConvertTopics Thisiscalledtoperformtheactualconversion

CreateCompanionFile Createacompanionfileforatopic

OnConversionProgress ThisraisestheConversionProgressevent.

ReportProgress Thisisusedtoreportprogressduringtheconversion

HTMLtoMAMLConverter

HtmlToMamlConvertTopicMethodThisiscalledtoconvertasingletopicanditschildren

Syntax

Parameters

topicType:HtmlToMamlConversionTopicThetopictoconvert

publicvoidConvertTopic(

Topictopic

CopyC# VB C++ F#

HTMLtoMAMLConverter

HtmlToMamlConvertTopicsMethodThisiscalledtoperformtheactualconversion

Syntax

publicvoidConvertTopics()

CopyC# VB C++ F#

HTMLtoMAMLConverter

HtmlToMamlCreateCompanionFileMethodCreateacompanionfileforatopic

Syntax

Parameters

filenameType:SystemStringThecompanionfilename.

topicType:HtmlToMamlConversionTopicThetopic

publicstaticvoidCreateCompanionFile(

stringfilename,

Topictopic

CopyC# VB C++ F#

HTMLtoMAMLConverter

HtmlToMamlOnConversionProgressMethodThisraisestheConversionProgressevent.

Syntax

Parameters

eType:HtmlToMamlConversionConversionProgressEventArgsTheeventarguments

protectedvirtualvoidOnConversionProgress(

ConversionProgressEventArgse

CopyC# VB C++ F#

HTMLtoMAMLConverter

HtmlToMamlReportProgressMethodThisisusedtoreportprogressduringtheconversion

Syntax

Parameters

messageType:SystemStringThemessagetoreport

argsType:SystemObjectAlistofargumentstoformatintothemessagetext

protectedvoidReportProgress(

stringmessage,

paramsObject[]args

CopyC# VB C++ F#

HTMLtoMAMLConverter

HtmlToMamlEventsTheHtmlToMamltypeexposesthefollowingmembers.

ConversionProgress Thiseventisraisedtoreportprogressinformationthroughouttheconversionprocess.

HTMLtoMAMLConverter

HtmlToMamlConversionProgressEventThiseventisraisedtoreportprogressinformationthroughouttheconversionprocess.

Syntax

ValueType:SystemEventHandlerConversionProgressEventArgs

publiceventEventHandler<ConversionProgressEventArgs

CopyC# VB C++ F#

HTMLtoMAMLConverter

ImageReferenceClassThisrepresentsanimagereference

InheritanceHierarchySystemObjectHtmlToMamlConversionImageReference

Syntax

TheImageReferencetypeexposesthefollowingmembers.

ImageReference Constructor

AlternateText Getorsettheimage'salternatetext

publicclassImageReference

CopyC# VB C++ F#

Id Thisreturnstheimage'suniqueID

SourceFile Thisisusedtogetthesourceimagefilename

ToString Converttostringfordebuggingpurposes(OverridesObjectToString.)

HTMLtoMAMLConverter

ImageReferenceConstructorConstructor

Syntax

Parameters

sourceType:SystemStringThesourceimagefile

SeeAlsoReferenceImageReferenceClassHtmlToMamlConversionNamespace

publicImageReference(

stringsource

CopyC# VB C++ F#

HTMLtoMAMLConverter

ImageReferencePropertiesTheImageReferencetypeexposesthefollowingmembers.

AlternateText Getorsettheimage'salternatetext

Id Thisreturnstheimage'suniqueID

SourceFile Thisisusedtogetthesourceimagefilename

HTMLtoMAMLConverter

ImageReferenceAlternateTextPropertyGetorsettheimage'salternatetext

Syntax

publicstringAlternateText{get;set;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

ImageReferenceIdPropertyThisreturnstheimage'suniqueID

Syntax

publicstringId{get;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

ImageReferenceSourceFilePropertyThisisusedtogetthesourceimagefilename

Syntax

PropertyValueType:FilePath

publicFilePathSourceFile{get;set;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

ImageReferenceMethodsTheImageReferencetypeexposesthefollowingmembers.

HTMLtoMAMLConverter

ImageReferenceToStringMethodConverttostringfordebuggingpurposes

Syntax

ReturnValueType:StringThestringrepresentationofthetopic

publicoverridestringToString()

CopyC# VB C++ F#

HTMLtoMAMLConverter

ImageReferenceCollectionClassThisisacollectionofimagereferences

InheritanceHierarchySystemObjectSystem.Collections.ObjectModelCollectionImageReferenceHtmlToMamlConversionImageReferenceCollection

Syntax

TheImageReferenceCollectiontypeexposesthefollowingmembers.

ImageReferenceCollection InitializesanewinstanceoftheImageReferenceCollectionclass

Properties

publicclassImageReferenceCollection:Collection<

CopyC# VB C++ F#

Name Description

Count GetsthenumberofelementsactuallycontainedintheCollectionT.(InheritedfromCollectionImageReference.)

Item Getsorsetstheelementatthespecifiedindex.(InheritedfromCollectionImageReference.)

Items GetsaIListTwrapperaroundtheCollectionT.(InheritedfromCollectionImageReference.)

Add AddsanobjecttotheendoftheCollectionT.(InheritedfromCollectionImageReference.)

Clear RemovesallelementsfromtheCollectionT.(InheritedfromCollectionImageReference.)

ClearItems RemovesallelementsfromtheCollectionT.(InheritedfromCollectionImageReference.)

Contains DetermineswhetheranelementisintheCollectionT.(InheritedfromCollectionImageReference.)

CopyTo CopiestheentireCollectionTtoacompatibleone-dimensionalArray,startingatthespecifiedindexofthetargetarray.(InheritedfromCollectionImageReference.)

GetEnumerator ReturnsanenumeratorthatiteratesthroughtheCollectionT.(InheritedfromCollectionImageReference.)

IndexOf Searchesforthespecifiedobjectandreturnsthezero-basedindexofthefirstoccurrencewithintheentireCollectionT.(InheritedfromCollectionImageReference.)

Insert InsertsanelementintotheCollectionTatthespecifiedindex.(InheritedfromCollectionImageReference.)

InsertItem InsertsanelementintotheCollectionTatthespecifiedindex.(InheritedfromCollectionImageReference.)

Remove RemovesthefirstoccurrenceofaspecificobjectfromtheCollectionT.(InheritedfromCollectionImageReference.)

RemoveAt RemovestheelementatthespecifiedindexoftheCollectionT.(InheritedfromCollectionImageReference.)

RemoveItem RemovestheelementatthespecifiedindexoftheCollectionT.(InheritedfromCollectionImageReference.)

Save Writetheimagereferencecollectiontoamediacontentfile.

SetItem Replacestheelementatthespecifiedindex.(InheritedfromCollectionImageReference.)

HTMLtoMAMLConverter

ImageReferenceCollectionConstructorInitializesanewinstanceoftheImageReferenceCollectionclass

Syntax

SeeAlsoReferenceImageReferenceCollectionClassHtmlToMamlConversionNamespace

publicImageReferenceCollection()

CopyC# VB C++ F#

HTMLtoMAMLConverter

ImageReferenceCollectionPropertiesTheImageReferenceCollectiontypeexposesthefollowingmembers.

Count GetsthenumberofelementsactuallycontainedintheCollectionT.(InheritedfromCollectionImageReference.)

Item Getsorsetstheelementatthespecifiedindex.(InheritedfromCollectionImageReference.)

Items GetsaIListTwrapperaroundtheCollectionT.(InheritedfromCollectionImageReference.)

HTMLtoMAMLConverter

ImageReferenceCollectionMethodsTheImageReferenceCollectiontypeexposesthefollowingmembers.

Add AddsanobjecttotheendoftheCollectionT.(InheritedfromCollectionImageReference.)

Clear RemovesallelementsfromtheCollectionT.(InheritedfromCollectionImageReference.)

ClearItems RemovesallelementsfromtheCollectionT.(InheritedfromCollectionImageReference.)

Contains DetermineswhetheranelementisintheCollectionT.(InheritedfromCollectionImageReference.)

CopyTo CopiestheentireCollectionTtoacompatibleone-dimensionalArray,startingatthespecifiedindexofthe

targetarray.(InheritedfromCollectionImageReference.)

GetEnumerator ReturnsanenumeratorthatiteratesthroughtheCollectionT.(InheritedfromCollectionImageReference.)

IndexOf Searchesforthespecifiedobjectandreturnsthezero-basedindexofthefirstoccurrencewithintheentireCollectionT.(InheritedfromCollectionImageReference.)

Insert InsertsanelementintotheCollectionTatthespecifiedindex.(InheritedfromCollectionImageReference.)

InsertItem InsertsanelementintotheCollectionTatthespecifiedindex.(InheritedfromCollectionImageReference.)

Remove RemovesthefirstoccurrenceofaspecificobjectfromtheCollectionT.(InheritedfromCollectionImageReference.)

RemoveAt RemovestheelementatthespecifiedindexoftheCollectionT.(InheritedfromCollectionImageReference.)

RemoveItem RemovestheelementatthespecifiedindexoftheCollectionT.(InheritedfromCollectionImageReference.)

Save Writetheimagereferencecollectiontoamediacontentfile.

SetItem Replacestheelementatthespecifiedindex.(InheritedfromCollectionImageReference.)

HTMLtoMAMLConverter

ImageReferenceCollectionSaveMethodWritetheimagereferencecollectiontoamediacontentfile.

Syntax

Parameters

filenameType:SystemStringThefiletowhichtheimagereferencecollectionissaved.

publicvoidSave(

stringfilename

CopyC# VB C++ F#

HTMLtoMAMLConverter

TagOptionsClassThisisusedtocontaintheoptionsandstateforaTagentryfromtheconversionrulesfile.

InheritanceHierarchySystemObjectHtmlToMamlConversionTagOptions

Syntax

TheTagOptionstypeexposesthefollowingmembers.

TagOptions Constructor

Attributes Thisreturnstheattributestousebasedonthelastevaluation

publicclassTagOptions

CopyC# VB C++ F#

Closing Thisreturnstheclosing"/"iftheelementisanendtag

Tag Thisreturnsthereplacementtagtousebasedonthelastevaluation.

Evaluate Evaluatethematchanddeterminethepropertiestouseforthereplacement.

MemberwiseClone CreatesashallowcopyofthecurrentObject.

(InheritedfromObject.)

HTMLtoMAMLConverter

TagOptionsConstructorConstructor

Syntax

Parameters

tagType:System.Xml.XPathXPathNavigatorThetagnode

SeeAlsoReferenceTagOptionsClassHtmlToMamlConversionNamespace

publicTagOptions(

XPathNavigatortag

CopyC# VB C++ F#

HTMLtoMAMLConverter

TagOptionsPropertiesTheTagOptionstypeexposesthefollowingmembers.

Attributes Thisreturnstheattributestousebasedonthelastevaluation

Closing Thisreturnstheclosing"/"iftheelementisanendtag

Tag Thisreturnsthereplacementtagtousebasedonthelastevaluation.

HTMLtoMAMLConverter

TagOptionsAttributesPropertyThisreturnstheattributestousebasedonthelastevaluation

Syntax

publicstringAttributes{get;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

TagOptionsClosingPropertyThisreturnstheclosing"/"iftheelementisanendtag

Syntax

publicstringClosing{get;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

TagOptionsTagPropertyThisreturnsthereplacementtagtousebasedonthelastevaluation.

Syntax

publicstringTag{get;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

TagOptionsMethodsTheTagOptionstypeexposesthefollowingmembers.

Evaluate Evaluatethematchanddeterminethepropertiestouseforthereplacement.

HTMLtoMAMLConverter

TagOptionsEvaluateMethodEvaluatethematchanddeterminethepropertiestouseforthereplacement.

Syntax

Parameters

matchType:System.Text.RegularExpressionsMatchTheregularexpressionmatchtoevaluate

publicvoidEvaluate(

Matchmatch

CopyC# VB C++ F#

HTMLtoMAMLConverter

TopicClassThisrepresentsatopicfile

InheritanceHierarchySystemObjectHtmlToMamlConversionTopic

Syntax

TheTopictypeexposesthefollowingmembers.

Topic Constructor

Body Getorsetthetopic'sbody

HelpAttributes Getthehelpattributes

publicclassTopic

CopyC# VB C++ F#

collection

HelpKeywords Getthehelpkeywordscollection

Id Thisreturnsthetopic'suniqueID

RevisionNumber Getorsetthetopic'srevisionnumber

SourceFile ThisisusedtogetthesourceHTMLfilename

Subtopics Thisisusedtogetthecollectionofsub-topics,ifany

Title Getorsetthetopic'stitle

TopicAbstract Getorsetthetopic'sabstract

ParseFile Parsethetopicanditssub-topicfilestoextracttheinformationforconversion

HTMLtoMAMLConverter

TopicConstructorConstructor

Syntax

Parameters

sourceType:SystemStringThesourcefileornulltocreateanemptycontainernodewithnoassociatedtopic

SeeAlsoReferenceTopicClassHtmlToMamlConversionNamespace

publicTopic(

stringsource

CopyC# VB C++ F#

HTMLtoMAMLConverter

TopicPropertiesTheTopictypeexposesthefollowingmembers.

Body Getorsetthetopic'sbody

HelpAttributes Getthehelpattributescollection

HelpKeywords Getthehelpkeywordscollection

Id Thisreturnsthetopic'suniqueID

RevisionNumber Getorsetthetopic'srevisionnumber

SourceFile ThisisusedtogetthesourceHTMLfilename

Subtopics Thisisusedtogetthe

collectionofsub-topics,ifany

Title Getorsetthetopic'stitle

TopicAbstract Getorsetthetopic'sabstract

HTMLtoMAMLConverter

TopicBodyPropertyGetorsetthetopic'sbody

Syntax

publicstringBody{get;set;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

TopicHelpAttributesPropertyGetthehelpattributescollection

Syntax

PropertyValueType:MSHelpAttrCollectionIfnullorempty,therearenoattributes

publicMSHelpAttrCollectionHelpAttributes{get;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

TopicHelpKeywordsPropertyGetthehelpkeywordscollection

Syntax

PropertyValueType:MSHelpKeywordCollectionIfnullorempty,therearenokeywords

publicMSHelpKeywordCollectionHelpKeywords{get;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

TopicIdPropertyThisreturnsthetopic'suniqueID

Syntax

PropertyValueType:Guid

publicGuidId{get;set;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

TopicIsDefaultTopicPropertyThisreturnsthedefaulttopicflagiffoundinthetopic

Syntax

publicboolIsDefaultTopic{get;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

TopicRevisionNumberPropertyGetorsetthetopic'srevisionnumber

Syntax

publicstringRevisionNumber{get;set;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

TopicSortOrderPropertyThisreturnsthesortordervalueiffoundinthetopic

Syntax

PropertyValueType:Int32

publicintSortOrder{get;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

TopicSourceFilePropertyThisisusedtogetthesourceHTMLfilename

Syntax

PropertyValueType:FilePathIfsettonull,theitemwillrepresentacontainernodewithnoassociatedtopic.

publicFilePathSourceFile{get;set;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

TopicSplitTocPropertyThisreturnsthesplitTOCflagiffoundinthetopic

Syntax

publicboolSplitToc{get;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

TopicSubtopicsPropertyThisisusedtogetthecollectionofsub-topics,ifany

Syntax

PropertyValueType:TopicCollection

publicTopicCollectionSubtopics{get;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

TopicTitlePropertyGetorsetthetopic'stitle

Syntax

publicstringTitle{get;set;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

TopicTocExcludePropertyThisreturnstheTOCexcludeflagiffoundinthetopic

Syntax

publicboolTocExclude{get;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

TopicTopicAbstractPropertyGetorsetthetopic'sabstract

Syntax

publicstringTopicAbstract{get;set;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

TopicMethodsTheTopictypeexposesthefollowingmembers.

ParseFile Parsethetopicanditssub-topicfilestoextracttheinformationforconversion

HTMLtoMAMLConverter

TopicParseFileMethodParsethetopicanditssub-topicfilestoextracttheinformationforconversion

Syntax

Parameters

fileParserType:HtmlToMamlConversionFileParserThefileparser

imageDictionaryType:System.Collections.GenericDictionaryFilePath,ImageReferenceTheimagedictionary

publicvoidParseFile(

FileParserfileParser,

Dictionary<FilePath,ImageReference>imageDictionary

CopyC# VB C++ F#

HTMLtoMAMLConverter

TopicToStringMethodConverttostringfordebuggingpurposes

Syntax

ReturnValueType:StringThestringrepresentationofthetopic

CopyC# VB C++ F#

HTMLtoMAMLConverter

TopicCollectionClassThisisacollectionoftopicitems

InheritanceHierarchySystemObjectSystem.Collections.ObjectModelCollectionTopicHtmlToMamlConversionTopicCollection

Syntax

TheTopicCollectiontypeexposesthefollowingmembers.

TopicCollection InitializesanewinstanceoftheTopicCollectionclass

Count Getsthenumberofelements

publicclassTopicCollection:Collection<Topic>

CopyC# VB C++ F#

actuallycontainedintheCollectionT.(InheritedfromCollectionTopic.)

DefaultTopic Thisisusedtogetthedefaulttopic

Item Getsorsetstheelementatthespecifiedindex.(InheritedfromCollectionTopic.)

Items GetsaIListTwrapperaroundtheCollectionT.(InheritedfromCollectionTopic.)

SplitTocAtTopic ThisisusedtogetthetopicatwhichthetableofcontentissplitbytheAPIcontent.

Add AddsanobjecttotheendoftheCollectionT.(InheritedfromCollectionTopic.)

AddTopicsFromFolder Addalltopicsfromthespecifiedfolderrecursivelytothetopiccollection.

Clear RemovesallelementsfromtheCollectionT.(Inheritedfrom

CollectionTopic.)

ClearItems RemovesallelementsfromtheCollectionT.(InheritedfromCollectionTopic.)

Contains DetermineswhetheranelementisintheCollectionT.(InheritedfromCollectionTopic.)

CopyTo CopiestheentireCollectionTtoacompatibleone-dimensionalArray,startingatthespecifiedindexofthetargetarray.(InheritedfromCollectionTopic.)

GetEnumerator ReturnsanenumeratorthatiteratesthroughtheCollectionT.

(InheritedfromCollectionTopic.)

IndexOf Searchesforthespecifiedobjectandreturnsthezero-basedindexofthefirstoccurrencewithintheentireCollectionT.(InheritedfromCollectionTopic.)

Insert InsertsanelementintotheCollectionTatthespecifiedindex.(InheritedfromCollectionTopic.)

InsertItem InsertsanelementintotheCollectionTatthespecifiedindex.(InheritedfromCollectionTopic.)

ParseFiles Parseallfilesinthecollectiontoextractthe

informationforconversion.

Remove RemovesthefirstoccurrenceofaspecificobjectfromtheCollectionT.(InheritedfromCollectionTopic.)

RemoveAt RemovestheelementatthespecifiedindexoftheCollectionT.(InheritedfromCollectionTopic.)

RemoveItem RemovestheelementatthespecifiedindexoftheCollectionT.(InheritedfromCollectionTopic.)

Save Savethetopiccollectiontothenamedcontentlayoutfile

SetItem Replacestheelementatthespecifiedindex.(InheritedfromCollectionTopic.)

Sort Thisisusedtosortthecollection

HTMLtoMAMLConverter

TopicCollectionConstructorInitializesanewinstanceoftheTopicCollectionclass

Syntax

SeeAlsoReferenceTopicCollectionClassHtmlToMamlConversionNamespace

publicTopicCollection()

CopyC# VB C++ F#

HTMLtoMAMLConverter

TopicCollectionPropertiesTheTopicCollectiontypeexposesthefollowingmembers.

Count GetsthenumberofelementsactuallycontainedintheCollectionT.(InheritedfromCollectionTopic.)

DefaultTopic Thisisusedtogetthedefaulttopic

Item Getsorsetstheelementatthespecifiedindex.(InheritedfromCollectionTopic.)

Items GetsaIListTwrapperaroundtheCollectionT.(InheritedfromCollectionTopic.)

SplitTocAtTopic ThisisusedtogetthetopicatwhichthetableofcontentissplitbytheAPIcontent.

SeeAlsoReferenceTopicCollectionClass

HtmlToMamlConversionNamespace

HTMLtoMAMLConverter

TopicCollectionDefaultTopicPropertyThisisusedtogetthedefaulttopic

Syntax

PropertyValueType:TopicItreturnsthedefaulttopicornullifoneisnotset

publicTopicDefaultTopic{get;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

TopicCollectionSplitTocAtTopicPropertyThisisusedtogetthetopicatwhichthetableofcontentissplitbytheAPIcontent.

Syntax

PropertyValueType:TopicThiswillonlybevalidifitreferstoarootleveltopic.Itwillreturnnullifasplitlocationhasnotbeensetattherootlevel.

publicTopicSplitTocAtTopic{get;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

TopicCollectionMethodsTheTopicCollectiontypeexposesthefollowingmembers.

Add AddsanobjecttotheendoftheCollectionT.(InheritedfromCollectionTopic.)

AddTopicsFromFolder Addalltopicsfromthespecifiedfolderrecursivelytothetopiccollection.

Clear RemovesallelementsfromtheCollectionT.(InheritedfromCollectionTopic.)

ClearItems RemovesallelementsfromtheCollectionT.(InheritedfromCollectionTopic.)

Contains DetermineswhetheranelementisintheCollectionT.(InheritedfromCollectionTopic.)

CopyTo Copiestheentire

CollectionTtoacompatibleone-dimensionalArray,startingatthespecifiedindexofthetargetarray.(InheritedfromCollectionTopic.)

GetEnumerator ReturnsanenumeratorthatiteratesthroughtheCollectionT.(InheritedfromCollectionTopic.)

IndexOf Searchesforthespecifiedobjectandreturnsthezero-basedindexofthe

firstoccurrencewithintheentireCollectionT.(InheritedfromCollectionTopic.)

Insert InsertsanelementintotheCollectionTatthespecifiedindex.(InheritedfromCollectionTopic.)

InsertItem InsertsanelementintotheCollectionTatthespecifiedindex.(InheritedfromCollectionTopic.)

ParseFiles Parseallfilesinthecollectiontoextracttheinformationforconversion.

Remove RemovesthefirstoccurrenceofaspecificobjectfromtheCollectionT.(InheritedfromCollectionTopic.)

RemoveAt RemovestheelementatthespecifiedindexoftheCollectionT.(InheritedfromCollectionTopic.)

RemoveItem RemovestheelementatthespecifiedindexoftheCollectionT.(InheritedfromCollectionTopic.)

Save Savethetopiccollectiontothenamedcontentlayoutfile

SetItem Replacestheelementatthespecifiedindex.(InheritedfromCollectionTopic.)

HTMLtoMAMLConverter

TopicCollectionAddTopicsFromFolderMethodAddalltopicsfromthespecifiedfolderrecursivelytothetopiccollection.

Syntax

Parameters

folderType:SystemStringThefolderfromwhichtogetthefiles

topicDictionaryType:System.Collections.GenericDictionaryFilePath,TopicAdictionaryusedtocontainthelistoffilesindexbyname.

RemarksOnlyfileswitha.htm?or.topicextensionareadded

SeeAlso

publicvoidAddTopicsFromFolder(

stringfolder,

Dictionary<FilePath,Topic>topicDictionary

CopyC# VB C++ F#

ReferenceTopicCollectionClassHtmlToMamlConversionNamespace

HTMLtoMAMLConverter

TopicCollectionParseFilesMethodParseallfilesinthecollectiontoextracttheinformationforconversion.

Syntax

Parameters

fileParserType:HtmlToMamlConversionFileParserThefileparser

imageDictionaryType:System.Collections.GenericDictionaryFilePath,ImageReferenceTheimagedictionary

publicvoidParseFiles(

FileParserfileParser,

Dictionary<FilePath,ImageReference>imageDictionary

CopyC# VB C++ F#

HTMLtoMAMLConverter

TopicCollectionSaveMethodSavethetopiccollectiontothenamedcontentlayoutfile

Syntax

Parameters

filenameType:SystemStringThefilenametowhichthecontentlayoutissaved.

publicvoidSave(

stringfilename

CopyC# VB C++ F#

HTMLtoMAMLConverter

TopicCollectionSortMethodThisisusedtosortthecollection

Syntax

RemarksValuesaresortedbydisplaytitle.Comparisonsarecase-sensitive.

publicvoidSort()

CopyC# VB C++ F#

HTMLtoMAMLConverter

SandcastleBuilder.UtilsNamespaceThisnamespacecontainsclassesfromtheSandcastleHelpFileBuilderutilitieslibraryusedintheHTMLtoMAMLconverter.

Classes Class Description

FilePath Thisclassisusedtorepresentafilepath.Supportisincludedfortreatingthepathasfixedorrelativeandforexpandingenvironmentvariablesinthepathname.

FolderPath Thisclassisusedtorepresentafolderpath.Supportisincludedfortreatingthepathasfixedorrelativeandforexpandingenvironmentvariablesinthepathname.

MSHelpAttr ThisrepresentsanHTMLHelp2.xattributethatcanbe

addedtotheXMLdataislandineachhelptopicgeneratedbyBuildAssembler.

MSHelpAttrCollection Thiscollectionclassisusedtoholdthehelpattributeitemsforaproject.

MSHelpKeyword ThisrepresentsanHTMLHelp2.xindexkeywordthatcanbeaddedtotheXMLdataislandineachhelptopicgeneratedbyBuildAssembler.

MSHelpKeywordCollection Thiscollectionclassisusedtoholdthehelpindexkeyworditemsforaproject.

Interfaces Interface Description

IBasePathProvider ThisinterfacedefinesthepropertiesusedtoobtainabasepathforaFilePathobject.

HTMLtoMAMLConverter

FilePathClassThisclassisusedtorepresentafilepath.Supportisincludedfortreatingthepathasfixedorrelativeandforexpandingenvironmentvariablesinthepathname.

InheritanceHierarchySystemObjectSandcastleBuilder.UtilsFilePathSandcastleBuilder.UtilsFolderPath

Namespace:SandcastleBuilder.UtilsAssembly:ConvertHtmlToMaml(inConvertHtmlToMaml.exe)Version:1.0.0.2

Syntax

TheFilePathtypeexposesthefollowingmembers.

FilePath(IBasePathProvider) Defaultconstructor.Thefilepathisundefined.

FilePath(String,IBasePathProvider)

Constructor.Assignthespecifiedpath.

[SerializableAttribute]

publicclassFilePath:ICloneable

CopyC# VB C++ F#

FilePath(String,Boolean,IBasePathProvider)

Constructor.Assignthespecifiedpathandfixedsetting.

BasePath Thisreturnsthebasepathfortheobject

BasePathProvider Thisisusedtogetthebasepathproviderfortheobject.

Exists Thisread-onlypropertycanbeusedtodeterminewhetherornotthefilepathexists

ExpandedPath Thisread-onlypropertyisusedtodisplaythefullyqualifiedpathwithenvironmentvariableexpansionsinthedesigner.

IsFixedPath ThisisusedtoindicatewhetherornotthepathwillbetreatedasarelativeorfixedpathwhenconvertedretrievedviathePersistablePathproperty.

Path Thisisusedtogetorsetthepathtouse.

PersistablePath Thisisusedtoretrievethefilepathinaformatsuitablefor

persistingtostoragebasedonthecurrentsettings.

AbsoluteToRelativePath Thishelpermethodcanbeusedtoconvertanabsolutepathtoonethatisrelativetothegivenbasepath.

Clone Thisreturnsacloneoftheobject

Equals Thisisoverriddentoallowpropercomparisonoffilepathobjects.(OverridesObjectEquals(Object).)

GetFullPath Thisreturnsthefullyqualifiedpathforthespecifiedpath.Thisversionallowswildcardsinthefilenamepartifpresent.

GetHashCode Getahashcodeforthefilepathobject(OverridesObjectGetHashCode.)

OnPersistablePathChanged ThisraisesthePersistablePathChangedevent

OnPersistablePathChanging ThisraisesthePersistablePathChangingevent

RelativeToAbsolutePath Thishelpermethodcanbeusedtoconvertarelativepathtoanabsolutepathbasedonthegivenbasepath.

ToString Convertthefilepathtoastring(OverridesObjectToString.)

PersistablePathChanged Thiseventisraisedwhenthepersistablepathchanges

PersistablePathChanging Thiseventisraisedwhenthepersistablepathisabouttobechanged

Operators Name Description

Equality Overloadforequaloperator.

(FilePathtoString)

ThisisusedtohandleanimplicitconversionfromaFilePathobjecttoastring

Inequality Overloadfornotequaloperator.

SeeAlsoReferenceSandcastleBuilder.UtilsNamespace

HTMLtoMAMLConverter

FilePathConstructorTherearethreeoverloadsfortheconstructor.

OverloadList Name Description

FilePath(IBasePathProvider) Defaultconstructor.Thefilepathisundefined.

FilePath(String,IBasePathProvider)

FilePath(String,Boolean,IBasePathProvider)

SeeAlsoReferenceFilePathClassSandcastleBuilder.UtilsNamespace

HTMLtoMAMLConverter

FilePathConstructor(IBasePathProvider)Defaultconstructor.Thefilepathisundefined.

Syntax

Parameters

providerType:SandcastleBuilder.UtilsIBasePathProviderThebasepathprovider

SeeAlsoReferenceFilePathClassFilePathOverloadSandcastleBuilder.UtilsNamespace

publicFilePath(

IBasePathProviderprovider

CopyC# VB C++ F#

HTMLtoMAMLConverter

FilePathConstructor(String,IBasePathProvider)Constructor.Assignthespecifiedpath.

Syntax

Parameters

pathType:SystemStringArelativeorabsolutepath.

RemarksUnlessIsFixedPathissettotrue,thepathisalwaystreatedasarelativepath.

SeeAlso

publicFilePath(

stringpath,

CopyC# VB C++ F#

ReferenceFilePathClassFilePathOverloadSandcastleBuilder.UtilsNamespace

HTMLtoMAMLConverter

FilePathConstructor(String,Boolean,IBasePathProvider)Constructor.Assignthespecifiedpathandfixedsetting.

Syntax

Parameters

isFixedType:SystemBooleanTruetotreatthepathasfixed,falsetotreatitasarelativepath.

SeeAlsoReference

publicFilePath(

stringpath,

boolisFixed,

CopyC# VB C++ F#

FilePathClassFilePathOverloadSandcastleBuilder.UtilsNamespace

HTMLtoMAMLConverter

FilePathPropertiesTheFilePathtypeexposesthefollowingmembers.

BasePath Thisreturnsthebasepathfortheobject

BasePathProvider Thisisusedtogetthebasepathproviderfortheobject.

Exists Thisread-onlypropertycanbeusedtodeterminewhetherornotthefilepathexists

ExpandedPath Thisread-onlypropertyisusedtodisplaythefullyqualifiedpathwithenvironmentvariableexpansionsinthedesigner.

Path Thisisusedtogetorsetthepathtouse.

PersistablePath Thisisusedtoretrievethefile

pathinaformatsuitableforpersistingtostoragebasedonthecurrentsettings.

HTMLtoMAMLConverter

FilePathBasePathPropertyThisreturnsthebasepathfortheobject

Syntax

PropertyValueType:StringIfnoIBasePathProviderhasbeenspecified,thisreturnsthecurrentdirectory

publicstringBasePath{get;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

FilePathBasePathProviderPropertyThisisusedtogetthebasepathproviderfortheobject.

Syntax

PropertyValueType:IBasePathProvider

publicIBasePathProviderBasePathProvider{get;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

FilePathExistsPropertyThisread-onlypropertycanbeusedtodeterminewhetherornotthefilepathexists

Syntax

publicvirtualboolExists{get;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

FilePathExpandedPathPropertyThisread-onlypropertyisusedtodisplaythefullyqualifiedpathwithenvironmentvariableexpansionsinthedesigner.

Syntax

publicstringExpandedPath{get;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

FilePathIsFixedPathPropertyThisisusedtoindicatewhetherornotthepathwillbetreatedasarelativeorfixedpathwhenconvertedretrievedviathePersistablePathproperty.

Syntax

PropertyValueType:BooleanIftrue,thepathisreturnedasafixedpathwhenretrieved.Iffalse,itisreturnedasapathrelativetothecurrentvalueoftheBasePathproperty.

publicboolIsFixedPath{get;set;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

FilePathPathPropertyThisisusedtogetorsetthepathtouse.

Syntax

PropertyValueType:StringWhenset,ifthepathisnotrooted(arelativepath),IsFixedPathissettofalse.Ifrooted(anabsolutepath),itisnotchanged.Thispropertyalwaysreturnsafullyqualifiedpathbutwithoutanyenvironmentvariableexpansions.Ifsettoanulloremptystring,thefilepathisclearedandisconsideredtobeundefined.

Examples

publicvirtualstringPath{get;set;}

FilePathpath=newFilePath();

//Setittoarelativepath

path.Path=@"..\..\Test.txt";

//Setittoanabsolutepath

path.Path=@"C:\MyDocuments\Info.doc";

//Setittoapathbasedonanenvironmentvariable

C# VB C++ F#

path.Path=@"%HOMEDRIVE%%HOMEPATH%\Favorites\*.*";

HTMLtoMAMLConverter

FilePathPersistablePathPropertyThisisusedtoretrievethefilepathinaformatsuitableforpersistingtostoragebasedonthecurrentsettings.

Syntax

RemarksIfIsFixedPathistrue,anabsolutepathisalwaysreturned.Iffalse,thepathisreturnedinaformthatisrelativetothepathstoredintheBasePathproperty.

publicvirtualstringPersistablePath{get;set;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

FilePathMethodsTheFilePathtypeexposesthefollowingmembers.

AbsoluteToRelativePath Thishelpermethodcanbeusedtoconvertanabsolutepathtoonethatisrelativetothegivenbasepath.

Clone Thisreturnsacloneoftheobject

Equals Thisisoverriddentoallowpropercomparisonoffilepathobjects.(OverridesObjectEquals(Object).)

GetFullPath Thisreturnsthefullyqualifiedpathforthespecifiedpath.This

versionallowswildcardsinthefilenamepartifpresent.

GetHashCode Getahashcodeforthefilepathobject(OverridesObjectGetHashCode.)

OnPersistablePathChanged ThisraisesthePersistablePathChangedevent

OnPersistablePathChanging ThisraisesthePersistablePathChangingevent

RelativeToAbsolutePath Thishelpermethodcanbeusedtoconvertarelativepathtoanabsolutepathbasedonthegivenbasepath.

ToString Convertthefilepathtoastring(OverridesObjectToString.)

HTMLtoMAMLConverter

FilePathAbsoluteToRelativePathMethodThishelpermethodcanbeusedtoconvertanabsolutepathtoonethatisrelativetothegivenbasepath.

Syntax

Parameters

basePathType:SystemStringThebasepath

absolutePathType:SystemStringAnabsolutepath

ReturnValueType:StringApathtothegivenabsolutepaththatisrelativetothegivenbasepath

Remarks

publicstaticstringAbsoluteToRelativePath(

stringbasePath,

stringabsolutePath

CopyC# VB C++ F#

Ifthebasepathisnullorempty,thecurrentworkingfolderisused.

Examples

stringbasePath=@"E:\DotNet\CS\TestProject\Source"

stringabsolutePath=@"E:\DotNet\CS\TestProject\Doc\Help.html"

stringrelativePath=FilePath.AbsoluteToRelativePath(basePath,

absolutePath);

Console.WriteLine(relativePath);

//Resultsin:..\Doc\Help.html

CopyC# VB

HTMLtoMAMLConverter

FilePathCloneMethodThisreturnsacloneoftheobject

Syntax

ReturnValueType:ObjectAcloneoftheobjectImplementsICloneableClone

publicObjectClone()

CopyC# VB C++ F#

HTMLtoMAMLConverter

FilePathEqualsMethodThisisoverriddentoallowpropercomparisonoffilepathobjects.

Syntax

Parameters

objType:SystemObjectTheobjecttowhichthisinstanceiscompared

ReturnValueType:BooleanReturnstrueiftheobjectequalsthisinstance,falseifitdoesnot

publicoverrideboolEquals(

Objectobj

CopyC# VB C++ F#

HTMLtoMAMLConverter

FilePathGetFullPathMethodThisreturnsthefullyqualifiedpathforthespecifiedpath.Thisversionallowswildcardsinthefilenamepartifpresent.

Syntax

Parameters

pathType:SystemStringThepathtoexpand

ReturnValueType:StringThefullyqualifiedpathname

RemarksTheSystem.IO.PathversionofGetFullPath(String)willthrowanexceptionifthepathcontainswildcardcharacters.Thisversiondoesnot.

SeeAlso

publicstaticstringGetFullPath(

stringpath

CopyC# VB C++ F#

ReferenceFilePathClassSandcastleBuilder.UtilsNamespace

HTMLtoMAMLConverter

FilePathGetHashCodeMethodGetahashcodeforthefilepathobject

Syntax

ReturnValueType:Int32ReturnsthehashcodeoftheToStringvalueconvertedtolowercase

publicoverrideintGetHashCode()

CopyC# VB C++ F#

HTMLtoMAMLConverter

FilePathOnPersistablePathChangedMethodThisraisesthePersistablePathChangedevent

Syntax

Parameters

eType:SystemEventArgsTheeventarguments

protectedvoidOnPersistablePathChanged(

EventArgse

CopyC# VB C++ F#

HTMLtoMAMLConverter

FilePathOnPersistablePathChangingMethodThisraisesthePersistablePathChangingevent

Syntax

Parameters

eType:SystemEventArgsTheeventarguments

protectedvoidOnPersistablePathChanging(

EventArgse

CopyC# VB C++ F#

HTMLtoMAMLConverter

FilePathRelativeToAbsolutePathMethodThishelpermethodcanbeusedtoconvertarelativepathtoanabsolutepathbasedonthegivenbasepath.

Syntax

Parameters

basePathType:SystemStringThebasepath

relativePathType:SystemStringArelativepath

ReturnValueType:StringAnabsolutepath

Remarks

publicstaticstringRelativeToAbsolutePath(

stringbasePath,

stringrelativePath

CopyC# VB C++ F#

Ifthebasepathisnullorempty,thecurrentworkingfolderisused.

Examples

stringbasePath=@"E:\DotNet\CS\TestProject\Source"

stringrelativePath=@"..\Doc\Help.html";

stringabsolutePath=FilePath.RelativeToAbsolutePath(basePath,

relativePath);

Console.WriteLine(absolutePath);

//Resultsin:E:\DotNet\CS\TestProject\Doc\Help.html

CopyC# VB

HTMLtoMAMLConverter

FilePathToStringMethodConvertthefilepathtoastring

Syntax

ReturnValueType:StringAfixedorrelativepathbasedonthecurrentsettings

CopyC# VB C++ F#

HTMLtoMAMLConverter

FilePathEventsTheFilePathtypeexposesthefollowingmembers.

PersistablePathChanged Thiseventisraisedwhenthepersistablepathchanges

PersistablePathChanging Thiseventisraisedwhenthepersistablepathisabouttobechanged

HTMLtoMAMLConverter

FilePathPersistablePathChangedEventThiseventisraisedwhenthepersistablepathchanges

Syntax

ValueType:SystemEventHandler

publiceventEventHandlerPersistablePathChanged

CopyC# VB C++ F#

HTMLtoMAMLConverter

FilePathPersistablePathChangingEventThiseventisraisedwhenthepersistablepathisabouttobechanged

Syntax

ValueType:SystemEventHandler

publiceventEventHandlerPersistablePathChanging

CopyC# VB C++ F#

HTMLtoMAMLConverter

FilePathOperatorsandTypeConversionsTheFilePathtypeexposesthefollowingmembers.

Operators Name Description

Equality Overloadforequaloperator.

(FilePathtoString)

ThisisusedtohandleanimplicitconversionfromaFilePathobjecttoastring

Inequality Overloadfornotequaloperator.

HTMLtoMAMLConverter

FilePathEqualityOperatorOverloadforequaloperator.

Syntax

Parameters

firstPathType:SandcastleBuilder.UtilsFilePathThefirstobjecttocompare

secondPathType:SandcastleBuilder.UtilsFilePathThesecondobjecttocompare

ReturnValueType:BooleanTrueifequal,falseifnot.

publicstaticbooloperator==(

FilePathfirstPath,

FilePathsecondPath

CopyC# VB C++ F#

HTMLtoMAMLConverter

FilePathConversion(FilePathtoString)ThisisusedtohandleanimplicitconversionfromaFilePathobjecttoastring

Syntax

Parameters

filePathType:SandcastleBuilder.UtilsFilePathTheFilePathtoconvert.

ReturnValueType:StringThefilepathasarelativeorabsolutepathstringbasedonitscurrentsettings

Examples

publicstaticimplicitoperatorstring(

FilePathfilePath

FilePathfilePath=newFilePath(@"%APPDATA%\TestApp\App.config"

C# VB C++ F#

//TheFilePathobjectisautomaticallyconvertedtoastring

//representingtheexpanded,fullyqualifiedpath.

stringpathString=filePath;

HTMLtoMAMLConverter

FilePathInequalityOperatorOverloadfornotequaloperator.

Syntax

Parameters

firstPathType:SandcastleBuilder.UtilsFilePathThefirstobjecttocompare

secondPathType:SandcastleBuilder.UtilsFilePathThesecondobjecttocompare

ReturnValueType:BooleanTrueifnotequal,falseiftheyare.

publicstaticbooloperator!=(

FilePathfirstPath,

FilePathsecondPath

CopyC# VB C++ F#

HTMLtoMAMLConverter

FolderPathClassThisclassisusedtorepresentafolderpath.Supportisincludedfortreatingthepathasfixedorrelativeandforexpandingenvironmentvariablesinthepathname.

InheritanceHierarchySystemObjectSandcastleBuilder.UtilsFilePathSandcastleBuilder.UtilsFolderPath

Syntax

TheFolderPathtypeexposesthefollowingmembers.

FolderPath(IBasePathProvider) Defaultconstructor.Thefolderpathisundefined.

FolderPath(String,IBasePathProvider)

Constructor.Assignthe

publicclassFolderPath:FilePath

CopyC# VB C++ F#

specifiedpath.

FolderPath(String,Boolean,IBasePathProvider)

BasePath Thisreturnsthebasepathfortheobject(InheritedfromFilePath.)

BasePathProvider Thisisusedtogetthebasepathproviderfortheobject.(InheritedfromFilePath.)

Exists Thisread-onlypropertycanbeusedtodeterminewhetherornotthefolderpathexists.(OverridesFilePathExists.)

ExpandedPath Thisread-onlypropertyisusedtodisplaythefullyqualifiedpathwithenvironmentvariableexpansionsinthedesigner.(InheritedfromFilePath.)

IsFixedPath Thisisusedtoindicatewhetherornotthepathwillbetreatedasarelativeorfixedpathwhenconvertedretrievedviathe

PersistablePathproperty.(InheritedfromFilePath.)

Path Thisisusedtogetorsetthepath.(OverridesFilePathPath.)

PersistablePath Thisisusedtoretrievethefilepathinaformatsuitableforpersistingtostoragebasedonthecurrentsettings.(InheritedfromFilePath.)

Clone Thisreturnsacloneoftheobject(InheritedfromFilePath.)

Equals Thisisoverriddentoallowpropercomparisonoffilepathobjects.(InheritedfromFilePath.)

GetHashCode Getahashcodeforthefilepathobject

(InheritedfromFilePath.)

IsPathTerminated Thiscanbeusedtofindoutifapathisterminatedwithatrailingbackslash.

OnPersistablePathChanged ThisraisesthePersistablePathChangedevent(InheritedfromFilePath.)

OnPersistablePathChanging ThisraisesthePersistablePathChangingevent(InheritedfromFilePath.)

TerminatePath Thiscanbeusedtoensurethatapathisterminatedwithatrailingbackslash.

ToString Convertthefilepathtoastring(InheritedfromFilePath.)

PersistablePathChanged Thiseventisraisedwhenthepersistablepathchanges(InheritedfromFilePath.)

PersistablePathChanging Thiseventisraisedwhenthepersistablepathisabouttobechanged(InheritedfromFilePath.)

HTMLtoMAMLConverter

FolderPathConstructorTherearethreeoverloadsfortheconstructor.

FolderPath(IBasePathProvider) Defaultconstructor.Thefolderpathisundefined.

FolderPath(String,IBasePathProvider)

FolderPath(String,Boolean,IBasePathProvider)

SeeAlsoReferenceFolderPathClassSandcastleBuilder.UtilsNamespace

HTMLtoMAMLConverter

FolderPathConstructor(IBasePathProvider)Defaultconstructor.Thefolderpathisundefined.

Syntax

Parameters

SeeAlsoReferenceFolderPathClassFolderPathOverloadSandcastleBuilder.UtilsNamespace

publicFolderPath(

CopyC# VB C++ F#

HTMLtoMAMLConverter

FolderPathConstructor(String,IBasePathProvider)Constructor.Assignthespecifiedpath.

Syntax

Parameters

RemarksUnlessIsFixedPathissettotrue,thepathisalwaystreatedasarelativepath.

SeeAlso

publicFolderPath(

stringpath,

CopyC# VB C++ F#

ReferenceFolderPathClassFolderPathOverloadSandcastleBuilder.UtilsNamespace

HTMLtoMAMLConverter

FolderPathConstructor(String,Boolean,IBasePathProvider)Constructor.Assignthespecifiedpathandfixedsetting.

Syntax

Parameters

isFixedType:SystemBooleanTruetotreatthepathasfixed,falsetotreatitasarelativepath.

SeeAlsoReference

publicFolderPath(

stringpath,

boolisFixed,

CopyC# VB C++ F#

FolderPathClassFolderPathOverloadSandcastleBuilder.UtilsNamespace

HTMLtoMAMLConverter

FolderPathPropertiesTheFolderPathtypeexposesthefollowingmembers.

BasePath Thisreturnsthebasepathfortheobject(InheritedfromFilePath.)

BasePathProvider Thisisusedtogetthebasepathproviderfortheobject.(InheritedfromFilePath.)

Exists Thisread-onlypropertycanbeusedtodeterminewhetherornotthefolderpathexists.(OverridesFilePathExists.)

ExpandedPath Thisread-onlypropertyisusedtodisplaythefullyqualifiedpathwithenvironmentvariableexpansionsinthedesigner.(InheritedfromFilePath.)

(InheritedfromFilePath.)

Path Thisisusedtogetorsetthepath.(OverridesFilePathPath.)

PersistablePath Thisisusedtoretrievethefilepathinaformatsuitableforpersistingtostoragebasedonthecurrentsettings.(InheritedfromFilePath.)

HTMLtoMAMLConverter

FolderPathExistsPropertyThisread-onlypropertycanbeusedtodeterminewhetherornotthefolderpathexists.

Syntax

publicoverrideboolExists{get;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

FolderPathPathPropertyThisisusedtogetorsetthepath.

Syntax

PropertyValueType:StringWhenset,ifthepathisnotrooted(arelativepath),IsFixedPathissettofalse.Ifrooted(anabsolutepath),itisnotchanged.Thispropertyalwaysreturnsafullyqualifiedpathbutwithoutanyenvironmentvariableexpansionsandterminatedwithatrailingbackslashifneeded.Ifsettoanulloremptystring,thefolderpathisclearedandisconsideredtobeundefined.

Examples

publicoverridestringPath{get;set;}

FolderPathpath=newFolderPath();

//Setittoarelativepath

path.Path=@"..\..\ProjectFolder";

//Setittoanabsolutepath

path.Path=@"C:\MyDocuments\ProjectDocs\";

C# VB C++ F#

//Setittoapathbasedonanenvironmentvariable

path.Path=@"%HOMEDRIVE%%HOMEPATH%\Favorites\";

HTMLtoMAMLConverter

FolderPathMethodsTheFolderPathtypeexposesthefollowingmembers.

Clone Thisreturnsacloneoftheobject(InheritedfromFilePath.)

Equals Thisisoverriddentoallowpropercomparisonoffilepathobjects.(InheritedfromFilePath.)

GetHashCode Getahashcodeforthefilepathobject(InheritedfromFilePath.)

IsPathTerminated Thiscanbeusedtofindoutifapathisterminated

withatrailingbackslash.

OnPersistablePathChanged ThisraisesthePersistablePathChangedevent(InheritedfromFilePath.)

OnPersistablePathChanging ThisraisesthePersistablePathChangingevent(InheritedfromFilePath.)

TerminatePath Thiscanbeusedtoensurethatapathisterminatedwithatrailingbackslash.

ToString Convertthefilepathtoastring(InheritedfromFilePath.)

HTMLtoMAMLConverter

FolderPathIsPathTerminatedMethodThiscanbeusedtofindoutifapathisterminatedwithatrailingbackslash.

Syntax

Parameters

pathType:SystemStringThepathtocheck

ReturnValueType:BooleanReturnstrueifitis,falseifitisnot.

publicstaticboolIsPathTerminated(

stringpath

CopyC# VB C++ F#

HTMLtoMAMLConverter

FolderPathTerminatePathMethodThiscanbeusedtoensurethatapathisterminatedwithatrailingbackslash.

Syntax

Parameters

pathType:SystemStringThepathtocheck

ReturnValueType:StringThepathwithatrailingbackslashaddedifnecessary.

publicstaticstringTerminatePath(

stringpath

CopyC# VB C++ F#

HTMLtoMAMLConverter

FolderPathEventsTheFolderPathtypeexposesthefollowingmembers.

PersistablePathChanged Thiseventisraisedwhenthepersistablepathchanges(InheritedfromFilePath.)

PersistablePathChanging Thiseventisraisedwhenthepersistablepathisabouttobechanged(InheritedfromFilePath.)

HTMLtoMAMLConverter

IBasePathProviderInterfaceThisinterfacedefinesthepropertiesusedtoobtainabasepathforaFilePathobject.

Syntax

TheIBasePathProvidertypeexposesthefollowingmembers.

BasePath Thisread-onlypropertyreturnsthebasepath

publicinterfaceIBasePathProvider

CopyC# VB C++ F#

HTMLtoMAMLConverter

IBasePathProviderPropertiesTheIBasePathProvidertypeexposesthefollowingmembers.

BasePath Thisread-onlypropertyreturnsthebasepath

SeeAlsoReferenceIBasePathProviderInterfaceSandcastleBuilder.UtilsNamespace

HTMLtoMAMLConverter

IBasePathProviderBasePathPropertyThisread-onlypropertyreturnsthebasepath

Syntax

SeeAlsoReferenceIBasePathProviderInterfaceSandcastleBuilder.UtilsNamespace

stringBasePath{get;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

MSHelpAttrClassThisrepresentsanHTMLHelp2.xattributethatcanbeaddedtotheXMLdataislandineachhelptopicgeneratedbyBuildAssembler.

InheritanceHierarchySystemObjectSandcastleBuilder.UtilsMSHelpAttr

Syntax

TheMSHelpAttrtypeexposesthefollowingmembers.

AttributeName Thisisusedtogetorsettheattributename

AttributeValue Thisisusedtogetorsettheattributevalue

IsDirty Thisisusedtogetorsetthedirtystateoftheitem

publicclassMSHelpAttr:IComparable<MSHelpAttr>

CopyC# VB C++ F#

CompareTo Comparesthisinstancetoanotherinstanceandreturnsanindicationoftheirrelativevalues.

Equals Determineswhetherthespecifiedobjectisequaltothecurrentobject.(OverridesObjectEquals(Object).)

GetHashCode Getahashcodeforthisitem(OverridesObjectGetHashCode.)

ToString Returnastringrepresentationoftheitem

(OverridesObjectToString.)

HTMLtoMAMLConverter

MSHelpAttrPropertiesTheMSHelpAttrtypeexposesthefollowingmembers.

AttributeName Thisisusedtogetorsettheattributename

AttributeValue Thisisusedtogetorsettheattributevalue

IsDirty Thisisusedtogetorsetthedirtystateoftheitem

SeeAlsoReferenceMSHelpAttrClassSandcastleBuilder.UtilsNamespace

HTMLtoMAMLConverter

MSHelpAttrAttributeNamePropertyThisisusedtogetorsettheattributename

Syntax

publicstringAttributeName{get;set;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

MSHelpAttrAttributeValuePropertyThisisusedtogetorsettheattributevalue

Syntax

publicstringAttributeValue{get;set;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

MSHelpAttrIsDirtyPropertyThisisusedtogetorsetthedirtystateoftheitem

Syntax

publicboolIsDirty{get;set;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

MSHelpAttrMethodsTheMSHelpAttrtypeexposesthefollowingmembers.

MemberwiseClone Createsashallowcopyofthe

currentObject.(InheritedfromObject.)

ToString Returnastringrepresentationoftheitem(OverridesObjectToString.)

HTMLtoMAMLConverter

MSHelpAttrCompareToMethodComparesthisinstancetoanotherinstanceandreturnsanindicationoftheirrelativevalues.

Syntax

Parameters

otherType:SandcastleBuilder.UtilsMSHelpAttrAMSHelpAttrobjecttocompare

ReturnValueType:Int32Returns-1ifthisinstanceislessthanthevalue,0iftheyareequal,or1ifthisinstanceisgreaterthanthevalueorthevalueisnull.ImplementsIComparableTCompareTo(T)

RemarksEntriesaresortedbynameandthenvalue

publicintCompareTo(

MSHelpAttrother

CopyC# VB C++ F#

HTMLtoMAMLConverter

MSHelpAttrEqualsMethodDetermineswhetherthespecifiedobjectisequaltothecurrentobject.

Syntax

Parameters

objType:SystemObjectTheobjecttocomparewiththecurrentobject.

ReturnValueType:Booleantrueifthespecifiedobjectisequaltothecurrentobject;otherwise,false.

Objectobj

CopyC# VB C++ F#

HTMLtoMAMLConverter

MSHelpAttrGetHashCodeMethodGetahashcodeforthisitem

Syntax

ReturnValueType:Int32Returnsthehashcodefortheattributenameandvalue.

CopyC# VB C++ F#

HTMLtoMAMLConverter

MSHelpAttrToStringMethodReturnastringrepresentationoftheitem

Syntax

ReturnValueType:StringReturnstheiteminitsXMLformat

CopyC# VB C++ F#

HTMLtoMAMLConverter

MSHelpAttrCollectionClassThiscollectionclassisusedtoholdthehelpattributeitemsforaproject.

InheritanceHierarchySystemObjectSystem.Collections.ObjectModelCollectionMSHelpAttrSystem.ComponentModelBindingListMSHelpAttrSandcastleBuilder.UtilsMSHelpAttrCollection

Syntax

TheMSHelpAttrCollectiontypeexposesthefollowingmembers.

MSHelpAttrCollection Constructor

publicclassMSHelpAttrCollection:BindingList<MSHelpAttr

CopyC# VB C++ F#

AllowEdit Getsorsetsavalueindicatingwhetheritemsinthelistcanbeedited.(InheritedfromBindingListMSHelpAttr.)

AllowNew GetsorsetsavalueindicatingwhetheryoucanadditemstothelistusingtheAddNewmethod.(InheritedfromBindingListMSHelpAttr.)

AllowRemove Getsorsetsavalueindicatingwhetheryoucanremoveitemsfromthecollection.(InheritedfromBindingListMSHelpAttr.)

Count GetsthenumberofelementsactuallycontainedintheCollectionT.(InheritedfromCollectionMSHelpAttr.)

IsDirty Thisisusedtogetorsetthedirtystateofthecollection

IsSortedCore Getsavalueindicatingwhetherthelistissorted.(Inheritedfrom

BindingListMSHelpAttr.)

Item Getsorsetstheelementatthespecifiedindex.(InheritedfromCollectionMSHelpAttr.)

Items GetsaIListTwrapperaroundtheCollectionT.(InheritedfromCollectionMSHelpAttr.)

RaiseListChangedEvents GetsorsetsavalueindicatingwhetheraddingorremovingitemswithinthelistraisesListChangedevents.(InheritedfromBindingListMSHelpAttr.)

SortDirectionCore Getsthedirectionthelistissorted.(InheritedfromBindingListMSHelpAttr.)

SortPropertyCore Getsthepropertydescriptorthatisusedforsortingthelistifsortingisimplementedinaderivedclass;otherwise,returnsnull.(InheritedfromBindingListMSHelpAttr.)

SupportsChangeNotificationCore GetsavalueindicatingwhetherListChanged

eventsareenabled.(InheritedfromBindingListMSHelpAttr.)

SupportsSearchingCore Getsavalueindicatingwhetherthelistsupportssearching.(InheritedfromBindingListMSHelpAttr.)

SupportsSortingCore Getsavalueindicatingwhetherthelistsupportssorting.(InheritedfromBindingListMSHelpAttr.)

Add(T) AddsanobjecttotheendoftheCollection(InheritedfromCollectionMSHelpAttr

Add(String,String) Addanewitemtothecollection

AddNew Addsanewitemtothecollection.(InheritedfromBindingListMSHelpAttr

AddNewCore Addsanewitemtotheendofthecollection.(InheritedfromBindingListMSHelpAttr

ApplySortCore Sortstheitemsifoverriddeninaderivedclass;otherwise,throwsaNotSupportedException(InheritedfromBindingListMSHelpAttr

CancelNew Discardsapendingnewitem.

(InheritedfromBindingListMSHelpAttr

Clear RemovesallelementsfromtheCollection(InheritedfromCollectionMSHelpAttr

ClearItems Removesallelementsfromthecollection.(InheritedfromBindingListMSHelpAttr

Contains Determineswhetheranelementisinthe(InheritedfromCollectionMSHelpAttr

CopyTo CopiestheentireCollectionTtoacompatibleone-dimensionalArray,startingatthespecifiedindexofthetargetarray.(InheritedfromCollectionMSHelpAttr

EndNew Commitsapendingnewitemtothecollection.(InheritedfromBindingListMSHelpAttr

FindCore Searchesfortheindexoftheitemthathasthespecifiedpropertydescriptorwiththespecifiedvalue,ifsearchingisimplementedinaderivedclass;otherwise,aNotSupportedException(InheritedfromBindingListMSHelpAttr

GetEnumerator ReturnsanenumeratorthatiteratesthroughtheCollectionT.(InheritedfromCollectionMSHelpAttr

IndexOf Searchesforthespecifiedobjectandreturnsthezero-basedindexofthefirstoccurrencewithintheentireCollectionT.(InheritedfromCollectionMSHelpAttr

Insert InsertsanelementintotheCollectionspecifiedindex.(InheritedfromCollectionMSHelpAttr

InsertItem Insertsthespecifiediteminthelistatthespecifiedindex.(InheritedfromBindingListMSHelpAttr

MarkAsDirty Thisisusedtomarkthecollectionaschangedwhenthereisnoassociatedproject.

MemberwiseClone Createsashallowcopyofthecurrent(InheritedfromObject.)

OnAddingNew RaisestheAddingNewevent.(InheritedfromBindingListMSHelpAttr

OnListChanged Thisisoverriddentomarkthecollectionasdirtywhenitchanges(OverridesBindingListTOnListChanged(ListChangedEventArgs)

Remove RemovesthefirstoccurrenceofaspecificobjectfromtheCollectionT.(InheritedfromCollectionMSHelpAttr

RemoveAt Removestheelementatthespecifiedindexofthe

CollectionT.(InheritedfromCollectionMSHelpAttr

RemoveItem Removestheitematthespecifiedindex.(InheritedfromBindingListMSHelpAttr

RemoveSortCore RemovesanysortappliedwithApplySortCore(PropertyDescriptor,ListSortDirection)ifsortingisimplementedinaderivedclass;otherwise,raisesNotSupportedException.(InheritedfromBindingListMSHelpAttr

ResetBindings RaisesaListChangedeventoftype(InheritedfromBindingListMSHelpAttr

ResetItem RaisesaListChangedeventoftypetheitematthespecifiedposition.(InheritedfromBindingListMSHelpAttr

SetItem Replacestheitematthespecifiedindexwiththespecifieditem.(InheritedfromBindingListMSHelpAttr

ToConfigurationString Convertthecollectiontoitsstringformforuseinthesandcastle.configfile.

WriteXml WritethecollectiontothegivenXMLtextwriter

AddingNew Occursbeforeanitemisaddedtothelist.(InheritedfromBindingListMSHelpAttr.)

ListChanged Occurswhenthelistoraniteminthelistchanges.(InheritedfromBindingListMSHelpAttr.)

HTMLtoMAMLConverter

MSHelpAttrCollectionConstructorConstructor

Syntax

SeeAlsoReferenceMSHelpAttrCollectionClassSandcastleBuilder.UtilsNamespace

publicMSHelpAttrCollection()

CopyC# VB C++ F#

HTMLtoMAMLConverter

MSHelpAttrCollectionPropertiesTheMSHelpAttrCollectiontypeexposesthefollowingmembers.

AllowEdit Getsorsetsavalueindicatingwhetheritemsinthelistcanbeedited.(InheritedfromBindingListMSHelpAttr.)

AllowNew GetsorsetsavalueindicatingwhetheryoucanadditemstothelistusingtheAddNewmethod.(InheritedfromBindingListMSHelpAttr.)

AllowRemove Getsorsetsavalueindicatingwhetheryoucanremoveitemsfromthecollection.(InheritedfromBindingListMSHelpAttr.)

Count GetsthenumberofelementsactuallycontainedintheCollectionT.

(InheritedfromCollectionMSHelpAttr.)

IsDirty Thisisusedtogetorsetthedirtystateofthecollection

IsSortedCore Getsavalueindicatingwhetherthelistissorted.(InheritedfromBindingListMSHelpAttr.)

Item Getsorsetstheelementatthespecifiedindex.(InheritedfromCollectionMSHelpAttr.)

Items GetsaIListTwrapperaroundtheCollectionT.(InheritedfromCollectionMSHelpAttr.)

RaiseListChangedEvents GetsorsetsavalueindicatingwhetheraddingorremovingitemswithinthelistraisesListChangedevents.(InheritedfromBindingListMSHelpAttr.)

SortDirectionCore Getsthedirectionthelistissorted.(InheritedfromBindingListMSHelpAttr.)

SortPropertyCore Getsthepropertydescriptorthatisusedforsortingthelistifsortingisimplementedinaderivedclass;otherwise,returnsnull.(InheritedfromBindingListMSHelpAttr.)

SupportsChangeNotificationCore GetsavalueindicatingwhetherListChangedeventsareenabled.(InheritedfromBindingListMSHelpAttr.)

SupportsSearchingCore Getsavalueindicatingwhetherthelistsupportssearching.(InheritedfromBindingListMSHelpAttr.)

SupportsSortingCore Getsavalueindicatingwhetherthelistsupportssorting.(InheritedfromBindingListMSHelpAttr.)

HTMLtoMAMLConverter

MSHelpAttrCollectionIsDirtyPropertyThisisusedtogetorsetthedirtystateofthecollection

Syntax

publicboolIsDirty{get;set;}

CopyC# VB C++ F#

HTMLtoMAMLConverter

MSHelpAttrCollectionMethodsTheMSHelpAttrCollectiontypeexposesthefollowingmembers.

Add(T) AddsanobjecttotheendoftheCollection(InheritedfromCollectionMSHelpAttr

Add(String,String) Addanewitemtothecollection

AddNew Addsanewitemtothecollection.(InheritedfromBindingListMSHelpAttr

AddNewCore Addsanewitemtotheendofthecollection.(InheritedfromBindingListMSHelpAttr

ApplySortCore Sortstheitemsifoverriddeninaderivedclass;otherwise,throwsaNotSupportedException(InheritedfromBindingListMSHelpAttr

CancelNew Discardsapendingnewitem.(InheritedfromBindingListMSHelpAttr