Difference between revisions of "Form:Entry"

From Free Software Directory
Jump to: navigation, search
m (Revert to https://directory.fsf.org/wiki?title=Form:Entry&oldid=55557)
(27 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
<noinclude>
 
<noinclude>
Before adding a new entry to the Free Software Directory, please make sure that entry does not already exist by first using the ''Search'' box.  
+
'''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.'''
  
To add a new entry, please enter the name of the program below.
+
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.  
  
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, 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.
+
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.
 
{{#forminput:form=Entry|button text=Add an entry}}
 
{{#forminput:form=Entry|button text=Add an entry}}
 +
 +
 +
 +
 
</noinclude><includeonly>
 
</noinclude><includeonly>
 
=1. General info =
 
=1. General info =
This form contains nine tabs. Please make sure to include the license and other basic info. The save button appears on the 9th tab.  
+
This form contains 9 tabs. Please include the license and other basic information. The '''Save''' button appears on the '''last (9th) tab'''.  
  
 
<div id="wikiPreview" style="display: none; padding-bottom: 25px; margin-bottom: 25px; border-bottom: 1px solid #AAAAAA;"></div>
 
<div id="wikiPreview" style="display: none; padding-bottom: 25px; margin-bottom: 25px; border-bottom: 1px solid #AAAAAA;"></div>
 
{{{for template|Entry|strict}}}
 
{{{for template|Entry|strict}}}
 
<div style="width:500">
 
<div style="width:500">
'''Name (required):'''{{#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}}}
+
'''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}}}
  
'''Short description (required):''' {{{field|Short description|mandatory}}}
+
'''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}}}
  
'''Full description (required):'''{{#info:Please write a short summary of what the package does or is used for. It needn't include any licensing info. We recommend writing your own original description rather than simply copying and pasting one from the project's homepage. Also, remember that some there are a number of [http://www.gnu.org/philosophy/words-to-avoid.html words and phrases that we recommend avoiding]. }}{{{field|Full description|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}}}
  
'''Homepage URL (required):''' {{{field|Homepage URL|mandatory|size=60}}}
+
'''Homepage URL <span style="color:#00b">(required)</span>:''' {{{field|Homepage URL|mandatory|size=60}}}
  
 
'''User level:''' {{{field|User level|input type=radiobutton}}}
 
'''User level:''' {{{field|User level|input type=radiobutton}}}
  
'''This an extension, add-on, or plugin to:''' {{{field|Extension of|input type=text with autocomplete}}}
+
'''This is an extension, add-on, or plugin to:''' {{{field|Extension of|input type=text with autocomplete}}}
 +
 
 +
'''This is an inbuilt extension, add-on, or plugin to:''' {{{field|Inbuilt extension of|input type=text with autocomplete}}}
  
 
'''Component programs:''' {{{field|Component programs|input type=text with autocomplete}}}
 
'''Component programs:''' {{{field|Component programs|input type=text with autocomplete}}}
  
'''VCS checkout command:''' {{{field|VCS checkout command}}}
+
'''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}}}
  
 
'''Computer languages:''' {{{field|Computer languages}}}
 
'''Computer languages:''' {{{field|Computer languages}}}
  
'''Documentation note:''' {{{field|Documentation note}}}
+
'''Documentation note:''' {{#info:[https://en.wikipedia.org/wiki/Help:Wiki_markup Wiki markup] can be used.}} {{{field|Documentation note}}}
  
 
'''Paid support:''' {{{field|Paid support}}}
 
'''Paid support:''' {{{field|Paid support}}}
  
 
'''Donate:''' {{{field|Donate}}}
 
'''Donate:''' {{{field|Donate}}}
 +
 +
'''Accepts cryptocurrency donations:''' {{{field|Accepts cryptocurrency donations|input type=checkbox}}}
  
 
'''Microblog URL:''' {{{field|Microblog}}}
 
'''Microblog URL:''' {{{field|Microblog}}}
  
'''IRC help:''' {{{field|IRC help|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 general:''' {{{field|IRC general|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:''' {{{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:''' {{{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:''' {{{field|Keywords}}}
+
'''Keywords:''' {{#info:Separate keywords by commas and a space.}} {{{field|Keywords}}}
  
 
'''Version identifier:''' {{{field|Version identifier}}}
 
'''Version identifier:''' {{{field|Version identifier}}}
Line 54: Line 64:
 
'''Version date:''' {{{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:''' {{{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:''' {{{field|Version download|size=60}}}
 
'''Version download:''' {{{field|Version download|size=60}}}
 +
 +
'''Checksum:'''  {{{field|Checksum}}}
 +
 +
'''OpenPGP signature URL:'''  {{{field|OpenPGP signature}}}
 +
 +
'''OpenPGP public key URL:'''  {{{field|OpenPGP public key}}}
  
 
'''Version comment:'''  {{{field|Version comment}}}
 
'''Version comment:'''  {{{field|Version comment}}}
  
'''Last review by:''' {{{field|Last review by}}}
+
'''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}}}
  
'''Last review date:''' {{{field|Last review date|input type=datepicker|date format=yy-mm-dd}}}
+
'''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}}}
  
'''Submitted by:''' {{{field|Submitted by}}}
+
'''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}}}
  
'''Submitted date:''' {{{field|Submitted date|input type=datepicker|date format=yy-mm-dd}}}
+
'''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}}}
  
''To save your changes, click the <strong>'save'</strong> tab at the top of the page, then click the <strong>'save page'</strong> button.''
+
''To save your changes, click the <strong>'Save'</strong> tab at the top of the page, then click the <strong>'Save page'</strong> button.''
  
 
</div>
 
</div>
Line 75: Line 91:
  
 
=2. GNU =
 
=2. GNU =
A project is GNU if it is listed at gnu.org/software . The project's GNU package identifier is the lowercase name listed on that page.
+
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.
  
 
'''Is GNU:''' {{{field|Is GNU|input type=checkbox}}}
 
'''Is GNU:''' {{{field|Is GNU|input type=checkbox}}}
Line 85: Line 101:
 
=3. Licenses =
 
=3. Licenses =
 
{{{for template|Project license|strict|multiple}}}
 
{{{for template|Project license|strict|multiple}}}
'''License:''' {{{field|License|input type=combobox|values from property=License}}}
+
'''License and version:''' {{{field|License|input type=combobox|values from property=License}}}
  
 
'''License copyright:''' {{{field|License copyright|input type=textarea}}}
 
'''License copyright:''' {{{field|License copyright|input type=textarea}}}
Line 93: Line 109:
 
'''License verified date:''' {{{field|License verified date|input type=datepicker|date format=yy-mm-dd}}}
 
'''License verified date:''' {{{field|License verified date|input type=datepicker|date format=yy-mm-dd}}}
  
'''License note:''' {{{field|License note|input type=textarea}}}
+
'''License note:''' {{#info:You may put a link to the project's license file.}} {{{field|License note|input type=textarea}}}
  
 
{{{end template}}}
 
{{{end template}}}
Line 104: Line 120:
  
 
'''Email:''' {{{field|Email}}}
 
'''Email:''' {{{field|Email}}}
 +
 +
'''FSF username:''' {{{field|Username}}}
  
 
<div style="display:none">'''Resource URL''' {{{field|Resource URL|hidden}}}</div>
 
<div style="display:none">'''Resource URL''' {{{field|Resource URL|hidden}}}</div>
Line 190: Line 208:
 
| {{{field|Program-build-automation|property=Program-build-automation|input type=checkboxes}}}
 
| {{{field|Program-build-automation|property=Program-build-automation|input type=checkboxes}}}
 
|-
 
|-
! Programming-language:{{#info:The language the source code of the program is written in.}}
+
! Programming-language: {{#info:The language the source code of the program is written in.}}
 
| {{{field|Programming-language|property=Programming-language|input type=checkboxes}}}
 
| {{{field|Programming-language|property=Programming-language|input type=checkboxes}}}
 
|-
 
|-
Line 217: Line 235:
 
| {{{field|Use|property=Use|input type=checkboxes}}}
 
| {{{field|Use|property=Use|input type=checkboxes}}}
 
|-
 
|-
! UI Toolkit:
+
! UI Toolkit: {{#info:The user interface toolkit used by the program.}}
 
| {{{field|Uitoolkit|property=Uitoolkit|input type=checkboxes}}}
 
| {{{field|Uitoolkit|property=Uitoolkit|input type=checkboxes}}}
 
|-
 
|-
! Version-control:
+
! Version-control: {{#info:Only check this for software interacting with version control systems, not just software being developed using a particular version control system.}}
 
| {{{field|Version-control|property=Version-control|input type=checkboxes}}}
 
| {{{field|Version-control|property=Version-control|input type=checkboxes}}}
 
|-
 
|-

Revision as of 15:44, 22 February 2018


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.