I Visual DataFlex, når man offentliggør en funktion som en Web Service, har man muligheden for at supplere med en “beskrivelse” af funktionen:

{ Published = True  }
{ Description = "This is the web service description"  }
Function Foo Returns String
    Function_Return "Foo"
End_Function

Denne beskrivelse står i WSDL filen der genereres for web servicen, og vises på den side der fungerer som oversigt over servicen, når man tilgår denne i en browser. Umiddelbart giver det ikke mening at tilføje markup til beskrivelsen, for HTML tags vises bare som synlige tags i beskrivelsen. Skulle man ønske at tilføje markup til sine beskrivelser, f.eks. for at bruge disse som egentlig dokumentation, så kan det dog let bringes til at virke.

Siden der vises når man tilgår en .wso URI dannes ved en XSL transformation af noget XML data. XSL transformationen styres af den fil der er nævnt ud for ServicePageGenerator= i .wso filen. Som standard hedder den DefaultWebServiceHomePage.xslt, og ligger i Lib mappen under din Visual DataFlex installation.

Ønsker du at gøre brug af HTML i dine funktionsbeskrivelser er der to muligheder: enten retter du i DefaultWebServiceHomePage.xslt, eller også laver du en ændret kopi, og retter i dine .wso filer (bare rolig, dine rettelser bliver ikke overskrevet når filen opdateres ved kompilering). Uanset hvilken løsning du vælger så er ændringen du skal foretage følgende.

Find:

<xsl:template match="wso:documentation">
  <span>
    <xsl:copy-of select="*|text()" />
  </span>
</xsl:template>

Ret til:

<xsl:template match="wso:documentation">
  <span>
    <xsl:value-of select="text()" disable-output-escaping="yes" />
  </span>
</xsl:template>

Den tilføjede attribut forhindrer at specielle XML karakterer som < og > oversættes til &lt; og &gt;, hvormed markup’en forbliver intakt. Og så kan man skrive beskrivelser som

{ Published = True  }
{ Description = "<a href='/mywsdoc/'>Click here</a> for the web service documentation"  }
Function Foo Returns String
    Function_Return "Foo"
End_Function