Battery Knowledge Base

SamsonLai: Difference between revisions

User page Discussion

SamsonLai (view source)

Revision as of 14:32, 7 August 2024

1,836 bytes added ,  7 August
no edit summary
VisualWikitext
No edit summary
No edit summary
Line 16: Line 16:


== Task list ==
== Task list ==
Here is a list of sections and areas I am working on:
Here is a list of areas I am working on:
{| class="wikitable sortable mw-collapsible"
{| class="wikitable sortable mw-collapsible"
|+
|+
!General wiki stuff
!General wiki stuff
!SALAMANDER project
!User guides
!User guides
!Visual improvments
!Visual improvements
!Policy stuff
|-
|-
|Update the Main Page for BatteryKB.
|Update the Main Page for BatteryKB.
|
|Create a manual of style for BatteryKB.
|Create a manual of style for BatteryKB.
|Make the info box narrower, hide the "machine-readable" relevant content inside the wiki text as comments
|Make the info box narrower, hide the "machine-readable" relevant content inside the wiki text as comments
|Ask if I can get admin rights to the wiki or moderator/editor level privileges
|-
|-
|Create a community task list to organize effort and '''comprehensively''' curate specific content.
|Create a community task list to organize effort and '''comprehensively''' curate specific content.
|Make sure everyone at IFE has created their User entities
|How to help (based on https://en.wikipedia.org/wiki/Wikipedia:Contributing_to_Wikipedia)
|How to help (based on https://en.wikipedia.org/wiki/Wikipedia:Contributing_to_Wikipedia)
|Fix the TOC being out of order (Abstract on SALAMANDER page is at the bottom).
|Fix the TOC being out of order (Abstract on SALAMANDER page is at the bottom).
|Change the user name used in logs from the ORCID number to something customized
|-
|-
|Create templates to make content curation more efficient.
|Create templates to make content curation more efficient.
|
|New user guide to editing the Battery wiki
|New user guide to editing the Battery wiki
|
|
|Short name or acronym for Battery Knowledge Base
|-
|-
|Fix why [[ isn't easily finding SALAMANDER project page
|Fix why [[ isn't easily finding SALAMANDER project page
|
|How to edit the json file directly to fix a mistake (need to include a comment on why the change was made and update erforderlich to English)
|How to edit the json file directly to fix a mistake (need to include a comment on why the change was made and update erforderlich to English)
|
|
|How to prevent the creation of duplicate entities
[[Item:OSWf3f7a0feca884b87a5a925278d26a637]] (dupe)
[[Item:OSW02ab1b78340040efaf16d2700b6f3aaf]] (real) (related to admin rights above)
|-
|-
|Ask if I can get admin rights to the wiki or moderator/editor level privileges
|Make sure everyone at IFE has created their User entities
|
|
|
|
|
|Do we have a workspace for policy and howto articles? Something that exists outside of the Main namespace
|-
|-
|Change the user name used in logs from the ORCID number to something customized
|What's the difference between add Organization to User Entity and adding User Entity to Member person(s) to an Organization
|
|
|
|
|
|
|-
|-
|How to prevent the creation of duplicate entities
|
[[Item:OSWf3f7a0feca884b87a5a925278d26a637]] (dupe)
[[Item:OSW02ab1b78340040efaf16d2700b6f3aaf]] (real)
|
|
|
|
Line 67: Line 67:
|}
|}


== How-to ==
== Guide for new users: ==
If you're new to the Battery Knowledge Base, get started by doing the following how-to guides. They'll both help you get set up and teach you a bit about how the Battery Knowledge Base works.


===== How to change your user page from your ORCID: =====
=== How to get started ===


==== How to change your user page from your ORCID: ====
# Click on the three dots on    the right-hand side of the page.
# Click on the three dots on    the right-hand side of the page.
# Click on Move Page.
# Click on Move Page.
Line 102: Line 104:
# Next steps: notice anything that you couldn't add to your User entity parameters because the objects didn't already exist? Go to those Categories and start creating those entities. For example, you can check for whether the BatteryKB already has your institution as an Organization entity here:[[:Category:OSW1969007d5acf40539642877659a02c23]]
# Next steps: notice anything that you couldn't add to your User entity parameters because the objects didn't already exist? Go to those Categories and start creating those entities. For example, you can check for whether the BatteryKB already has your institution as an Organization entity here:[[:Category:OSW1969007d5acf40539642877659a02c23]]
# Next steps: improve the quality of your User entity. Here is an example a good quality User entity: [[Item:OSW72e733f317ef4cf9b8ca53e906c9acb9|Simon Clark]].
# Next steps: improve the quality of your User entity. Here is an example a good quality User entity: [[Item:OSW72e733f317ef4cf9b8ca53e906c9acb9|Simon Clark]].
# Troubleshooting: Member vs. Member Of?
 
## '''Member''': if you want to associate yourself or your institutional affiliation with a Project, note that you go to the Project and Edit data there, '''not''' Edit data on your entity.
==== 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 workgroups or research groups like Battery 2030+). But this is done differently from a Project.
# Find your organization. You can use search or this Category: [[:Category:OSW1969007d5acf40539642877659a02c23]]
# Click on that Project's name to find their entity page.
# 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 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.
# Click Save.
# Finished!
# Troubleshooting: Should you use Member vs. Member Of? What's the difference?
## '''Member person(s)''': if you want to associate yourself or your institutional affiliation with a Project, note that you go to the Project and Edit data there, '''not''' Edit data on your entity. [Actually, does it matter?]
## '''Member Of''': if you want to associate yourself to your institutional affiliation, you edit your entity page. If your organization belongs to a larger organizational unit, then you edit your organization's entity page. 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).
## '''Member Of''': if you want to associate yourself to your institutional affiliation, you edit your entity page. If your organization belongs to a larger organizational unit, then you edit your organization's entity page. 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).
## In summary, Projects add members to ''their'' data, but Users add affiliation to ''their'' data.
## In summary, Projects add members to ''their'' data, but Users add affiliation to ''their'' data.
## Ontologically speaking, it shouldn't matter and the properties should go both ways.


==== How to add a new entity on the fly: ====
==== How to add a new entity on the fly: ====
Line 125: Line 139:
# Click Save in the top right of the Data-editor window.
# Click Save in the top right of the Data-editor window.
# Finished!  
# Finished!  
==== How to be a good user: ====
# 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 BatteryKB doesn't need to reinvent the wheel (at least,    completely).
# One of the best aspects about wikis in general is that you can learn nearly everything by simply copying what you see in a good page. However, this is more difficult in the BatteryKB due to how its ontological structuring.
# If you have worked on Wikipedia or another wiki, you will find that the BatteryKB operates differently. This is because the BatteryKB is built fundamentally on an ontological infrastructure. This means essentially that '''everything''' is classified as a categorical object 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 object 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.
## Conversely, in the BatteryKB, to make a page or rather "entity/object" which represents me, I go the the pre-existing Category called "Users" and create a new User. This User object has pre-defined parameters, such as name, role, location, and relevant relationships to other objects (e.g., Institutional Affiliation). In this way, the parameters are consistently used by all objects (no issues of "Person" vs. "Persons" vs. "person", etc.) and thus, these parameters are usable and readable by machines. This also prevents orphan articles.
## This approach also applies to any other new entry: first find the category that object would belong to, then create it under that category 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.
=== How to contribute to the wiki ===
OK, now you should be set up with the basics of a user profile and understand the basic mechanics of how the BatteryKB 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.


==== How to make a link: ====
==== How to make a link: ====
Line 136: Line 165:
# ''External'' links can also be    included by using the button on the visual editor, or Ctrl+K. Enter the full      URL in the text box that shows up.   
# ''External'' links can also be    included by using the button on the visual editor, or Ctrl+K. Enter the full      URL in the text box that shows up.   


==== How to help: ====
==== How to start a new article ====


# 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}}.
==== How to add an image ====
# In essence, Wikipedia has    already developed processes and procedures that solve a lot of common    problems and the BatteryKB doesn't need to reinvent the wheel (at least,    completely).
 
# One of the best aspects about wikis in general is that you can learn nearly everything by simply copying what you see in a good page. However, this is more difficult in the BatteryKB due to how its ontological structuring.
==== How to add a table ====
# If you have worked on Wikipedia or another wiki, you will find that the BatteryKB operates differently. This is because the BatteryKB is built fundamentally on an ontological infrastructure. This means essentially that '''everything''' is classified as a categorical object 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 object 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.
## Conversely, in the BatteryKB, to make a page or rather "entity/object" which represents me, I go the the pre-existing Category called "Users" and create a new User. This User object has pre-defined parameters, such as name, role, location, and relevant relationships to other objects (e.g., Institutional Affiliation). In this way, the parameters are consistently used by all objects (no issues of "Person" vs. "Persons" vs. "person", etc.) and thus, these parameters are usable and readable by machines. This also prevents orphan articles.
## This approach also applies to any other new entry: first find the category that object would belong to, then create it under that category 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.
Retrieved from "https://battery.knowledge-graph.eu/wiki/Special:MobileDiff/2888"