WebSupergoo documentation

Search the WebSupergoo documentation and web site. Returns the best-matching sections, each with where it is in the documentation, its id, URL and a snippet. Snippets are partial: fetch the sections that look relevant before deciding they don't answer; contents shows the pages around one. Short queries work best - two to four key words, or the API name if you can guess it. Set product for technical questions. If the results miss, search again with fewer words, or with the name the documentation would use (a class, method or property). For a class or member you already know, lookup_api is quicker.

{
  "type": "object",
  "properties": {
    "query": {
      "description": "A few key words for what the user wants (\"watermark behind content\", \"split pages\"), or a line of their code (doc.HtmlOptions.Engine = EngineType.Chrome). A whole question works too, but extra words can push the right page down.",
      "type": "string"
    },
    "product": {
      "description": "The product the question is about: abcpdf, imageglue, wordglue or abcocr. Set it for technical questions; tell it from the user's code (WebSupergoo.ABCpdf* namespaces or Doc objects: abcpdf), and if unsure, use abcpdf. It leaves out pages for other products and general pages about purchasing, licensing and the company - so leave it out for those questions.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    },
    "type": {
      "description": "Only this content type (an id from list_products: docs, purchasing, support...). Usually left out.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    },
    "code": {
      "description": "Only sections that are sample code - when you want an example to adapt.",
      "type": "boolean",
      "default": false
    },
    "limit": {
      "description": "How many results (1-20).",
      "type": "integer",
      "default": 8
    }
  },
  "required": [
    "query"
  ]
}

List the products (ids for the product parameter), with where each one's documentation starts, and the content types (ids for the type parameter).

{
  "type": "object",
  "properties": {}
}

Where a page is in the documentation, and what is around it: the folder it is in, the pages next to it (for a property, the class's other properties) or the pages it contains. Without an id, the top of the contents.

{
  "type": "object",
  "properties": {
    "id": {
      "description": "A page id (from search, lookup_api or fetch), a folder id from an earlier contents call, or a page URL. Leave out for the top.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    }
  }
}

Tell the WebSupergoo team about a documentation problem, so they can fix it. Use it yourself, without being asked, whenever you notice one: the documentation didn't answer the question; search didn't find the right page (it was low down, or you only found it another way); a page is wrong, unclear, out of date or has a typo; or an example doesn't work. Before reporting that the documentation has no answer, try at least two rewordings (short key words, the likely API name) and read the likeliest sections in full; if an answer exists but was hard to find, report that instead. One report per problem, after you've answered the user. Don't include the user's personal details or private code.

{
  "type": "object",
  "properties": {
    "comment": {
      "description": "What was wrong or missing, and what would have helped: the page you expected, or the wording that would have found it.",
      "type": "string"
    },
    "query": {
      "description": "The question or search it was about, if any.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    },
    "page": {
      "description": "The page id or URL it was about, if any.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    }
  },
  "required": [
    "comment"
  ]
}

Find a class or member of a WebSupergoo API by name - Doc.AddImageUrl, AddImageUrl, XImage.SetFile - even partial or misspelt. Returns the matching reference pages; for an exact match, the page itself. Enumerations are found on the member pages that list their values. A name that isn't in the API (a class in an example project) gets search results instead.

{
  "type": "object",
  "properties": {
    "name": {
      "description": "The class or member name, optionally with its class: Doc.Rect, AddImageUrl, XHtmlOptions.",
      "type": "string"
    },
    "product": {
      "description": "The product the question is about: abcpdf, imageglue, wordglue or abcocr. Set it for technical questions; tell it from the user's code (WebSupergoo.ABCpdf* namespaces or Doc objects: abcpdf), and if unsure, use abcpdf. It leaves out pages for other products and general pages about purchasing, licensing and the company - so leave it out for those questions.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    }
  },
  "required": [
    "name"
  ]
}

Read a documentation page as Markdown, by the id that search, lookup_api or contents gave - or by its websupergoo.com URL. A section id (page.md#2) with section_only gives just that section.

{
  "type": "object",
  "properties": {
    "id": {
      "description": "A page id (helppdfnet/source/5-abcpdf/doc/1-methods/addimageurl.md), a section id (...md#2) or a page URL.",
      "type": "string"
    },
    "section_only": {
      "description": "With a section id: only that section.",
      "type": "boolean",
      "default": false
    }
  },
  "required": [
    "id"
  ]
}