Application "smw-cindykate"

From SMW CindyKate - Main
Component 759410
Jump to: navigation, search


Dataspects Business Aspects

What's the story behind Application "smw-cindykate"?

Application "smw-cindykate" is a Ruby command-line application for managing/refactoring Semantic MediaWikis. It supports the following use cases:

It plays a vital role in Concept "Controlled, faceted, multilateral, asynchronous, bidirectional synchronisation of multiple SMWs (CFMABS)".

It uses connection and configuration profiles (declared in YAML files) for all SMWs that you want to work with.

It supports 2 levels of content/process directives:

How can Application "smw-cindykate" be used?

Each use case works with a set of pages

This set of SMWCindyKate::Pages loads SMWCindyKate::Page instances into its @pages[page.sPageName] = page:

You can then define selections of pages using these methods

On page selections you can mutate wikitext using these methods

When done, you can use these methods to store pages


Application Command Synopsis Examples
Application Command "smw-cindykate content compare"


  • Flag --profile <smw-profiles.yaml>


  • Switch --recent-changes-since


Application Command "smw-cindykate content extract"


  • Flag --profile <smw-profiles.yaml>


  • Switch --extract-page-history
  • Switch --recent-changes-since
  • Switch --dry-run


This command takes a content-reference and calls SMWCindyKate::SMWContentReference.store_pages_to_repository(repository_url). (An alternative is to use Application Command "smw-cindykate content manage" and call, page) on each of the final SMWCindyKate::Pages.pages.)

smw-cindykate content extract smwck_restored#my_extraction_script1.rb /home/user/smwck_repo1/
Application Command "smw-cindykate content inject"


  • Flag --profile <smw-profiles.yaml>

smw-cindykate content

  • Switch --allow-uncommitted-or-non-git
  • Switch --dry-run

smw-cindykate inject

  • Argument 1 <repository-url>
  • Argument 2 <smw-identifier>
Application Command "smw-cindykate content manage"


  • Flag --profile <smw-profiles.yaml>

smw-cindykate content

  • Switch --print-pages-wikitext
  • Switch --purge-pages

smw-cindykate manage

Application Command "smw-cindykate monitor"

Methods and Testing

See Overview "Testing smw-cindykate".