Battery Knowledge Base

Item:OSW3d31fba2cdab4da0aa7de038df8bd96d: Difference between revisions

Item Discussion

Item:OSW3d31fba2cdab4da0aa7de038df8bd96d (view source)

Revision as of 17:57, 15 August 2024

32 bytes removed ,  15 August
no edit summary
VisualWikitext
No edit summary
No edit summary
Line 67: Line 67:
|}
|}


=== How to get started ===
== How to get started ==
This is a temporary workspace for writing how-to guides.
This is a temporary workspace for writing how-to guides.


Welcome to the Battery Knowledge Base. This guide assumes no prior knowledge to wikis or ontology, the two main technologies the Battery KB is built upon. The guide will first direct you through some basic actions before giving a more theoretical explanation of how the Battery KB works. First, you need to make an account.
Welcome to the Battery Knowledge Base. This guide assumes no prior knowledge to wikis or ontology, the two main technologies the Battery KB is built upon. The guide will first direct you through some basic actions before giving a more theoretical explanation of how the Battery KB works. First, you need to make an account.


==== How to create an account ====
=== How to create an account ===
# You need an account to make changes to the Battery KB.
# You need an account to make changes to the Battery KB.
# Click on the lower left "profile" icon and click Log in. You will be presented with a Username and Password field.
# Click on the lower left "profile" icon and click Log in. You will be presented with a Username and Password field.
Line 80: Line 80:
# Finished! Once you are logged in, clicking on the "profile" icon in the lower left will open up a new menu with more options, including a link to your user page, preferences, contributions, and logging out.
# Finished! Once you are logged in, clicking on the "profile" icon in the lower left will open up a new menu with more options, including a link to your user page, preferences, contributions, and logging out.


==== How to change your username from your ORCID to a real name: ====
=== How to change your username from your ORCID to a real name: ===
You'll notice that your ORCID has become your user name, which is not useful for others to know who you are.
You'll notice that your ORCID has become your user name, which is not useful for others to know who you are.
# Click on the lower left "profile" icon and click Preferences.
# Click on the lower left "profile" icon and click Preferences.
Line 87: Line 87:
# Finished!
# Finished!


==== How to make yourself a User Entity in the Battery KB (not the same as above): ====
=== How to make yourself a User Entity in the Battery KB (not the same as above): ===
You are now a proper user for editing the Battery KB, but you also need to exist as an User Entity in the Battery KB. This page object reflects who you exist as in reality.
You are now a proper user for editing the Battery KB, but you also need to exist as an User Entity in the Battery KB. This page object reflects who you exist as in reality.
# Go to this page: [[:Category:OSWd9aa0bca9b0040d8af6f5c091bf9eec7]]
# Go to this page: [[:Category:OSWd9aa0bca9b0040d8af6f5c091bf9eec7]]
Line 94: Line 94:
# Save your entity by clicking Save in the top right!  
# Save your entity by clicking Save in the top right!  


==== How to add your User Entity to a project: ====
=== How to add your User Entity to a project: ===
As a User Entity in the Battery KB, you can now essentially tag or define yourself in relation to other objects. For example, try finding your Battery 2030+ project and adding yourself as a Member to that project by doing the following steps.
As a User Entity in the Battery KB, you can now essentially tag or define yourself in relation to other objects. For example, try finding your Battery 2030+ project and adding yourself as a Member to that project by doing the following steps.
# Find your project. You can use search or this Category: [[:Category:OSWb2d7e6a2eff94c82b7f1f2699d5b0ee3]]
# Find your project. You can use search or this Category: [[:Category:OSWb2d7e6a2eff94c82b7f1f2699d5b0ee3]]
Line 108: Line 108:
# Finished! Note: it may take some time for the changes are reflected on the page. You can try refreshing and purging the cache by using Shift+F5.
# Finished! Note: it may take some time for the changes are reflected on the page. You can try refreshing and purging the cache by using Shift+F5.


==== How to add your User Entity to an organization: ====
=== How to add your User Entity to an organization: ===
You can add yourself to an organization (typically, your employer but also other types of organizations like departments or smaller units like research groups). But this is done differently from adding yourself to a Project.
You can add yourself to an organization (typically, your employer but also other types of organizations like departments or smaller units like research groups). But this is done differently from adding yourself to a Project.
# Find your organization. You can use search or this Category: [[:Category:OSW1969007d5acf40539642877659a02c23]].
# Find your organization. You can use search or this Category: [[:Category:OSW1969007d5acf40539642877659a02c23]].
Line 133: Line 133:
## '''Member of''': If your organization belongs to a larger organizational unit, then you can edit your organization's entity page to show that it is a '''Member of''' the larger organization. If you put the organization as a '''Member of''' the project (this shouldn't be allowed anyway, but you may be confused as to why), it means your project would own your organization (which probably isn't true). However, a '''Project''' might be a '''Member of''' a larger family of projects.
## '''Member of''': If your organization belongs to a larger organizational unit, then you can edit your organization's entity page to show that it is a '''Member of''' the larger organization. If you put the organization as a '''Member of''' the project (this shouldn't be allowed anyway, but you may be confused as to why), it means your project would own your organization (which probably isn't true). However, a '''Project''' might be a '''Member of''' a larger family of projects.


==== How to understand the Battery KB: ====
=== How to understand the Battery KB: ===
You should now have a proper '''User Entity''', which has both '''Project'''  and an '''Organization''' '''Entities''' to which it is related as a '''Member'''. At this point, it's good to explain how the Battery KB is a little different.
You should now have a proper '''User Entity''', which has both '''Project'''  and an '''Organization''' '''Entities''' to which it is related as a '''Member'''. At this point, it's good to explain how the Battery KB works.


# The Battery KB is a "wiki" very much like Wikipedia, in the sense that every page is open for editing by all Users.
# The Battery KB is a "wiki" very much like Wikipedia in the sense that every page is open for editing by all Users.
# The Battery KB is <u>''not''</u> like Wikipedia because of its underlying ontological framework. This makes is harder for Users to understand how to edit and contribute compared to Wikipedia.  
# The Battery KB is <u>''not''</u> like Wikipedia because of its underlying ontological framework. This makes is harder for Users to understand how to edit and contribute compared to Wikipedia.
# ''What is ontological framework?'' Simply put, this means essentially that '''everything''' is classified as a categorical entity with defined relationships to other objects, and ''nothing'' should exist outside of this framework.
# ''What is ontological framework?'' Simply put, this means essentially that '''everything''' is classified as a categorical entity with defined relationships to other objects, and ''nothing'' should exist outside of this framework.
# That means, compared to other wikis where you might simply create a page by writing on a blank slate and then link it to other places, you first instead go the '''Category''' to which that '''Entity''' would belong and create it from there along with defining some of its necessary traits.
# That means, compared to other wikis where you might simply create a page by writing on a blank slate and then link it to other places, you first instead go the '''Category''' to which that '''Entity''' would belong and create it from there along with defining some of its necessary traits.
## Example: if I wanted to create a page for myself in Wikipedia, I would create an article called Samson Y. Lai, and then write my biography and click Save. However, unless another Wikipedia article links to my article or vice versa, my article would essentially be {{Template:Viewer/Link|page=|url=https://en.wikipedia.org/wiki/Wikipedia:Orphan|label=orphaned}} and difficult to find except by explicit search. A person or bot editor would also later need to manually add Categories, such as "Person" and "Scientist" and "American", which can be difficult to assign or define after the fact.
## Example: if I wanted to create a page for myself in Wikipedia, I would create an article called Samson Y. Lai, and then write my biography and click Save. However, unless another Wikipedia article links to my article or vice versa, my article would essentially be {{Template:Viewer/Link|page=|url=https://en.wikipedia.org/wiki/Wikipedia:Orphan|label=orphaned}} and difficult to find except by explicit search. A person or bot editor would also later need to manually add Categories, such as "Person" and "Scientist" and "American", which can be tedious to assign or difficult to define.
## Conversely, in the Battery KB, to make a page which represents me, I go to the '''Category''' called "'''User'''" and create a new '''User Entity'''. This '''User Entity''' is an object that has pre-defined parameters, such as name, role, location, and relevant relationships to other '''Entities''' (e.g., '''Organization'''). In this way, the parameters are consistently used by all objects (no issues of "Person" vs. "Persons" vs. "person", etc.).
## Conversely, in the Battery KB, to make a page which represents me, I go to the '''Category''' called '''User''' and create a new '''User Entity'''. This '''User Entity''' is an object that has pre-defined parameters, such as name, role, location, and relevant relationships to other '''Entities''' (e.g., '''Organization'''). In this way, the parameters are consistently used by all objects (no issues of "Person" vs. "Persons" vs. "person", etc.).
## This approach also applies to any other new '''Entity''': first find the '''Category''' that '''Entity''' would belong to, then create it using the +Create button and fill in the important parameters.
## This approach also applies to any other new '''Entity''': first find the '''Category''' that '''Entity''' would belong to, then create it using the +Create button and fill in the important parameters.
## For advanced users: some relationship parameters are pre-defined, but it is possible to add new parameters to a whole category. This should be done in consultation with those involved with curating the ontological infrastructure so as to be consistent and organized.
## For advanced users: some relationship parameters are pre-defined, but it is possible to add new parameters to a whole category. This should be done in consultation with those involved with curating the ontological infrastructure so as to be consistent and organized.
Line 147: Line 147:
## An ontological framework means that all of the information is both ''human-''readable and ''machine''-readable. This enables both humans and AIs/algorithms to sort and understand the data better by understanding what kind of data it is and how it is related to other data.
## An ontological framework means that all of the information is both ''human-''readable and ''machine''-readable. This enables both humans and AIs/algorithms to sort and understand the data better by understanding what kind of data it is and how it is related to other data.
## Having an ontological framework also means that data isn't "loose" and lost as some uncategorized piece. Remember: '''everything''' is classified as a categorical entity with defined relationships to other objects, and ''nothing'' should exist outside of this framework.
## Having an ontological framework also means that data isn't "loose" and lost as some uncategorized piece. Remember: '''everything''' is classified as a categorical entity with defined relationships to other objects, and ''nothing'' should exist outside of this framework.
## The design of Battery KB <u>forces</u> specific fields to link to an '''Entity''' instead of simply having a free-text field. This helps prevent data from existing outside of the ontological framework.  
## The design of the Battery KB <u>forces</u> specific fields to link to an '''Entity''' instead of simply having a free-text field. This helps prevent data from existing outside of the ontological framework.
## Ontology and ontological frameworks have already been proven to be an effective method of sorting information and is already in use in search algorithms, such as by Google.
## Ontology and ontological frameworks have already been proven to be an effective method of sorting information and is already in use in search algorithms, such as Google's.


==== How to add a new entity on the fly: ====
=== How to add a new entity on the fly: ===
So you've created an entity or two under the Categories. But, maybe you had some trouble putting in entities that don't exist yet because this wiki is in its early stages of creation. It can be a hassle to start creating a new '''Entity''', like a new '''User''', only to find that you want to link to other '''Entities''' that don't exist yet, like a new '''ResearchOrganization'''.
So you've created an Entity or two under the Categories. But, maybe you had some trouble putting in Entities that don't exist yet because this wiki is in its early stages of creation. It can be a hassle to start creating a new '''Entity''', like a new '''User''', only to find that you want to link to other '''Entities''' that don't exist yet, like a new '''ResearchOrganization'''.


# Go to [[:Category:OSW1969007d5acf40539642877659a02c23]] and find your organization.
# Go to [[:Category:OSW1969007d5acf40539642877659a02c23]] and find your organization.
Line 164: Line 164:
# Finished! Next step: improve the quality of your '''User Entity'''. Here is an example a good quality User Entity: [[Item:OSW72e733f317ef4cf9b8ca53e906c9acb9|Simon Clark]].  
# Finished! Next step: improve the quality of your '''User Entity'''. Here is an example a good quality User Entity: [[Item:OSW72e733f317ef4cf9b8ca53e906c9acb9|Simon Clark]].  


=== How to contribute to the wiki ===
=== How to contribute to the Battery KB ===
OK, now you should be set up with the basics of a user account and understand the basic mechanics of how the Battery KB is built. Now, you want to start making real contributions to the content. Here are some how-to guides for specific actions when creating wiki content.
OK, now you should be set up with the basics of a user account and understand the basic mechanics of how the Battery KB is built. Now, you want to start making real contributions to the content. Here are some how-to guides for specific actions when creating wiki content.


Retrieved from "https://battery.knowledge-graph.eu/wiki/Special:MobileDiff/2906"