SAW by Softorage

Primary:
1. Input
  - type: text
  - Notes: also decides the filename and the URL for the software
2. Description
  
  title is basically the name of software. It also decides the filename and the URL for the software under consideration. It should however be noted that title is not just a name of the software, hence is case-sensetive. title must appear the exact same way as it appears on the premises of software whether online or offline. For example, darktable is a Photo post-Production software. On its official website, darktable is written as darktable, hence its title is darktable and not Darktable or DarkTable or else. In case where title of a software appears in different ways on its own official premises, then that of it shall form title which is more frequent. For example, a software’s title on the homepage of its official website and as it appears on the title of the same page(as the title of that tab or window of browser) differs. If no specific form is more frequent, then a choice needs to be made, which shall usually favour gramatically correct way. Also, in case the software is usually marketed along with the name of organisation behind it, then such name shall form title (See example 3, 4). If a software name is likely to create confusion with other names, or software name makes more sense when accompanied with a relevant general name, such general name shall be written in brackets (see example 5, 6).
3. Example
  1. darktable
  2. SciPy
  3. Apache Mahout
  4. Eclipse Deeplearning4j
  5. Brave (Web Browser)
  6. Massive Online Analysis (MOA)
Source: N/A

Primary:
1. Input
  - type: URL
  - Notes: none
2. Description
  
  Images are stored on a different repo named ‘images’, with proper suggested names; under /software-logo directory. Extension of the image shall be input without ‘dot’ in the given field. Eg, ‘png’ and not ‘.png’. Also, note that ‘png’ and PNG’ is treated differently, as consideration is given to case-sensetivity.
  
  In case, due to some circumstances it is not possibe to store image in ‘images’ repo, radio button shall be toggled for custom link insertion, and following instructions be followed.
  
  image means the logo of software. It should be noted that input-type of input-field for image is URL. Most important part that should not be overlooked at any costs is the license with which the image to be hotlinked (is distributed or) exists at its place. Usually if Wikipedia has image for a certain software (let’s take Blender for example) on software’s Wikipedia page(for example this), then that image is stored by Wikimedia Foundation. By opening in new tab the image itself, we land on the image’s page on Wikipedia(for example this). On image’s page on Wikipedia, the license with which the image is made available to/by Wikimedia Foundation can be checked. Before proceeding further, it should be ensured that image is not being used by Wikipedia under Fair Use Clause(Non-free media) (see OpenCog’s image page on Wikipedia for example). If it is being used under Fair Use Clause, then image’s link should not be treated as input-value and checkbox for image be unticked.
  
  On the image’s page on Wikipedia(for example this), link to image’s actual URL can be found(look for Original file). Wikimedia allows hotlinking of its images to be used on a website. If the license of image is specified and is found to allow sharing of image freely or if the image is available in the public domain, then link of that image shall be input-value for the input-field of image. In case a no-text and with-text version is available for software logo, preference shal be given to no-text version(for example with-text and no-text). Although, it is preferable to use URL of the original file(SVG format prefered) as input-value, in some cases where original file is of a significant memory size, say more than 50KB, it is better to use the Wikipedia’s custom resolution version. While deciding which resolution to use, please consider the fact that height of image on softpage is 5rem(80px). And hey, only logos and not HD wallpapers! (lol, couldn’t resist)
Source: N/A

#	Name	Platform	URL
1		x32 x64 Official

Primary:
1. Input
  - type:
    1. Name: text
    2. URL: URL
  - Notes: none
2. Description
  
  It is usually found that software’s official website provides instructions or links to get the software up and running on the system for all the platforms for which the software is available. In such case, URL of such download page be matched with input-Name-option : Authentic. URL matched with input-Name-option : Authentic, is shown in separate colour than other URLs on the softpage. Sometimes a software is also released on say ‘Github Releases’, ‘GitLab Releases’, etc by the developer her/him/itself. In such cases, where the developer her/him/itself has released the software on different place(s) than official website, | Authentic (<space><bar><space>Authentic) shall be included in the input-value for ‘Name’ at the end of name of the website. In case there is no one specific page (from official website) where software for all officially supported packages can be found, then multiple records shall be created, with names of platform (if they are available platformwise) or in such way as seems logical in case. In case official website provides multiple pages for its different packages of same software (say each for different platforms), then name shall be suffixed by | Authentic (<space><bar><space>Authentic), followed by a logical name(here, platform name).
  
  Rule of thumb: only in case and in all cases, where URL is of official website for the software, word Authentic be used.
  
  Even in case Authentic page covers instructions or provides links to software for all supported platforms, other websites providing download services or such may be included.
  
  It may be noted that no source is required.
3. Example Here is an extract from winrar.md
```
get_it:
  - from: "Authentic"
    url: "https://www.win-rar.com/download.html?L=0"
  - from: "FileHippo x32 (Windows)"
    url: "https://filehippo.com/download_winrar_32/"
  - from: "FileHippo x64 (Windows)"
    url: "https://filehippo.com/download_winrar_64/"
  - from: "TechSpot (All)" # since it has download links for all platforms
    url: "https://www.techspot.com/downloads/67-winrar.html"
  - from: "CNET x64 (Windows)"
    url: "https://download.cnet.com/WinRAR-64-bit/3000-2250_4-10965579.html"
  - from: "FileHorse x64 (Windows)"
    url: "https://www.filehorse.com/download-winrar-64/"
  - from: "Uptodown x64 (Windows)"
    url: "https://winrar.en.uptodown.com/windows"
  - from: "Softonic x32 (Windows)"
    url: "https://winrar.en.softonic.com/download"
  - from: "Softonic x64 (Windows)"
    url: "https://winrar-64bit.en.softonic.com/download"
  - from: "Google Play Store (Android)"
    url: "https://play.google.com/store/apps/details?id=com.rarlab.rar&hl=en_IN"
  - from: "Uptodown (Android)"
    url: "https://rar-for-android.en.uptodown.com/android"
```
Platform:
1. Input
  - type:
    1. Name: text
    2. Architecture: checkbox (x32/x64)
    3. Type: checkbox (Official/Unofficial)
    4. {+}: button
  - Notes: none
2. Description
  
  In input-field : ‘Name’, name of platform shall be included. It takes following values: 1.Windows 2.Linux 3.macOS 4.Android 5.iOS 6.Any other
  
  Note: Leave the ‘Name’ field empty for a platform pair and such pair shall not be counted in output. Very necessary for ‘Authentic’ link, and links with | Authentic.
  
  For ‘architecture’, appropriate checkbox shall be checked. It usually relevant only in cases of desktop platforms, like Windows, Linux, etc. Hence, in case of mobile platforms, it is allowed if no checkbox if checked.
  
  Sometimes, community releases a spin-off version of a certain software. Such a community version is usually termed as an unofficial version of software. Hence for ’type’, checkbox for ‘official’ shall be unchecked only if there is available for download, a/the community version or such unofficial version of software, on the website (input-field ‘Name’ in Primary above).
  
  If portable version is available, tick the checkbox for portable.
  
  The {+} button: after pressing the button, another pair of input fields is added for platform. Do note that there is no button to remove an added pair of input fields, so be careful. In any case, if, by mistake, there have been added multiple pairs which are not needed, then leave the ‘Name’ field empty for that platform pair and such pair shall not be counted in output. For a website, platform field is included if it has only one platform pair with non-empty ‘Name’ field or if there are multiple platform pairs. So, note that if a website doesn’t need the platform field at all, {+} button must not be clicked. Very necessary for ‘Authentic’ link.
3. Example Say the website is CNET, and it has different links for x32 and x64 versions, and it has only Windows version for download. Then it shall follow nomenclature as:
  - Name: CNET
    
    Platform:
    - for x32: ‘Name’: Windows, ‘Architecture’: x32 (checked), ‘Type’: Official
    URL: https://…….
  - Name: CNET
    
    Platform:
    - for x64: ‘Name’: Windows, ‘Architecture’: x64 (checked), ‘Type’: Official
    URL: https://…….
  Say CNET (in our example) has same link for both x32 and x64 versions, i.e., it has links for download of both x32 and x64 versions on same page, then it shall follow nomenclature as:
  - Name: CNET
    
    Platform:
    - for both x32 and x64: ‘Name’: Windows, ‘Architecture’: x32 (checked) / x64 (checked), ‘Type’: Official
    URL: https://…….
  For no information as to architecture:
  - Platform:
    - ‘Name’: Windows, ‘Architecture’: (both unchecked), ‘Type’: Official
Source: N/A

#	Name	Value
1

Primary:
1. Input
  - type: text
  - Notes: Markdown supported
2. Description
  1. overview is an overview of how and what the software does. It need not be extremely detailed and should not be lengthy, though shall be informative. Also, only absolutely necessary adjectives shall be used, and their use must not make overview appear as a marketing message.
  2. When name of a software is mentioned in overview, it shall be hyperlinked in markdown syntax as follows:
    
    [software name](/software/software-perma/)
    where software-perma => software name with all spaces replaced with hyphens (-), remove all round brackets and change all letters to small case.
    
    [category name](/categories/category-perma)
    where category-perma => category name with all spaces replaced with hyphens (-), remove all round brackets and change all letters to small case.
    
    Note: In case there appears name of a software that is not yet available in Softorage, hyperlink the name as per above format and add it to priority software to be added.
  3. In case you have copied content from a website, please quote the content and provide the source. To quote, insert > at start of each line, and > \- [Source](URL) after the last line. See source file of ELKI (source-file) or Eclipse Deeplearning4j (source-file) for example.
    
    Note: In case you have quoted other source, do not hyperlink name or category of a software present in quoted text. You may/should include hyperlinks in quoted text as they exist in text from original source. Please make efforts to ensure that quoted text conforms to text from its original source. Also, it is suggested to include names of software present in quoted text, in next sentence on another line. See overview of SciPy for example.
  4. At the end of overview, tags shall be provided as given here-under. source shall not contain any source for these tags; tags shall not accompany source. Tags are separated by I(capital i) and must not be separated by a pipe(|) or l(small L) or anything else. It is because pipe is used to create table in markdown and also ensures uniformity. (Although, only overview and note are markdown enabled, and you don’t need to worry about using pipe in other characteristics, it is recommended that you use I(capital i) as a separator). Tags shall be hyperlinked using markdown syntax [tag](https://hyperlink). A few examples of tags are given below.
    
    Blog I News I Forum I Wiki I Documentation I Mailing lists I FAQ I IRC I etc
    
    Tags shall not be named exactly as in examples. They shall be named as qualifies for the given situation. For example, say a software project has two FAQs, user and developer. Then the tags shall be User FAQ and Developer FAQ. Also in case you want to use a separator in tag name, you should use I(capital i) and must not use pipe(|), as it breaks anchor tag. Pipe(|) should be used only when a table is to be formed. Refer Markdown Guide for more info.
Source:
1. Input
  - type: text
  - Notes: any number of words supported, comma separates input-value into distinct entities forming an array of strings
2. Description
  
  For each of statements in overview, which are specific in nature, there shall be provided acceptable source. It should be noted that there shall not be provided source for tags specified at the end of overview, like for from where the info about tags is collected. Also, if using Wikipedia as source, it should be ensured that permanent link(can be found under ‘Tools’ on the Wikipedia page’s sidebar) is used.
3. Example:
  1. src1, src2 => 2 members of one array

#	Name	URL
1

#	Minimum	Recommended	Optimal
1

#	Name	Rating	Opinion type	Source
1		/	Based on users' opinion Based on a professional's opinion

Primary:
1. Input
  - type:
    1. Name: text
    2. Rating: number
    3. Opinion type: radio button and number
    4. Remarks: text
  - Notes: none
2. Description
  
  Name is the name of reviewer in exactly the way reviewer wants it to be in. These names are usually their trademarks hence need to be spelled in exactly the same manner in which the reviewer wants others to with due regards to capital and lower case letters. It is safest to choose from list that occurs when clicked on text area.
  
  Rating is the rating given by reviewer to software concerned and is in form rating-given/out-of. Eg, 4/5.
  
  If rating by reviewer is calculated based on number of users’ reviews, then upper radio button is selected and number of users that have given rating is input-value in given area.
  
  Remarks is the short info, usually 1 to 2 words, that would convey information to reader to enable him to understand the relevance of given rating. In some cases it might be that a software has a free version and a premium version, and may as well have different ratings for such different versions. In such case input-value for Remarks would be Free Version or it may be left blank for rating corresponding to free version and Premium Version for rating corresponding to premium version [See example 1]. In some cases it might be that a reviewer only reviews x64 bit Windows version, in which case input-value for Remarks would be x64 bit Windows [See example 2]. separate x32, portable, windows, etc by a hyphen
  
  For sites with portable version only (say both 32/64) Portable x32/64 For sites with portable version as well as Unportable version Un/Portable x32/64
3. Example
  1. Here is an extract from winrar.md:
```
  rating:
    - name: "FileHippo"
      rate: [8, 10]
      num: 722
      remarks: "x32 bit Windows"
    - name: "TechSpot"
      rate: [4.5, 5]
      num: 87
    - name: "Softonic"
      rate: [8, 10]
      num: 25710
      remarks: "x32 bit Windows"
    - name: "Softonic"
      rate: [8, 10]
      num: 3223
      remarks: "x64 bit Windows"
    - name: "CNET"
      rate: [4.5, 5]
      num: 192
      remarks: "x64 bit Windows"
    - name: "CNET"
      rate: [4, 5]
      remarks: "x64 bit Windows"
    - name: "Uptodown"
      rate: [4, 5]
      num: 30
      remarks: "x64 bit Windows"
    - name: "FileHorse"
      rate: [7.1, 10]
      num: 521
      remarks: "x64 bit Windows"
    - name: "Softpedia"
      rate: [4.5, 5]
      num: 2406
    - name: "Uptodown"
      rate: [4.9, 5]
      num: 23
      remarks: "Android"
    - name: "Google Play"
      rate: [4.4, 5]
      num: 726788
      remarks: "Android"
```
  1. Here is an extract from ccleaner.md:
```
  rating:
    - name: "TechRadar"
      type: "expert"
      url: "https://www.techradar.com/in/reviews/piriform-ccleaner-professional"
      remarks: "Professional Version"
```
Source:
1. Input
  - type: text/URL
  - Notes: any number of words supported, comma does not separate input-value into distinct entities forming an array of strings
2. Description
  
  It is the source usually URL from where the rating has been obtained. If source is not available for a rating, then text area given for source should be left blank and checkbox next to it shall be unticked.