HowTo: Difference between revisions

From wiki
Jump to navigation Jump to search
No edit summary
Line 40: Line 40:


You'll get visualizations of your structure in UML and a prototype Wiki content as a result
You'll get visualizations of your structure in UML and a prototype Wiki content as a result
=== Convert Existing Content ===
If you have existing content (like the SMWCon List of Attendees), convert it to use the newly created semantic structure. This may involve:
* Transforming existing content to semantic mediawiki pages (e.g by adapting existing templates or importing structured content)
* Replacing free-text information with property assignments
* Creating new pages for concepts that were previously only mentioned in free text
* changing the Structure to faciliated linking between contents to create a true knowled graph
=== Maintain Consistency ===
Regularly review and update your semantic structure. As your domain evolves, make sure to:
* Update the Context
* Regenerate semantic elements and the diagrams as needed
* Refactor existing content to match the updated structure
=== Tools ==
All tools being used are open source and have been used for many years in quite a few projects already.
* wikipush
* py-sidif
* pyMetaModel
* pyMediaWikiDocker
* py-y-principle generator
==== AI / ChatBots ===
With AI and Chatbots following this process is even simpler, faster and more effective.


== Examples ==
== Examples ==
Line 56: Line 82:
Over the years, additions were made, but unfortunately, SMWCon didn't fully embrace the power of self -reflective semantification.  
Over the years, additions were made, but unfortunately, SMWCon didn't fully embrace the power of self -reflective semantification.  


=== 3. Set Up Your Wiki ===
Utilize ProfiWiki and py-mediawikidocker to set up your Semantic MediaWiki environment. This provides a solid foundation for your semantified wiki.
=== 4. Implement Self-Reflection ===
Follow Pierre Racine's proposal for metadata management. Implement a self-reflective structure where properties and other semantic elements are themselves described using semantic annotations.
=== 5. Convert Existing Content ===
If you have existing content (like the SMWCon List of Attendees), convert it to use the newly created semantic structure. This may involve:
* Updating pages to use the new templates
* Replacing free-text information with property assignments
* Creating new pages for concepts that were previously only mentioned in free text
=== 6. Maintain Semantic Consistency ===
Regularly review and update your semantic structure. As your domain evolves, make sure to:
* Update the UML diagram
* Regenerate semantic elements as needed
* Refactor existing content to match the updated structure


== Lessons Learned from SMWCon ==
== Lessons Learned from SMWCon ==
Line 87: Line 91:
5. Embrace Self-Reflection: Implement a system where your wiki's structure is itself described semantically, allowing for easier management and evolution of your knowledge base.
5. Embrace Self-Reflection: Implement a system where your wiki's structure is itself described semantically, allowing for easier management and evolution of your knowledge base.


== Conclusion ==


By following this process and learning from the SMWCon experience, you can create a truly semantified wiki that leverages the full power of Semantic MediaWiki. Remember, the goal is not just to add properties to pages, but to create a interconnected, self-describing knowledge base that can evolve with your needs.
= Links =
 
=== Further Reading ===
* [https://www.semantic-mediawiki.org/wiki/Metadata_management Metadata management in Semantic MediaWiki]
* [https://www.semantic-mediawiki.org/wiki/Metadata_management Metadata management in Semantic MediaWiki]
* [https://www.semantic-mediawiki.org/wiki/Help:Properties Working with properties in SMW]
* [https://www.semantic-mediawiki.org/wiki/Help:Properties Working with properties in SMW]
* [https://www.semantic-mediawiki.org/wiki/Help:Semantification_tutorials Semantification tutorials]
* [https://www.semantic-mediawiki.org/wiki/Help:Semantification_tutorials Semantification tutorials]


 
<headertabs/>
This revised version focuses on the correct process for semantification, emphasizing the lessons learned from the SMWCon experience and the importance of avoiding redundancy while leveraging the full power of Semantic MediaWiki. It also includes references to the tools and concepts you mentioned, such as the y-principle generator, ProfiWiki, and py-mediawikidocker.

Revision as of 08:30, 7 August 2024

[edit]

This guide outlines a systematic approach starting with your Needs and ending up with a fully operational Semantic MediaWiki that you may use as a prototype of even for production.

The Ideal Process

Start with gathering your needs

You can do this systematic, semi-systematic or fully freestyle in natural languages. Just make sure you get to an agreement between the stakeholders about what is relevant and capture the needs in computer readable form.

Set Up Your Wiki

Utilize ProfiWiki and py-mediawikidocker to set up your Semantic MediaWiki environment. This provides a solid foundation for your semantified wiki in a few minutes.

Create a Context for your project

You'll find examples context right in this wiki at List of Contexts Currently there are 16 example Contexts available:

Contextsinceupdatedmaster
BookContext7 August 20248 August 2024https://contexts.bitplan.com/index.php/BookContext
CityContext22 August 201529 October 2024https://contexts.bitplan.com/index.php/CityContext
ConfIDentMetadataSchema15 April 20207 August 2024https://contexts.bitplan.com/index.php/ConfIDentMetadataSchema
CrSchema22 July 202021 March 2023http://cr.bitplan.com
FamilyContext13 January 20157 August 2024https://contexts.bitplan.com/index.php/FamilyContext
Infrastructure27 July 202421 August 2024https://contexts.bitplan.com/index.php/Infrastructure
MetaModel23 January 20157 August 2024https://contexts.bitplan.com/index.php/MetaModel
OpenSourceProjectsContext31 October 201718 December 2022http://contexts.bitplan.com/index.php/OpenSourceProjectsContext
Presentation10 January 201522 December 2017https://contexts.bitplan.com/index.php/Presentation
QueryContext19 March 202319 March 2023https://contexts.bitplan.com/index.php/QueryContext
ResearchContext4 August 20207 August 2024https://contexts.bitplan.com/index.php?title=ResearchContext
SMWCon30 October 20157 August 2024https://contexts.bitplan.com/index.php/SMWCon
TeachingSchema16 January 20235 April 2023https://contexts.bitplan.com/index.php/TeachingSchema
WebContext31 October 2017http://wiki.bitplan.com/index.php/WebContext
WikiContext19 August 20157 August 2024https://contexts.bitplan.com/index.php/WikiContext
SmartRQM1 January 19968 July 2024http://rq.bitplan.com

Generate Semantic Structure

Use the y-principle generator to automatically create:

  • Concept pages
  • Templates
  • Forms
  • Help pages
  • Properties
  • List pages

That the Topic/Properties and TopicLinks needed for your Context. This approach ensures consistency and reduces redundancy in your wiki structure.

You'll get visualizations of your structure in UML and a prototype Wiki content as a result

Convert Existing Content

If you have existing content (like the SMWCon List of Attendees), convert it to use the newly created semantic structure. This may involve:

  • Transforming existing content to semantic mediawiki pages (e.g by adapting existing templates or importing structured content)
  • Replacing free-text information with property assignments
  • Creating new pages for concepts that were previously only mentioned in free text
  • changing the Structure to faciliated linking between contents to create a true knowled graph

Maintain Consistency

Regularly review and update your semantic structure. As your domain evolves, make sure to:

  • Update the Context
  • Regenerate semantic elements and the diagrams as needed
  • Refactor existing content to match the updated structure

= Tools

All tools being used are open source and have been used for many years in quite a few projects already.

  • wikipush
  • py-sidif
  • pyMetaModel
  • pyMediaWikiDocker
  • py-y-principle generator

= AI / ChatBots

With AI and Chatbots following this process is even simpler, faster and more effective.


Examples

SMWCon

SMWCon is the acronym for the Semantic Mediawiki conference The lessons learned from the SMWCon experience and best practices in Semantic MediaWiki (SMW) are the basis for this example

Historical Context: SMWCon and List of Attendees

The journey of semantification for SMWCon began with the creation of the first SMWCon page using SemanticMediaWiki properties to capture information about SMWCon Events. https://www.semantic-mediawiki.org/wiki/SMWCon_Fall_2011 is an example for such a SMWCon page.

The proper way to handle the catalog of properties (Metadata management) has been much debated.

A self-reflective, semantified version of the Attendees list, as proposed by Pierre Racine (see Metadata management) of the List of Attendees at SMWCon Fal 2015 was a step forward. Over the years, additions were made, but unfortunately, SMWCon didn't fully embrace the power of self -reflective semantification.


Lessons Learned from SMWCon

1. Avoid Redundancy: Don't copy-paste content. Use semantic properties and queries to display information in multiple contexts. 2. Eat Your Own Dog Food: If you're promoting semantification, use it extensively in your own wiki. 3. Maintain Consistency: Regularly review and update your semantic structure to ensure it remains relevant and efficient. 4. Automate Where Possible: Use tools like the y-principle generator to maintain consistency and reduce manual work. 5. Embrace Self-Reflection: Implement a system where your wiki's structure is itself described semantically, allowing for easier management and evolution of your knowledge base.


Retrieved from "https://contexts.bitplan.com/index.php?title=HowTo&oldid=209"