SamsonLai: Difference between revisions

From Battery Knowledge Base
no edit summary
No edit summary
No edit summary
Line 29: Line 29:
* Create templates to make content curation more efficient.
* Create templates to make content curation more efficient.
* 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
* Fix the TOC being out of order (Abstract on SALAMANDER page is at the bottom).
* Fix why [[ isn't easily finding SALAMANDER project page
* Fix why [[ isn't easily finding SALAMANDER project page


Line 43: Line 44:
# Note: if you make a mistake,    you can undo the move. Either move the page back or go the history of the    page and click Revert.  
# Note: if you make a mistake,    you can undo the move. Either move the page back or go the history of the    page and click Revert.  
# Note: if you edit the user page, you will get a warning about editing a page for an account that doesn't exist.
# Note: if you edit the user page, you will get a warning about editing a page for an account that doesn't exist.
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): ====
# 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.
# Enter the desired name of    your user name.
# Save your entity and starting using it! 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.
# Click Move page.
 
# Finished!
==== How to add your User entity to a project: ====
# Note: the old page will still    exist, but will simply redirect to the new page.
 
# Note: if you make a mistake,    you can undo the move. Either move the page back or go the history of the     page and click Revert.
# Find your project. You can use search or this Category: [[:Category:OSWb2d7e6a2eff94c82b7f1f2699d5b0ee3]]
# Note: if you edit the user page, you will get a warning about editing a page for an account that doesn't exist.
# Click on that Project's name to find their entity page.
# At the top, there are two edit buttons: '''Edit data''' and '''Edit'''.
## '''Edit data''': this allows you to modify the parameters of the project entity. Essentially, it allows you to update the project's relationship to other objects, such as you being a member of the project.
## '''Edit''': this allows you to modify the information displayed on the project's entity page.
# 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.  
## 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.
# 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.
# 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]].


==== How to make a link: ====
==== How to make a link: ====
There's two types of links.     '''Wiki''' links and ''external'' links.
There's two types of links. '''wiki''' links and ''external'' links.


# A good '''wiki''' links relevant    terms to their respective pages elsewhere in the wiki.
# A good '''wiki''' links relevant    terms to their respective pages elsewhere in the wiki.
Line 61: Line 74:
## Highlight that text and click the Link button at the top in visual editor to open a dialog box. Search for the linked page.
## Highlight that text and click the Link button at the top in visual editor to open a dialog box. Search for the linked page.
## Click save on the dialog box, then Save Changes on the page to finalize the link.
## Click save on the dialog box, then Save Changes on the page to finalize the link.
## [This method doesn't seem to work at present.] You can do this by    typing [[ and then using the pop-up dialog box.  
## You can also do this by    typing [[ and then using the pop-up dialog box. (This method doesn't seem to work at present.)
# ''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.   


Line 68: Line 81:
# 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: <nowiki>https://en.wikipedia.org/wiki/Wikipedia:A_primer_for_newcomers</nowiki>.  
# 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: <nowiki>https://en.wikipedia.org/wiki/Wikipedia:A_primer_for_newcomers</nowiki>.  
# 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).
# 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.
Cookies help us deliver our services. By using our services, you agree to our use of cookies.