How to create webservice documentation using techwriter

installeer WCFExtras via nuget{BR}
markeer je soap service interface met een &#0091;XmlComments&#0093; attribuut{BR}
zorg er voor dat "xml documentation file" is aangevinkt in je project properties onder build{BR}
je kan nu je soap service interface opmaken met de gebruikelijke dotnet xml comments.{BR}
start de service (al dan niet lokaal){BR}

start een nieuw techwriter soap service project{BR}
voer de url naar de wsdl van de service in &#40;&sim;/servicenaam.svc?wsdl&#41;
merge de xsd's

zet de volgende filters aan:

*Methods (alles)
*Complex Types (alles)
*Simple Types (alle enumeraties)
*Elements (alle return values van Methods, tip van de week, gebruik een filter pattern :)

zet de volgende options aan:

*methods
**Description
**Parameter summary
**Return Value
**Output

zet de volgende opties uit
*Elements
**Description
**Remarks
**Example
*Attributes
**Remarks
*Complex types
**Remarks
**Derived By
*Simple Types
**Remarks
**Derived By

genereer een webpagina

plak onderstaande css in een wiki pagina:
{{{{<esc><style type="text/css">
div.header table {
	position: relative;
	left: 0px;
	top: 0px;
	padding: 0px 0px 0px 0px;
	margin: 0px 0px 0px 0px;
	width: 100%;
	height: 21px; 
	border-collapse: collapse;
	border-style: solid;
	border-width: 0px;
	background-color: #99ccff; 
}
div.header table td {
	margin: 0px 0px 0px 0px;
	padding: 2px 0px 0px 4px;
	vertical-align: middle;
	border-width: 0px;
	border-style: solid;
	border-color: #999999;
	background: transparent; 
}
table {
	width: 90%; 
	margin-top: .6em;
	margin-bottom: .3em;
	border-width: 1px 1px 0px 1px;
	border-style: solid;
	border-color: #999999;
	color:Black;
	background-color: #999999; 
}
table th { 
	background: #cccccc; 
	vertical-align: bottom;
	font-family: Arial, Helvetica, sans-serif;
font-style: normal;
font-weight: bold;
font-size: 10pt;
color: Black;
}
table td {
	padding-left: 12px;
	background: #ffffff;
	vertical-align: top;
	font-family: Arial, Helvetica, sans-serif;
font-style: normal;
font-weight: normal;
font-size: 10pt;
color: Black;
}
table th, table td { 
	border-style: solid; 
	border-width: 0px 0px 1px 0px;
	border-color: #999999;
	padding: 4px 6px;
	text-align: left;
}
tr.startGroup0 td.first { 
	background-color: #99ccff;
	padding-top: 2px;
	padding-bottom: 0px;
	background-image: url(ReportService_files/TopTab.gif);
	background-repeat: no-repeat;
	padding-left: 10; 
	background-position: -80px 0;
}
tr.endGroup0 td.first {
	background-color: #99ccff;
	height: 10px;
	background-image: url(ReportService_files/BottomTab.gif);
	background-repeat: no-repeat;
	padding-left: 10; 
	background-position: -80px 0;
}
tr.group0 td.first {
	padding-left: 10;
}
tr.startGroup0 td.middle, tr.startGroup0 td.last, 
tr.endGroup0 td.middle, tr.endGroup0 td.last {
	background-color: #99ccff;
}
tr.startGroup1 td.first { 
	background-color: #80FF80;
	padding-top: 2px;
	padding-bottom: 0px;
	background-image: url(ReportService_files/TopTab.gif);
	background-repeat: no-repeat;
	padding-left: 20; 
	background-position: -70px 0;
}
tr.endGroup1 td.first {
	background-color: #80FF80;
	height: 10px;
	background-image: url(ReportService_files/BottomTab.gif);
	background-repeat: no-repeat;
	padding-left: 20; 
	background-position: -70px 0;
}
tr.group1 td.first {
	padding-left: 20; 
}
tr.startGroup1 td.middle, tr.startGroup1 td.last,
tr.endGroup1 td.middle, tr.endGroup1 td.last {
	background-color: #80FF80;
}
tr.startGroup2 td.first { 
	background-color: #FFFF80;
	padding-top: 2px;
	padding-bottom: 0px;
	background-image: url(ReportService_files/TopTab.gif);
	background-repeat: no-repeat;
	padding-left: 30; 
	background-position: -60px 0;
}
tr.endGroup2 td.first {
	background-color: #FFFF80;
	height: 10px;
	background-image: url(ReportService_files/BottomTab.gif);
	background-repeat: no-repeat;
	padding-left: 30; 
	background-position: -60px 0;
}
tr.group2 td.first {
	padding-left: 30;
}
tr.startGroup2 td.middle, tr.startGroup2 td.last, 
tr.endGroup2 td.middle, tr.endGroup2 td.last {
	background-color: #FFFF80;
}
tr.startGroup3 td.first { 
	background-color: #8080FF;
	padding-top: 2px;
	padding-bottom: 0px;
	background-image: url(ReportService_files/TopTab.gif);
	background-repeat: no-repeat;
	padding-left: 40; 
	background-position: -50px 0;
}
tr.endGroup3 td.first {
	background-color: #8080FF;
	height: 10px;
	background-image: url(ReportService_files/BottomTab.gif);
	background-repeat: no-repeat;
	padding-left: 40; 
	background-position: -50px 0;
}
tr.group3 td.first {
	padding-left: 40;
}
tr.startGroup3 td.middle, tr.startGroup3 td.last, 
tr.endGroup3 td.middle, tr.endGroup3 td.last {
	background-color: #8080FF;
}
tr.startGroup4 td.first { 
	background-color: #FF80FF;
	padding-top: 2px;
	padding-bottom: 0px;
	background-image: url(ReportService_files/TopTab.gif);
	background-repeat: no-repeat;
	padding-left: 50; 
	background-position: -40px 0;
}
tr.endGroup4 td.first {
	background-color: #FF80FF;
	height: 10px;
	background-image: url(ReportService_files/BottomTab.gif);
	background-repeat: no-repeat;
	padding-left: 50; 
	background-position: -40px 0;
}
tr.group4 td.first {
	padding-left: 50;
}
tr.startGroup4 td.middle, tr.startGroup4 td.last, 
tr.endGroup4 td.middle, tr.endGroup4 td.last {
	background-color: #FF80FF;
}
</style></esc>}}}}

zoek en vervang de volgende tekens in je gegenereerde html
*&#0091; door &#40;
*&#0093; door &#41;

knip alles tussen de body tags uit de gegenereerde html en plak dat onder de style in je wiki

evt nog header en TOC verwijderen


opslaan en klaar is klara
Companywebcast API Wiki

Navigation

How to create webservice documentation using techwriter
