Differences

This shows you the differences between two versions of the page.

--- your_first_page [2018/03/14 01:32] – [Image files] mcmaster
+++ your_first_page [2025/08/04 21:23] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
 Congratulations on joining the Silicon Archive. If you're looking to start adding wiki pages on your own devices, here's the place to start.
+Need an account? Check out [[new_contribution_request]]
 TLDR:
-  * Copy another page as an example
+  * Get an admin (usually John McMaster) to create you an account
+    * Will need 1) a copyright release 2) how you want to be atrributed
+  * Most users should use [[tool:start|import tools]] to quickly create page templates from images
+    * You may need to request access
+    * Alternatively: copy another page as an example
   * Upload pages and images to your assigned namespace
   * Admins will help setup your landing page and possibly your first page
-  * Image files talks about sample workflow
+  * "Image files" section goes through sample workflow
@@ Line 17: / Line 23: @@
     * We have some [[:conventions|conventions]] for naming things, please follow these unless you have a good reason not to.
-====== User pages ======
-Once you start adding chip pages, you'll want to have a page about yourself, with the same name as your user account. Generally admins will create a template for you. As a minimum this page should contain the following content:
-<code>
-{{tag>collection}}
-All images licensed as $LICENSE_HERE unless otherwise stated.
-{{topic>collection_yourusernamehere}}
-</code>
-It's important to specify what license your images are covered by so people know if/how they can reuse them. We recommend CC0, CC BY, or CC BY-NC, but the choice is is of course up to you. Although you are free to tag single images as being licensed differently it's important to specify a catch-all license to avoid confusion.
-You can, of course, add extra information about yourself if you'd like. Typically this would be a summary of your interests/experience level, what lab facilities you have access to, a link to your personal website, etc.
-====== Vendor pages ======
-If you are adding a chip from a company we don't have in our database yet, great! You'll want to make a new page for the company so people can find it. It should be called "vendor:nameofcompany" and contain the following content:
-<code>
-{{tag>vendor}}
-Brief description of company here
-{{topic>vendor_nameofcompany}}
-</code>
-Additional information which might be useful here is a description of what kind of products the company makes, dates of major events (founded, went out of business, bought/was bought by another company).
 ====== Chip pages ======
-High resolution chip maps must be added manually by mcmaster. Generally, low resolution images (say below 5 MB) should just be added to the pages directly and not map'd.
+Generally just [[mcmaster:nintendo:f411a|copy another page]] or [[template|use this template]]. Create a new page by navigating to a url and hitting "create this page". A page is deleted by deleting all markup and hitting "save".
-Generally just copy another page or [[template|use this template]]
+For example, to create a page for collection "mcmaster", made by ST Microelectronics (abbreviated st by convention), part number 24C02, go to this page: "https://siliconprawn.org/archive/doku.php?id=mcmaster:st:24c02" and then hit "Create this page"
-TOOD: add more detail
+High resolution chip maps must be added manually by mcmaster. Generally, low resolution images (say below 5 MB) should just be added to the pages directly and not map'd. See below for suggested workflow for low resolution images.
-TODO: mcmaster uses a script to template most pr0nmap pages. Add a link to it
+mcmaster uses [[https://github.com/JohnDMcMaster/prawntools/blob/master/stitch/img2doku.sh|this script]] to create a page template based off an image named using the suggested "<vendor>_<id>*.jpg" format
 ====== Image files ======
@@ Line 64: / Line 40: @@
     * You must place these in your namespace, ideally in a page specific namespace (see below for details)
     * Don't worry too much about file name, but you can use high large imaging naming as guidance if you want
-  * Large images: submit to McMaster to mapify
+    * Import [[tool:start|import tools]] can help with mass upload
+  * Large images: they should be added with simapper
+    * See tool page [[tool:start|import tools]]
+    * You may need to request access from an admin (ie McMaster)
     * See [[:conventions|conventions page]] for standard naming of high resolution images
@@ Line 72: / Line 51: @@
   * Edit page mcmaster:st:24c02:s (ie in a separate tab)
     * This can be done by copying and pasting the url, including setting up the edit
-    * Ex: https://siliconpr0n.org/archive/doku.php?id=mcmaster:st:24c02:s&do=edit
+    * Ex: https://siliconprawn.org/archive/doku.php?id=mcmaster:st:24c02:s&do=edit
   * Hit "upload image"
   * Upload the image, placing it into the mcmaster:st:24c02 namespace
@@ Line 82: / Line 61: @@
 Images above say 5 MB (say 16 megapixels) should be downsampled before posting in order to prevent the thumbnailer from running out of memory. High-resolution stitches are welcome but we currently do not have an automated interface for uploading map images, please contact an admin if you have one to contribute.
-===== Non-microscope images =====
-TODO: Come up with naming convention
+====== User pages ======
-===== SEM images =====
+Once you start adding chip pages, you'll want to have a page about yourself, with the same name as your user account. Generally admins will create a template for you. As a minimum this page should contain the following content:
+<code>
+{{tag>collection}}
+All images licensed as $LICENSE_HERE unless otherwise stated.
+{{topic>collection_yourusernamehere}}
+</code>
-azonenberg's new standard is: foo_01_type_20kV_10kx_9mm.jpg
+It's important to specify what license your images are covered by so people know if/how they can reuse them. We recommend CC0, CC BY, or CC BY-NC, but the choice is is of course up to you. Although you are free to tag single images as being licensed differently it's important to specify a catch-all license to avoid confusion.
+You can, of course, add extra information about yourself if you'd like. Typically this would be a summary of your interests/experience level, what lab facilities you have access to, a link to your personal website, etc.
+====== Vendor pages ======
+If you are adding a chip from a company we don't have in our database yet, great! You'll want to make a new page for the company so people can find it. It should be called "vendor:nameofcompany" and contain the following content:
+<code>
+{{tag>vendor}}
+Brief description of company here
+{{topic>vendor_nameofcompany}}
+</code>
+Additional information which might be useful here is a description of what kind of products the company makes, dates of major events (founded, went out of business, bought/was bought by another company).
-"type" may be "se" for secondary electron or "bse" for backscatter.
-Magnification should be abbreviated if a multiple of 1000, otherwise written out in full (ex: 3900x, 4kx).
+====== Quick add / mass import ======
-Working distance and accelerating voltage should also be specified to aid in interpretation of the image. Typically for high-resolution images one will use the lowest probe current and smallest aperture that give a good signal-to-noise ratio, so this information is often omitted from the filename.
+In May 2021 a number of official options were added to quickly add pages
-===== Optical microscope images =====
+simapper
+  * Upload a conforming file name to the form
+  * Template page is created and map is created
+  * It's currently possible to mass import using a table, but this is fragile and might get removed
-Images should be named "chipname_number_type_objective.jpg" where "type" is the image type and "objective" is an abbreviation for the objective used.
+sipager (file)
+  * Upload a conforming file name to the form
+  * Template page is created with the image added as a single die photo
-If you've calibrated your microscope against a standard of some sort, please add an overlay with the objective name and a scale bar to your images. (Contact azonenberg if you'd like the GIMP files for our standard overlay, which you can modify for your setup.)
+sipager (directory)
+  * Currently for admin use only
+  * Template page is created
+  * All images in directory are added to page
+  * Additional information from optional .txt file is added to page
+  * Consider .tar version to allow uploading to form