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.

TLDR:
  * 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" section goes through sample workflow


====== READ THIS FIRST ======

Here's a few quick rules which are very important to follow.

    * Please follow basic wiki etiquette. Feel free to add new content or work on global pages (companies, topics, etc), but do not make major changes to a page owned by another user (in their personal namespace) without checking with them or an admin. Small typo fixes, etc are of course welcomed anywhere on the wiki.
    * The wiki software seems to have a caching bug related to newly created tags. If you create a page containing a topic listing ("topic>foo") and there are no pages marked with that tag ("tag>foo") yet, the topic listing will stay blank even after pages have been tagged. The workaround is to create at least one tagged page //before//   creating the topic listing.
    * Some devices may be considered sensitive for various reasons, or you may simply not wish to let the public know that you're studying a certain chip until you've finished your analysis. Pages may be placed in the "protected:" namespace and will only be accessible to logged-in users. The "drm:" namespace is for especially sensitive devices, such as those in DRM/security systems, and is only accessible by admins and trusted security researchers.
    * We have some [[:conventions|conventions]] for naming things, please follow these unless you have a good reason not to.


====== Chip pages ======

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".

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://siliconpr0n.org/archive/doku.php?id=mcmaster:st:24c02" and then hit "Create this page"

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.

mcmaster uses [[https://github.com/JohnDMcMaster/pr0ntools/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 ======

TLDR:
  * Small image (< 5 MB): add to wiki pages
    * 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
    * 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

Suggested low resolution image workflow:
  * Put image in a namespace named after the page
  * Ex: for mcmaster:st:24c02
  * 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
  * Hit "upload image"
  * Upload the image, placing it into the mcmaster:st:24c02 namespace
  * Click on it to get markdown for the image
  * Cut and paste that into the original page (mcmaster:st:24c02)

Please upload photos in JPEG format at quality 90 and use PNG for diagrams. When possible, all images should be captured in a lossless form such as TIFF and converted to JPEG for web purposes. Lossless compression reduces artifacts and makes the images more friendly for machine vision, so the original files should be used for analysis when possible.

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.


====== 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).


====== Quick add / mass import ======

In May 2021 a number of official options were added to quickly add pages

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

sipager (file)
  * Upload a conforming file name to the form
  * Template page is created with the image added as a single die photo

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