Item:OSW170b321e13ee4a1cb2005193da045ec1
No edit summary Tag: Metadata slot edit |
No edit summary |
||
Line 14: | Line 14: | ||
#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]] | ||
#At the top, click + Create. | #At the top, click '''+''' Create. | ||
#Fill in the parameters where relevant and required. At a minimum, first name and last name. Note: you might not be able to find your organization yet. Don't worry, if so, that's an exercise for later. | #Fill in the parameters where relevant and required. At a minimum, first name and last name. Note: you might not be able to find your organization yet. Don't worry, if so, that's an exercise for later. | ||
#Save your entity by clicking Save in the top right! | #Save your entity by clicking Save in the top right! | ||
#If you're still having trouble, you can watch {{Template:Viewer/Link|page=Item:OSW90a301a65a534132a8d12bcce71eff41|url=|label=this video tutorial}}. | #If you're still having trouble, you can watch {{Template:Viewer/Link|page=Item:OSW90a301a65a534132a8d12bcce71eff41|url=|label=this video tutorial}}. | ||
===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]] | ||
#Click on that Project's name to find their entity page. | #Click on that Project's name to find their entity page. | ||
Line 30: | Line 30: | ||
#Click the + sign to add a new node. | #Click the + sign to add a new node. | ||
#Type in your name in the search box and click on the right entry from the search suggestions. | #Type in your name in the search box and click on the right entry from the search suggestions. | ||
##Troubleshooting: if you can't find your name, that means you didn't create yourself as a User Entity first. You need to do that before adding yourself to a project. No, you cannot simply type in your name for now. | ##Troubleshooting: if you can't find your name, that means you didn't create yourself as a '''User Entity''' first. You need to do that before adding yourself to a project. No, you cannot simply type in your name for now. | ||
#Click Save. | #Click Save. | ||
#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 (on Windows). | #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 (on Windows). | ||
Line 36: | Line 36: | ||
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]]. | ||
##Does your organization not exist? We can solve that by creating your organization as an Entity in the Battery KB. Firstly, we should know what kind of organization you belong to. We have the following existing categories: | ##Does your organization not exist? We can solve that by creating your organization as an '''Entity''' in the Battery KB. Firstly, we should know what kind of organization you belong to. We have the following existing categories: | ||
###Research Organization: research institutes that are not education-focused [[:Category:OSW789dcd084860478dbc60361a2da7c823]] | ###'''Research Organization''': research institutes that are not education-focused [[:Category:OSW789dcd084860478dbc60361a2da7c823]] | ||
###Educational Organization: universities and such [[:Category:OSW9d63242855e44ab8b26d6ad9792a67b3]] | ###'''Educational Organization''': universities and such [[:Category:OSW9d63242855e44ab8b26d6ad9792a67b3]] | ||
###Corporation: industrial organizations [[:Category:OSW5f4a3751d23e482d80fb0b72dcd6bc31]] | ###'''Corporation''': industrial organizations [[:Category:OSW5f4a3751d23e482d80fb0b72dcd6bc31]] | ||
###Organization: a general category for things that don't fit in the above [[:Category:OSW1969007d5acf40539642877659a02c23]] | ###'''Organization''': a general category for things that don't fit in the above [[:Category:OSW1969007d5acf40539642877659a02c23]] | ||
###Go to the category your organization most fits and click +Create on that page to create a new Entity, just like you did for your User Entity. | ###Go to the category your organization most fits and click +Create on that page to create a new Entity, just like you did for your User Entity. | ||
###Fill in the usual information. Note that acronyms go under the field Short Name(s). But this parameter field doesn't show up by default. | ###Fill in the usual information. Note that acronyms go under the field Short Name(s). But this parameter field doesn't show up by default. | ||
Line 47: | Line 47: | ||
####A new field box named "Short name(s):" is now in the Data-Editor window. | ####A new field box named "Short name(s):" is now in the Data-Editor window. | ||
####Click on the + to create a node and type in the acronym/short name of the organization. | ####Click on the + to create a node and type in the acronym/short name of the organization. | ||
#If your organization already exists, click on that | #If your organization already exists, click on that organization's name to find their entity page. | ||
#At the top, there are two edit buttons: '''Edit data''' and '''Edit'''. | #At the top, there are two edit buttons: '''Edit data''' and '''Edit'''. | ||
#Click on '''Edit data''' and scroll down to find the '''Member''' info box. | #Click on '''Edit data''' and scroll down to find the '''Member''' info box. | ||
#Click the + sign to add a new node. | #Click the '''+''' sign to add a new node. | ||
#Type in your name in the search box and click on the right entry from the search suggestions. You can't just write your name, you need to find your '''User Entity''' to add. | #Type in your name in the search box and click on the right entry from the search suggestions. You can't just write your name, you need to find your '''User Entity''' to add. | ||
#Click Save. | #Click Save. | ||
Line 58: | Line 58: | ||
##'''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''' ''' | You should now have a proper '''User Entity''', which has both a '''Project''' and an '''Organization''' '''Entity''' 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 tedious to assign or difficult to define. | ##<u>Example:</u> 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. | ||
#''Why have an ontological framework?'' | #''Why have an ontological framework?'' | ||
Line 85: | Line 85: | ||
#Click Save in the top right of the Data-editor window. | #Click Save in the top right of the Data-editor window. | ||
#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 Battery KB=== | ===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. | ||
Line 126: | Line 127: | ||
##Article [[:Category:OSW92cc6b1a2e6b4bb7bad470dfdcfdaf26]] | ##Article [[:Category:OSW92cc6b1a2e6b4bb7bad470dfdcfdaf26]] | ||
##Tutorial [[:Category:OSW494f660e6a714a1a9681c517bbb975da]] All tutorials are a subcategory of Article. | ##Tutorial [[:Category:OSW494f660e6a714a1a9681c517bbb975da]] All tutorials are a subcategory of Article. | ||
#Go to the category and click the +Create at the top. | #Go to the category and click the '''+''' Create at the top. | ||
#Here's a tutorial about how to create articles [[Item:OSW52c2c5a6bbc84fcb8eab0fa69857e7dc]] | #Here's a tutorial about how to create articles [[Item:OSW52c2c5a6bbc84fcb8eab0fa69857e7dc]] | ||
==== How to find out where to start contributing ==== | |||
You are now hopefully feeling confident about your abilities to navigate and work on the Battery KB. Where should you get started on working? The following Article Categories will be the main body of information of the Battery KB. | |||
* AbstractKitMaterialCategory [[:Category:OSWd4b4c5bdb4c54bae815f1a11b62288d3]] | |||
** A supercategory containing narrower categories like {{Template:Viewer/Link|page=Category:OSW5a8504ba30405714835ab95b5e6a4293|url=|label=Active Materials, binders, and addtives}}. Each category would then contain an item like NMC532 or graphite. | |||
* Process Parameters overview: [[Item:OSWcb317bb1fee84d81b4b9b3d1d8037719]] | |||
** Variables which influence battery cell fabrication. | |||
* Measurement Techniques overview: [[Item:OSW4d112f9df7044e81b39f327cc07dbc37]] | |||
** Methods to measure either Process Parameters or Key Performance Indicators. | |||
* Key Performance Indicator overview: [[Item:OSW65f139c98efa499b94537f8a15f2be77]] | |||
** Metrics which are used to evaluate the quality of a battery cell. | |||
Each of these contains hundreds of articles that are currently empty and need filling and defining. For example, you can start with picking a measurement technique you know and explaining how it works. Feel free to take information from Wikipedia to get started. | |||
====How to help cultivate a good wiki culture:==== | ====How to help cultivate a good wiki culture:==== | ||
#If you've never edited Wikipedia before or worked on any other kind of wiki, reading the introduction and basic five pillars of this page are extremely helpful to understanding what a successful wiki culture requires: {{Template:Viewer/Link|page=|url=https://en.wikipedia.org/wiki/Wikipedia:A_primer_for_newcomers|label=https://en.wikipedia.org/wiki/Wikipedia:A_primer_for_newcomers}}. In essence, Wikipedia has already developed processes and procedures that solve a lot of common problems and the Battery KB doesn't need to completely reinvent the wheel. The Five Pillars as adapted for Battery KB should be: | #If you've never edited Wikipedia before or worked on any other kind of wiki, reading the introduction and basic five pillars of this page are extremely helpful to understanding what a successful wiki culture requires: {{Template:Viewer/Link|page=|url=https://en.wikipedia.org/wiki/Wikipedia:A_primer_for_newcomers|label=https://en.wikipedia.org/wiki/Wikipedia:A_primer_for_newcomers}}. In essence, Wikipedia has already developed processes and procedures that solve a lot of common problems and the Battery KB doesn't need to completely reinvent the wheel. The Five Pillars as adapted for Battery KB should be: |
Revision as of 17:13, 23 October 2024
How to get started [OSW170b321e13ee4a1cb2005193da045ec1] | |
---|---|
ID | OSW170b321e13ee4a1cb2005193da045ec1 |
UUID | 170b321e-13ee-4a1c-b200-5193da045ec1 |
Label | How to get started |
Machine compatible name | HowToGetStarted |
Ontology equivalents | |
Statements (outgoing) | |
Statements (incoming) | |
|
|
Keywords |
Description
jsondata
type |
| |||||
---|---|---|---|---|---|---|
author |
| |||||
uuid | "170b321e-13ee-4a1c-b200-5193da045ec1" | |||||
label |
| |||||
description |
| |||||
name | "HowToGetStarted" |