Complete Tools Reference
Detailed documentation for all available tools in the MediaWiki Migration toolkit.
Quick Navigation: Migration Tools | Utility Tools | Setup Tools
đ Migration Tools
Purpose: Main migration tool for transferring Azure DevOps Wiki content to MediaWiki.
Basic Usage
Command-Line Options
Option | Description | Default |
---|---|---|
--wiki |
Name of the Azure DevOps wiki to migrate | Required |
--dry-run |
Preview migration without making changes | False |
--batch-size |
Number of pages to process at once | 50 |
--page |
Migrate specific page only | None |
--folder |
Migrate specific folder only | None |
--skip-validation |
Skip post-migration validation | False |
Examples
Purpose: Analyses Azure DevOps Wiki structure and content to plan migration strategy.
Basic Usage
Command-Line Options
Option | Description | Default |
---|---|---|
--wiki |
Name of the Azure DevOps wiki to analyse | Required |
--detailed |
Generate detailed analysis report | False |
--export-analysis |
Export analysis to JSON file | False |
--output |
Output file path for export | analysis.json |
Analysis Output
- Total page count and size
- Content complexity score
- Estimated migration time
- Potential issues and warnings
- Resource requirements
Purpose: Preview how Azure DevOps content will appear after conversion to MediaWiki format.
Basic Usage
Command-Line Options
Option | Description | Default |
---|---|---|
--page |
Specific page to preview | None |
--sample-pages |
Number of random pages to preview | 5 |
--output-dir |
Directory to save preview files | ./previews |
--format |
Output format (html, markdown, both) | both |
--verbose |
Show detailed conversion information | False |
Purpose: Validates migrated content for accuracy and completeness.
Basic Usage
Validation Checks
- Page count verification
- Content integrity checks
- Link validation
- Image reference verification
- Template usage validation
- Formatting consistency
Output
Generates validation_report.md
with:
- Summary statistics
- List of issues found
- Recommendations for fixes
- Success/failure status for each page
đ§ Utility Tools
Purpose: Import templates and infoboxes into MediaWiki.
Location: templates/mediawiki_import.py
Features
- Import Wikipedia templates
- Convert template syntax
- Handle template dependencies
- Batch import support
Purpose: Generate HTML documentation for repository catalogue.
Basic Usage
Generates the repository list page at docs/site/repolist.html
âī¸ Setup & Configuration Tools
Purpose: Interactive setup wizard for configuring the migration toolkit.
Basic Usage
Features
- Interactive menu system
- Environment detection
- Automatic configuration file creation
- Dependency checking
- Test mode for development
Menu Options
- đĻ Azure DevOps Wiki Migration
- đ Wiki Sync Tool
- đ¨ Template Import Tool
- đ Wiki Monitoring Dashboard
- đ ī¸ Maintenance Scripts
- âšī¸ About this Toolkit
Need Help? All tools support the --help
flag for detailed usage information. For example: