Wiki Tooling Guide

Wiki Tooling Guide

This article documents the built-in wiki tooling used by the AI assistant to manage and maintain the company's wiki. It includes information about the tools, how to call them, recommended workflows, safety considerations, and example scenarios. The guidance here is intended for maintainers and automated workflows that modify wiki content on https://wiki.h4ks.com/index.php/MainPage.

Overview

The wiki tooling set provides programmatic access to read, search, create, update, and delete wiki pages. It is designed to support automation tasks, reduce manual work, and ensure content consistency across the wiki ecosystem.

Tools and Interfaces

• MediaWikiSearch
  • Purpose: Search for pages or content by keywords.
  • Required parameter: SearchTerm (string)
  • Example input:

<pre>{

 "SearchTerm": "IRC-channel-guide"

}

• • Output: A list of matching page titles and snippets (as returned by the underlying API).

• GetWikiPage
  • Purpose: Retrieve the content of a page by its title.
  • Required parameter: PageTitle (string)
  • Example input: PageTitle = "MainPage"
  • Output: Page content (in wiki markup) for the specified title.

• CreateEditWikiPage
  • Purpose: Create a new page or update an existing one.
  • Required parameters:

- Page''Title (string)

- Page''Content (string)

• • Example input:

<pre>{

 "PageTitle": "WikiToolingGuide",
 "PageContent": "<wiki>Sample content for the tooling guide.</wiki>"

}

• • Output: Confirmation of creation or update, and the new page revision/version if available.

• DeleteWikiPage
  • Purpose: Delete a page with a justification.
  • Required parameters:

- Page''Title (string)

- Delete''Reason (string)

• • Example input: PageTitle = "OldPage", DeleteReason = "Obsolete and superseded by new tooling guide"
  • Output: Deletion confirmation with a revision history note.

How to use

• Basic operations:
  • Read a page: GetWikiPage with PageTitle.
  • Create a new page: CreateEditWikiPage with a new PageTitle and PageContent.
  • Update an existing page: CreateEditWikiPage with the same PageTitle and updated PageContent.
  • Delete a page: DeleteWikiPage with PageTitle and DeleteReason.
• Searching:
  • Use MediaWikiSearch with a term to locate pages of interest before editing or creating content.
• Parallel workflows:
  • When multiple independent calls are needed, they can be executed in parallel via multitooluse.parallel. Example: fetch a page while performing a search, then apply updates based on results.

Best practices

• Use descriptive, stable page titles to avoid churn.
• Include a changelog or revision notes within the page content when making updates.
• Structure content with clear headings, lists, and concise paragraphs to improve readability.
• Prefer internal wiki links for navigation and avoid hard-coding external domains unless necessary.
• Validate page existence before updates to minimize accidental overwrites.

Safety and governance

• Editing and deletion permissions should be restricted to authorized editors.
• Maintain a revision history and back up important pages before large changes.
• Avoid exposing sensitive information in page content; redact when necessary and follow data governance policies.

Example workflows

• Example 1: Create a new page for a tooling guide

 1) Check existence with GetWikiPage (optional).
 2) Create the page with CreateEditWikiPage using a well-formed PageContent.
 3) Verify by reading the page with GetWikiPage.

• Example 2: Update an existing page

 1) Retrieve current content with GetWikiPage.
 2) Prepare updated content and apply via CreateEditWikiPage.
 3) Confirm update via GetWikiPage and view revision history.

Example: WikiToolingGuide

This page itself serves as an example. Use it to document how the tooling is used, approved workflows, and best practices for maintaining the wiki.

Troubleshooting

• If a page creation or update fails:
  • Verify PageTitle is valid (no illegal characters or reserved prefixes).
  • Check PageContent for syntax or markup issues.
  • Ensure you have permissions to edit the target page.
  • Review system status or error messages returned by the tool interface.

See also

• Main Page: https://wiki.h4ks.com/index.php/MainPage
• IRC Channel Guide: https://wiki.h4ks.com/index.php/IRCChannel_Guide