Book a Demo

Author Topic: Search engine indexing of HTML documentation  (Read 4137 times)

poiqwepoi

  • EA Novice
  • *
  • Posts: 11
  • Karma: +0/-0
    • View Profile
Search engine indexing of HTML documentation
« on: April 15, 2014, 01:42:48 am »
I am wondering if I publish an HTML version of the documentation, will search engines be able to index it?

Thanks

Nizam Mohamed

  • EA User
  • **
  • Posts: 193
  • Karma: +1/-0
    • View Profile
Re: Search engine indexing of HTML documentation
« Reply #1 on: April 15, 2014, 02:38:38 pm »
I don't see a reason why it wouldn't be indexed by Search Engines, but make sure you want them to be published as is, as I'm afraid many SEO naming conventions are not considered in the standard HTML reporting utility.

OpenIT Solutions

  • EA User
  • **
  • Posts: 555
  • Karma: +9/-1
    • View Profile
Re: Search engine indexing of HTML documentation
« Reply #2 on: April 16, 2014, 02:43:38 am »
Hi,

I looked at indexing the html / xml generated by Sparx - but didn't get very far. There have been posts in the past - but i don't think they amounted to much.

If your interested - the solution i've ended up with is to alter the html fragment that sparx uses to create toc.htm to include a search box/button that posts to a web application i've developed (ASP or Java avalible). The web app performs a search using the automation interface and displays the result in the main page of the sparx generated portal. Each row of the result includes a link to the related elements html.

If there is any interest, ill look at packaging and publishing on the community site ?

poiqwepoi

  • EA Novice
  • *
  • Posts: 11
  • Karma: +0/-0
    • View Profile
Re: Search engine indexing of HTML documentation
« Reply #3 on: April 16, 2014, 12:01:36 pm »
Thank you Nizam and OpenIT for your answers.   What I am looking to do is to build a model and publish it on the web.  I was hoping dor the content to be searchable because it is where the information lies.   For instance, package names, classes names, notes, etc.

The audience of the search would not be someone who knows that the model exists, but who finds the existence of the model by a search engine.  


OpenIT Solutions

  • EA User
  • **
  • Posts: 555
  • Karma: +9/-1
    • View Profile
Re: Search engine indexing of HTML documentation
« Reply #4 on: April 16, 2014, 11:24:17 pm »
Ah - sorry crossed wires there - in which case you would need to edit the html fragment "Page - Basic Template" in Sparx to include the html meta tags used by search engines such as google when indexing.


See for example:
https://support.google.com/webmasters/answer/79812?hl=en

Regards,

Jon.