SamsonLai: Difference between revisions

User:SamsonLai
No edit summary
No edit summary
Line 158: Line 158:
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. This makes it very easy for a reader to learn more about an unfamiliar term. This is called a '''wiki''' link.
## Type the text you want to link.
## Type the text you want to link.
## 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.
Line 165: 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 start a new article ====
==== How to add an image ====
First, before you attempt to add an image, you have to again understand that '''everything''' in this wiki exists on an ontological framework. Just as you can't type in a person's name into a parameter field as text without making them first a User entity, you can't simply upload an image to an article or entity as it is. The ''image'' has to exist as an '''entity''', too. But, as you also learned above, you can create this entity on the fly.


==== How to add an image ====
# At the top of the bar, click Insert Images and media.
# Under Media elements, click the + button to add a parameter field.
# Click the blue button to "Create a new element in a separate dialog". This will allow you to upload the image as an ''entity'', save it and then come back to your original image insertion to ''link'' it to the article.
# At the top of the new dialog box Data-Editor, it should say Wiki File.
## Add in filename


==== How to add a table ====
==== How to add a table ====
==== How to start a new article ====

Revision as of 14:39, 7 August 2024

Hello, you've found the user page for Samson Y. Lai (aka ORCID user 0000-0002-8227-3250).

I am the Group Leader for Materials Development at the Institute for Energy Technology (IFE) in Norway. I am also coordinator of the SALAMANDER Horizon Europe Project, a part of the Battery 2030+ CSA. The SALAMANDER project has its own project page on the Battery Knowledge Base.

My technical expertise is/was in silicon anodes and characterization methods. Nowadays, I mostly do project management, supervision, and mentoring.

Some of my collaborators below are also here on the wiki:

  • Dr. Inger-Emma Nylund Inger-Emma Nylund
  • Dr. Nienke Visser
  • Dr. David Wragg
  • Theresa Nguyen
  • Tommy Nordby

Pleased to meet you and feel free to contact me on LinkedIn if you have any questions.

Task list

Here is a list of areas I am working on:

General wiki stuff User guides Visual improvements Policy stuff
Update the Main Page 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 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. 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). Change the user name used in logs from the ORCID number to something customized
Create templates to make content curation more efficient. 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 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) University of Oslo (real) (related to admin rights above)

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
What's the difference between add Organization to User Entity and adding User Entity to Member person(s) to an Organization

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 get started

How to change your user page from your ORCID:

  1. Click on the three dots on the right-hand side of the page.
  2. Click on Move Page.
  3. Enter the desired name of your user name.
  4. Click Move page.
  5. Finished!
  6. Note: the old page will still exist, but will simply redirect to the new page.
  7. 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.
  8. Note: if you edit the user page, you will get a warning about editing a page for an account that doesn't exist.
  9. Note: unfortunately, this doesn't fix the user name used in the recent changes and contributions log.

How to make yourself a User entity in the Battery KB (not the same as above):

  1. Go to this page: User
  2. At the top, click + Create.
  3. Fill in the parameters where relevant and required.
  4. 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.

How to add your User entity to a project:

  1. Find your project. You can use search or this Category: Project
  2. Click on that Project's name to find their entity page.
  3. At the top, there are two edit buttons: Edit data and Edit.
    1. 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.
    2. Edit: this allows you to modify the information displayed on the project's entity page.
  4. Click on Edit data and scroll down to find the Member info box.
  5. Click the + sign to add a new node.
  6. Type in your name in the search box and click on the right entry from the search suggestions.
    1. 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 (you will learn how to do this later).
  7. Click Save.
  8. 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.
  9. 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:Organization
  10. Next steps: improve the quality of your User entity. Here is an example a good quality User entity: Simon Clark.

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.

  1. Find your organization. You can use search or this Category: Organization
  2. Click on that Project's name to find their entity page.
  3. At the top, there are two edit buttons: Edit data and Edit.
  4. Click on Edit data and scroll down to find the Member info box.
  5. Click the + sign to add a new node.
  6. Type in your name in the search box and click on the right entry from the search suggestions.
  7. Click Save.
  8. Finished!
  9. Troubleshooting: Should you use Member vs. Member Of? What's the difference?
    1. 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?]
    2. 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).
    3. In summary, Projects add members to their data, but Users add affiliation to their data.
    4. Ontologically speaking, it shouldn't matter and the properties should go both ways.

How to add a new entity on the fly:

So you've created an entity or two under the pre-existing Categories. Great. But maybe you had some trouble putting in entities that don't exist yet because this wiki is in its early stages of creation. Let's say you want to add your organization and you found it doesn't exist in Organization yet.

  1. First go to the Category and click + Create at the top.
  2. 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.
    1. Click at the top with "three bars select properties"
    2. Find the "Short name(s)" field and click the checkbox. Click outside of the small menu to close it.
    3. A new field box named "Short name(s):" is now in the Data-Editor window.
    4. Click on the + to create an entry in this parameter and type in the acronym/short name of the organization.
  3. Let's say you want to type in the country of your organization in the Country field, but the country doesn't exist as an entity in BatteryKB yet.
    1. The system won't let you type a country name that isn't an existing country entity. Remember: nothing exists outside of the ontological framework.
    2. But now that you know how to create an entity, you could go the Category for the Country and click + Create on it. However, there's a faster method.
    3. Next to the field, click on the blue icon with two interlocked squares and a + icon in one of the squares.
    4. This will automatically take you a new Data-Editor pop-up box as if you hit + Create for that Category. You can now type in the name of the country in the Text parameter field. Tip: If you're ever confused about which Data-Editor box you're in, just look at the top of the box.
    5. Click Save at the top right, which will create the new Entity and bring you back to the first Data-Editor pop-up box.
    6. Now type in the Country field the name of the Country Entity you just created. It may take a moment to show up. Try typing slowly.
  4. Click Save in the top right of the Data-editor window.
  5. Finished!

How to be a good user:

  1. 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: https://en.wikipedia.org/wiki/Wikipedia:A_primer_for_newcomers.
  2. 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).
  3. 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.
  4. 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.
  5. 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.
    1. 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 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.
    2. 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.
    3. 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.
    4. 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:

There's two types of links. wiki links and external links.

  1. A good wiki links relevant terms to their respective pages elsewhere in the wiki. This makes it very easy for a reader to learn more about an unfamiliar term. This is called a wiki link.
    1. Type the text you want to link.
    2. Highlight that text and click the Link button at the top in visual editor to open a dialog box. Search for the linked page.
    3. Click save on the dialog box, then Save Changes on the page to finalize the link.
    4. You can also do this by typing [[ and then using the pop-up dialog box. (This method doesn't seem to work at present.)
  2. 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 add an image

First, before you attempt to add an image, you have to again understand that everything in this wiki exists on an ontological framework. Just as you can't type in a person's name into a parameter field as text without making them first a User entity, you can't simply upload an image to an article or entity as it is. The image has to exist as an entity, too. But, as you also learned above, you can create this entity on the fly.

  1. At the top of the bar, click Insert Images and media.
  2. Under Media elements, click the + button to add a parameter field.
  3. Click the blue button to "Create a new element in a separate dialog". This will allow you to upload the image as an entity, save it and then come back to your original image insertion to link it to the article.
  4. At the top of the new dialog box Data-Editor, it should say Wiki File.
    1. Add in filename

How to add a table

How to start a new article

Cookies help us deliver our services. By using our services, you agree to our use of cookies.