Editing
Wiki Tooling Guide
From H4KS
Jump to navigation
Jump to search
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
== 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/Main''Page. === 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 === * MediaWiki''Search ** Purpose: Search for pages or content by keywords. ** Required parameter: Search''Term (string) ** Example input: <pre><pre>{</pre> "Search''Term": "IRC-channel-guide" }</pre> ** Output: A list of matching page titles and snippets (as returned by the underlying API). * Get''Wiki''Page ** Purpose: Retrieve the content of a page by its title. ** Required parameter: Page''Title (string) ** Example input: Page''Title = "Main''Page" ** Output: Page content (in wiki markup) for the specified title. * Create''Edit''Wiki''Page ** Purpose: Create a new page or update an existing one. ** Required parameters: <pre>- Page''Title (string)</pre> <pre>- Page''Content (string)</pre> ** Example input: <pre><pre>{</pre> "Page''Title": "Wiki''Tooling''Guide", "Page''Content": "<wiki>Sample content for the tooling guide.</wiki>" }</pre> ** Output: Confirmation of creation or update, and the new page revision/version if available. * Delete''Wiki''Page ** Purpose: Delete a page with a justification. ** Required parameters: <pre>- Page''Title (string)</pre> <pre>- Delete''Reason (string)</pre> ** Example input: Page''Title = "Old''Page", Delete''Reason = "Obsolete and superseded by new tooling guide" ** Output: Deletion confirmation with a revision history note. === How to use === * Basic operations: ** Read a page: Get''Wiki''Page with Page''Title. ** Create a new page: Create''Edit''Wiki''Page with a new Page''Title and Page''Content. ** Update an existing page: Create''Edit''Wiki''Page with the same Page''Title and updated Page''Content. ** Delete a page: Delete''Wiki''Page with Page''Title and Delete''Reason. * Searching: ** Use MediaWiki''Search 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 multi''tool''use.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 Get''Wiki''Page (optional). 2) Create the page with Create''Edit''Wiki''Page using a well-formed Page''Content. 3) Verify by reading the page with Get''Wiki''Page. * Example 2: Update an existing page 1) Retrieve current content with Get''Wiki''Page. 2) Prepare updated content and apply via Create''Edit''Wiki''Page. 3) Confirm update via Get''Wiki''Page and view revision history. === Example: Wiki''Tooling''Guide === 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 Page''Title is valid (no illegal characters or reserved prefixes). ** Check Page''Content 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/Main''Page * IRC Channel Guide: https://wiki.h4ks.com/index.php/IRC''Channel_Guide
Summary:
Please note that all contributions to H4KS are considered to be released under the Creative Commons Attribution (see
H4KS:Copyrights
for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource.
Do not submit copyrighted work without permission!
Cancel
Editing help
(opens in new window)
Navigation menu
Page actions
Page
Discussion
Read
Edit
History
Page actions
Page
Discussion
More
Tools
Personal tools
Not logged in
Talk
Contributions
Create account
Log in
Navigation
Main page
Recent changes
Random page
Help about MediaWiki
Search
Tools
What links here
Related changes
Special pages
Page information