Difference between revisions of "Form:Entry"

From Free Software Directory
Jump to: navigation, search
({{#info:[https://www.fsf.org/campaigns/priority-projects/ High Priority Free Software Projects by the Free Software Foundation]}})
m (+documentation)
(42 intermediate revisions by 9 users not shown)
Line 20: Line 20:
 
{{{for template|Entry|strict}}}
 
{{{for template|Entry|strict}}}
 
<div style="width:500">
 
<div style="width:500">
−
'''Name <span style="color:#00b">(required)</span>:''' {{#info:Choosing the name for which the program is most commonly known is preferred. This can be different and/or longer than the page name if necessary. }} {{{field|Name|mandatory}}}
+
{| class="formtable"
  
−
'''Short description <span style="color:#00b">(required)</span>:''' {{#info:Should begin with a capital but not end with a period. Try to stay under 12 words.}} {{{field|Short description|mandatory}}}
+
! Name <span style="color:#00b">(required)</span>: {{#info:Official title of the software. Choosing the name for which the program is most commonly known is preferred. This can be different and/or longer than the page name if necessary. }}  
 +
| {{{field|Name|mandatory}}}
 +
|-
  
−
'''Full description <span style="color:#00b">(required)</span>:''' {{#info:Please write a short summary of what the package does or is used for. [https://en.wikipedia.org/wiki/Help:Wiki_markup Wiki markup] can be used. It shouldn't include licensing information or supported operating systems – categories will do that instead. We recommend writing your own original description. Also, remember that some there are a number of [http://www.gnu.org/philosophy/words-to-avoid.html expressions that we recommend avoiding].}} {{{field|Full description|mandatory}}}
+
! Short description <span style="color:#00b">(required)</span>: {{#info:Short description (~12 words) visible under the title of the software and in other parts of the FSD. Should begin with a capital but not end with a period.}}
 +
| {{{field|Short description|mandatory}}}
 +
|-
  
−
'''Homepage URL <span style="color:#00b">(required)</span>:''' {{{field|Homepage URL|mandatory|size=60}}}
+
! Full description <span style="color:#00b">(required)</span>: {{#info:Please write a short summary of what the package does or is used for. [https://en.wikipedia.org/wiki/Help:Wiki_markup Wiki markup] can be used. It shouldn't include licensing information or supported operating systems – categories will do that instead. We recommend writing your own original description. Also, remember that some there are a number of [http://www.gnu.org/philosophy/words-to-avoid.html expressions that we recommend avoiding].}}
 +
| {{{field|Full description|mandatory}}}
 +
|-
  
−
'''User level:''' {{{field|User level|input type=radiobutton}}}
+
! Screenshot 1: {{#info:Desktop screenshots. <b>File upload is available only to privileged users</b>: ask an admin to upload a screenshot for you after the submission.}}
 +
| {{{field|Screenshot 1|input type=text|uploadable|property=Screenshot 1|size=60}}}
 +
|-
  
−
'''Is High Priority Project:''' {{#info:[https://www.fsf.org/campaigns/priority-projects/ High Priority Free Software Projects by the Free Software Foundation]}} {{{field|Is High Priority Project|input type=checkbox}}}
+
! Screenshot 2:
 +
| {{{field|Screenshot 2|input type=text|uploadable|property=Screenshot 2|size=60}}}
 +
|-
  
−
'''This is an extension, add-on, or plugin to:''' {{{field|Extension of|input type=text with autocomplete}}}
+
! Screenshot 3:
 +
| {{{field|Screenshot 3|input type=text|uploadable|property=Screenshot 3|size=60}}}
 +
|-
  
−
'''This is an inbuilt extension, add-on, or plugin to:''' {{{field|Inbuilt extension of|input type=text with autocomplete}}}
+
! Homepage URL <span style="color:#00b">(required)</span>: {{#info:Direct URL of the page representing the free software submitted (HTTPS is better). Redirects with ads, paywalls and direct downloads are strictly forbidden. Visible in its entirety under the title of the software.}}
 +
| {{{field|Homepage URL|mandatory|size=60}}}
 +
|-
  
−
'''Component programs:''' {{{field|Component programs|input type=text with autocomplete}}}
+
! Is High Priority Project: {{#info:Please read '[https://www.fsf.org/campaigns/priority-projects/ High Priority Free Software Projects by the Free Software Foundation]'.<br/><b>Ignore if not sure</b>.}}
 +
|{{{field|Is High Priority Project|input type=checkbox}}}
 +
|-
  
−
'''VCS checkout command:''' {{#info:The command should include <code>git clone</code>, <code>svn co</code> or anything relevant to the VCS used; if several repositories are used, separate the commands with ; (semicolon).}} {{{field|VCS checkout command}}}
+
! VCS clone command: {{#info:Command to download the source code of the whole free software. It should include <code>git clone</code>, <code>svn co</code> or anything relevant to the VCS used; if several repositories are used, separate the commands with ; (semicolon).}}  
 +
|{{{field|VCS checkout command}}}
 +
|-
  
−
'''Computer languages:''' {{{field|Computer languages}}}
+
! Dev languages: {{#info:Comma and space separated list. Lists all the programming and scripting languages that make up the source code of the free software. Do not include markup languages (MarkDown, HTML, ...) and styling languages (like CSS).}}
 +
|{{{field|Computer languages}}}
 +
|-
  
−
'''Documentation note:''' {{#info:[https://en.wikipedia.org/wiki/Help:Wiki_markup Wiki markup] can be used.}} {{{field|Documentation note}}}
+
! Documentation note: {{#info:Suggestions and useful resources for the end-user. [https://en.wikipedia.org/wiki/Help:Wiki_markup Wiki markup] can be used. Always optional.}}  
−
 
+
|{{{field|Documentation note}}}
−
'''Paid support:''' {{{field|Paid support}}}
+
|-
−
 
 
−
'''Decommissioned/Obsolete:''' {{{field|Decommissioned/Obsolete|input type=checkbox|show on select=decommissioneddiv}}}
 
  
 +
! Is decommissioned or obsolete:
 +
|{{{field|Decommissioned or Obsolete|input type=checkbox|show on select=decommissioneddiv}}}
 
<div id="decommissioneddiv">
 
<div id="decommissioneddiv">
−
'''Details:'''{{{field|Decommissioned details|input type=textarea}}}
+
{| class="formtable"
−
'''Replaced by:''' {{#info:URL of the page or name of package ( as "<nowiki>[[PKGNAME]]</nowiki>") which replaces current package.}}{{{field|Replaced by|input type=text|size=60}}}
+
! Details:  
 +
| {{{field|Decommissioned details|input type=textarea}}}
 +
|-
 +
! Replaced by: {{#info:URL of the page or name of package ( as "<nowiki>[[PKGNAME]]</nowiki>") which replaces current package.}}  
 +
| {{{field|Replaced by|input type=text|size=60}}}
 +
|}
 
</div>
 
</div>
 +
|-
  
−
'''Donate:''' {{{field|Donate}}}
+
! Donate: {{#info:Direct URL of the donation page to support the development of this free software. Redirects with ads, paywalls and downloads are strictly forbidden.}}
 +
|{{{field|Donate}}}
 +
|-
  
−
'''Accepts cryptocurrency donations:''' {{{field|Accepts cryptocurrency donations|input type=checkbox}}}
+
! Microblog URL: {{#info:Direct URL of the donation page to support the development of this free software. Redirects with ads, paywalls and adult content are strictly forbidden.}}
 +
|{{{field|Microblog}}}
 +
|-
  
−
'''Microblog URL:''' {{{field|Microblog}}}
+
! IRC general: {{#info:Discussion channel. Should be in the form of an <code>irc://</code> link, for use with IRC clients. If there is only one channel, write it here. The “real” freenode address is <code>chat.freenode.net</code>, all others are redirects.}}
 +
| {{{field|IRC general|size=60}}}
 +
|-
  
−
'''IRC help:''' {{#info:Should be in the form of an <code>irc://</code> link, for use with IRC clients. Do not put the same channel as IRC general. The “real” freenode address is <code>chat.freenode.net</code>, all others are redirects.}} {{{field|IRC help|size=60}}}
+
! IRC help: {{#info:Support channel. Should be in the form of an <code>irc://</code> link, for use with IRC clients. Do not put the same channel as IRC general. The “real” freenode address is <code>chat.freenode.net</code>, all others are redirects.}}  
 +
| {{{field|IRC help|size=60}}}
 +
|-
  
−
'''IRC general:''' {{#info:Should be in the form of an <code>irc://</code> link, for use with IRC clients. If there is only one channel, write it here. The “real” freenode address is <code>chat.freenode.net</code>, all others are redirects.}} {{{field|IRC general|size=60}}}
+
! IRC development: {{#info:Development channel. Should be in the form of an <code>irc://</code> link, for use with IRC clients. Do not put the same channel as IRC general. The “real” freenode address is <code>chat.freenode.net</code>, all others are redirects.}}  
 +
| {{{field|IRC development|size=60}}}
 +
|-
  
−
'''IRC development:''' {{#info:Should be in the form of an <code>irc://</code> link, for use with IRC clients. Do not put the same channel as IRC general. The “real” freenode address is <code>chat.freenode.net</code>, all others are redirects.}} {{{field|IRC development|size=60}}}
+
! Related projects: {{#info:Write closely related projects here, separated by comma and space. Names are case-sensitive, except for the first letter. You may add non-existing FSD entries.}}  
 +
| {{{field|Related projects}}}
 +
|-
  
−
'''Related projects:''' {{#info:Write closely related projects here, separated by commas and a space. Names are case-sensitive, except for the first letter. You may add non-existing entries.}} {{{field|Related projects}}}
+
! Keywords: {{#info:Keywords for Search Engine Optimization. No more than 12 significative keywords. Separate keywords by comma and space. Choose wisely.}}  
 +
| {{{field|Keywords}}}
 +
|-
  
−
'''Keywords:''' {{#info:Separate keywords by commas and a space.}} {{{field|Keywords}}}
+
! Version identifier: {{#info:Arbitrary version number. Sensible messages (except beta, alpha and release candidates) must be avoided.}}  
 +
| {{{field|Version identifier}}}
 +
|-
  
−
'''Version identifier:''' {{{field|Version identifier}}}
+
! Version date: {{#info:Release date of this version. Use the interactive dialog to find a specific day. Leave blank if unsure.}}
 +
| {{{field|Version date|input type=datepicker|date format=yy-mm-dd}}}
 +
|-
  
−
'''Version date:''' {{{field|Version date|input type=datepicker|date format=yy-mm-dd}}}
+
! Version status: {{#info:If unsure, set to “stable” or see more details in the [[Free_Software_Directory:Participate#Guidelines for choosing Version Status of an entry|participation guide]].}}
 +
| {{{field|Version status}}}
 +
|-
  
−
'''Version status:''' {{#info:If unsure, set to “stable” or see more details in the [[Free_Software_Directory:Participate#Guidelines for choosing Version Status of an entry|participation guide]].}} {{{field|Version status}}}
+
! Version download: {{#info:Direct download of this free software package.}}  
 +
| {{{field|Version download|size=60}}}
 +
|-
  
−
'''Version download:''' {{{field|Version download|size=60}}}
+
! Version comment: {{#info:Peculiarities that only concern this specific version of the software.}}
 +
| {{{field|Version comment}}}
 +
|-
  
−
'''Checksum:'''  {{{field|Checksum}}}
+
! Last review by: {{#info:FSD username. Change this to your FSD account name in case you have made substantial edits or have updated the version.}}
 +
| {{{field|Last review by}}}
 +
|-
  
−
'''OpenPGP signature URL:'''  {{{field|OpenPGP signature}}}
+
! Last review date: {{#info:Change this date in case you have made substantial edits or have updated the version.}}
 +
| {{{field|Last review date|input type=datepicker|date format=yy-mm-dd}}}
 +
|-
  
−
'''OpenPGP public key URL:'''  {{{field|OpenPGP public key}}}
+
! Submitted by: {{#info:FSD username. Do not touch this unless you are creating a new entry. If you are updating an entry whose Submitted by entry is empty, keep it empty.}}
 +
| {{{field|Submitted by}}}
 +
|-
  
−
'''Version comment:'''  {{{field|Version comment}}}
+
! Submitted date: {{#info:Do not touch this unless you are creating a new entry. If you are updating an entry whose Submitted date entry is empty, keep it empty.}}
 +
| {{{field|Submitted date|input type=datepicker|date format=yy-mm-dd}}}
 +
|-
  
−
'''Test entry:'''{{#info:Mark this page as a test entry}}{{{field|Test entry|input type=checkbox}}}<br/>
+
! User level: {{#info:Learning curve of this free software.}}  
 +
| {{{field|User level|input type=radiobutton}}}
 +
|-
  
−
'''Last review by:''' {{#info:Change this to your user name in case you have made substantial edits or have updated the version.}} {{{field|Last review by}}}
+
! This is an extension, add-on, or plugin to: {{#info:Name of a single FSD entry.}}
 +
| {{{field|Extension of|input type=text with autocomplete}}}
 +
|-
  
−
'''Last review date:''' {{#info:Change this date in case you have made substantial edits or have updated the version.}} {{{field|Last review date|input type=datepicker|date format=yy-mm-dd}}}
+
! This is an inbuilt extension, add-on, or plugin to: {{#info:Name of a single FSD entry.}}
 +
|  {{{field|Inbuilt extension of|input type=text with autocomplete}}}
 +
|-
  
−
'''Submitted by:''' {{#info:Do not touch this unless you are creating a new entry. If you are updating an entry whose Submitted by entry is empty, keep it empty.}} {{{field|Submitted by}}}
+
! Component programs: {{#info:List of FSD entries. High level dependencies. Ideal for scripts.}}  
 +
|{{{field|Component programs|input type=text with autocomplete}}}
 +
|-
  
−
'''Submitted date:''' {{#info:Do not touch this unless you are creating a new entry. If you are updating an entry whose Submitted date entry is empty, keep it empty.}} {{{field|Submitted date|input type=datepicker|date format=yy-mm-dd}}}
+
! Paid support: {{#info:Direct URL to contact the paid support. The price must be clearly visible on the destination page. Redirects with ads, paywalls and adult content are strictly forbidden.}}  
 +
|{{{field|Paid support}}}
 +
|-
  
−
''To save your changes, click the <strong>'Save'</strong> tab at the top of the page, then click the <strong>'Save page'</strong> button.''
+
! Accepts cryptocurrency donations:
 +
|{{{field|Accepts cryptocurrency donations|input type=checkbox}}}
 +
|-
  
−
</div>
+
! Checksum: {{#info:Checksum of this free software release. Please use "sum" from the GNU coreutils. Used during security checks.}}
 +
| {{{field|Checksum}}}
 +
|-
  
−
<div style="display:none">{{{field|Status|hidden}}}</div>
+
! OpenPGP signature URL: {{#info:Direct URL of the PGP signature. It can be used to verify the VCS commits. Redirects with ads, paywalls and adult content are strictly forbidden.}}
 +
| {{{field|OpenPGP signature}}}
 +
|-
  
−
=2. GNU =
+
! OpenPGP public key URL: {{#info:Direct URL of the PGP public key. It can be used to contact the lead developer. Redirects with ads, paywalls and adult content are strictly forbidden.}}
−
A project is GNU if it is listed at [https://gnu.org/software gnu.org/software]. The project's GNU package identifier is the lowercase name listed on that page.
+
| {{{field|OpenPGP public key}}}
 +
|-
  
−
'''Is GNU:''' {{{field|Is GNU|input type=checkbox}}}  
+
! Test entry:{{#info:Mark this page as a test entry. It is intended for use by inexperienced users but it is not a sandbox. Deactivate when the page is ready for official publication.}}
 +
| {{{field|Test entry|input type=checkbox}}}
 +
|}
  
−
'''GNU package identifier:''' {{{field|GNU package identifier}}}
+
It is recommended to add as many details of your software as possible for better popularity and faster indexing by public search engines.
  
−
{{{end template}}}
+
''To save your changes, click the <strong>'Save'</strong> tab at the top of the page, then click the <strong>'Save page'</strong> button.''
  
−
=3. Licenses =
+
</div>
−
{{{for template|Project license|strict|multiple}}}
 
−
'''License and version:''' {{{field|License|input type=combobox|values from property=License}}}
 
  
−
'''License copyright:''' {{{field|License copyright|input type=textarea}}}
+
<div style="display:none">{{{field|Status|hidden|strict|multiple}}}</div>
  
−
'''License verified by:''' {{{field|License verified by}}}
+
=2. Licenses =
 +
{{{for template|Project license}}}
 +
'''License and version:''' {{#info:[https://spdx.org/licenses/ SPDX] license identifier. Must correspond to the license of the specific version of the free software published here. The full license should be written inside the COPYING file inside the repository. Press any key to quickly select entries that start with that character.}} {{{field|License|input type=dropdown|values from namespace=License}}}
  
−
'''License verified date:''' {{{field|License verified date|input type=datepicker|date format=yy-mm-dd}}}
 
  
−
'''License note:''' {{#info:You may put a link to the project's license file.}} {{{field|License note|input type=textarea}}}
+
'''License copyright:''' {{#info:Copyright (with year of validity) of the software. Should be at the top of the COPYING file.}} {{{field|License copyright|input type=textarea}}}
  
−
{{{end template}}}
+
'''License verified by:''' {{{field|License verified by}}}
−
 
 
−
=4. Person info =
 
−
{{{for template|Person|multiple}}}
 
−
'''Real name:''' {{{field|Real name}}}
 
−
 
 
−
'''Role:''' {{{field|Role}}}
 
−
 
 
−
'''Email:''' {{{field|Email}}}
 
−
 
 
−
'''FSF username:''' {{{field|Username}}}
 
−
 
 
−
<div style="display:none">'''Resource URL''' {{{field|Resource URL|hidden}}}</div>
 
−
{{{end template}}}
 
−
 
 
−
=5. Resource info=
 
−
{{{for template|Resource|multiple}}}
 
−
'''Resource audience:''' {{{field|Resource audience}}}
 
  
−
'''Resource kind:''' {{{field|Resource kind}}}
+
'''License verified date:''' {{{field|License verified date|input type=datepicker|date format=yy-mm-dd|default={{CURRENTYEAR}}-{{CURRENTMONTH}}-{{CURRENTDAY2}} }}}
  
−
'''Resource URL:''' {{{field|Resource URL}}}
+
'''License note:''' {{#info:You should put a direct link to the project's COPYING file, even if it is contained in a VCS. Other authoritative pages with the license are allowed. This directory allows only free software.}} {{{field|License note|input type=textarea}}}
  
 
{{{end template}}}
 
{{{end template}}}
  
−
=6. Categories=
+
=3. Categories=
 
{{{for template|Software category|strict}}}
 
{{{for template|Software category|strict}}}
 
{| class="formtable"
 
{| class="formtable"
Line 266: Line 325:
 
{{{end template}}}
 
{{{end template}}}
  
−
=7. Software prerequisites=
+
=4. GNU =
 +
A project is GNU if it is listed at [https://gnu.org/software gnu.org/software]. The project's GNU package identifier is the lowercase name listed on that page.
 +
 
 +
{| class="formtable"
 +
! Is GNU:
 +
| {{{field|Is GNU|input type=checkbox}}}
 +
|-
 +
 
 +
! GNU package identifier:
 +
| {{{field|GNU package identifier}}}
 +
|}
 +
 
 +
{{{end template}}}
 +
 
 +
=5. Software prerequisites=
 
{{{for template|Software prerequisite|multiple}}}
 
{{{for template|Software prerequisite|multiple}}}
 
'''Prerequisite kind:''' {{{field|Prerequisite kind}}}
 
'''Prerequisite kind:''' {{{field|Prerequisite kind}}}
Line 272: Line 345:
 
'''Prerequisite description:''' {{{field|Prerequisite description}}}
 
'''Prerequisite description:''' {{{field|Prerequisite description}}}
  
 +
{{{end template}}}
 +
 +
=6. Person info =
 +
{{{for template|Person|multiple}}}
 +
{| class="formtable"
 +
! Real name:
 +
| {{{field|Real name}}}
 +
|-
 +
 +
! Role:
 +
| {{{field|Role}}}
 +
|-
 +
 +
! Email:
 +
| {{{field|Email}}}
 +
|-
 +
 +
! FSF username:
 +
| {{{field|Username}}}
 +
|}
 +
 +
<div style="display:none">'''Resource URL''' {{{field|Resource URL|hidden}}}</div>
 +
{{{end template}}}
 +
 +
=7. Resource info=
 +
{{{for template|Resource|multiple}}}
 +
{| class="formtable"
 +
! Resource audience:
 +
| {{{field|Resource audience}}}
 +
|-
 +
! Resource kind:
 +
| {{{field|Resource kind}}}
 +
|-
 +
! Resource URL:
 +
| {{{field|Resource URL}}}
 +
|}
 
{{{end template}}}
 
{{{end template}}}
  
Line 278: Line 387:
  
 
{{{for template|Featured|strict}}}
 
{{{for template|Featured|strict}}}
−
'''Featured date:''' {{{field|Featured date|restricted|input type=datepicker|date format=yy-mm-dd}}}
+
'''Featured date:''' {{{field|Featured date|input type=datepicker|date format=yy-mm-dd}}}
  
−
'''Featured source:''' {{{field|Featured source|restricted|maxlength=100}}}
+
'''Featured source:''' {{{field|Featured source|maxlength=100}}}
  
−
'''Featured category:''' {{{field|Featured category|restricted|maxlength=100}}}
+
'''Featured category:''' {{{field|Featured category|maxlength=100}}}
  
 
{{{end template}}}
 
{{{end template}}}
Line 300: Line 409:
  
 
{{{standard input|minor edit}}} {{{standard input|watch}}}
 
{{{standard input|minor edit}}} {{{standard input|watch}}}
 +
 +
The new page is stored permanently, <b>double check all fields before saving the page</b>.<br/>
 +
The pages become completely visible only after the approval of at least one FSD administrator.
  
 
{{{standard input|save}}} {{{standard input|changes}}} {{{standard input|cancel}}}
 
{{{standard input|save}}} {{{standard input|changes}}} {{{standard input|cancel}}}

Revision as of 15:46, 22 January 2021


Before adding a new entry to the Free Software Directory (FSD), please make sure that entry does not already exist by first using the Search box.

Programs added to the FSD must be useful free software and it must run on a completely free OS such as GNU/Linux. If the software runs on non-free operating system, then it must work as well or better on the completely free operating system as it does on the other operating systems.

To add a new entry, please enter the name of the program below. Please note that after submitting a new entry, your page will not be public until it has been reviewed and approved and published by administrators. However, you can continue to make edits to the page with your new entry on it after you submit it and before it has been approved for publication -- just click the edit button on the page after it is created.

The text you use here will be the end of the URL for that project page, so make sure that the text is typeable ASCII (A-Z, a-z, 0-9 and spaces), has no awkward symbols, ideally no accents, and uses the spacing and capitalization that the project uses. The idea is that people should be able to type it easily, regardless of language. Also, the shorter name is best, when multiple are available.





Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the page “GNU Free Documentation License”.

The copyright and license notices on this page only apply to the text on this page. Any software or copyright-licenses or other similar notices described in this text has its own copyright notice and license, which can usually be found in the distribution or license text itself.

Retrieved from "https://directory.fsf.org/wiki?title=Form:Entry&oldid=83313"