Difference between revisions of "Form:Entry"

From Free Software Directory
Jump to: navigation, search
(Add many info.)
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, 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.
 
To add a new entry, please enter the name of the program below.
  
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.
+
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>
Line 16: Line 16:
 
'''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 (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}}}
  
'''Short description (required):''' {{{field|Short description|mandatory}}}
+
'''Short description (required):''' {{#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 (required):''' {{#info:Please write a short summary of what the package does or is used for. Wikicode can be used. 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}}}
  
 
'''Homepage URL (required):''' {{{field|Homepage URL|mandatory|size=60}}}
 
'''Homepage URL (required):''' {{{field|Homepage URL|mandatory|size=60}}}
Line 28: Line 28:
 
'''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 “git clone”, “svn co” 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:Wikicode can be used.}}{{{field|Documentation note}}}
  
 
'''Paid support:''' {{{field|Paid support}}}
 
'''Paid support:''' {{{field|Paid support}}}
Line 40: Line 40:
 
'''Microblog URL:''' {{{field|Microblog}}}
 
'''Microblog URL:''' {{{field|Microblog}}}
  
'''IRC help:''' {{{field|IRC help|size=60}}}
+
'''IRC help:''' {{#info:Should be in the form of irc:// link, for use with IRC clients. Do not put the same channel as IRC general.}}{{{field|IRC help|size=60}}}
  
'''IRC general:''' {{{field|IRC general|size=60}}}
+
'''IRC general:''' {{#info:Should be in the form of irc:// link, for use with IRC clients. If there is only one channel, write it here.}}{{{field|IRC general|size=60}}}
  
'''IRC development:''' {{{field|IRC development|size=60}}}
+
'''IRC development:''' {{#info:Should be in the form of irc:// link, for use with IRC clients. Do not put the same channel as IRC general.}}{{{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.}}{{{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 54:
 
'''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”.}}{{{field|Version status}}}
  
 
'''Version download:''' {{{field|Version download|size=60}}}
 
'''Version download:''' {{{field|Version download|size=60}}}
Line 60: Line 60:
 
'''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 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 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.}}{{#info{{{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 75:
  
 
=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 93: Line 93:
 
'''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 190: Line 190:
 
| {{{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 217:
 
| {{{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 18:12, 31 October 2014


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.

To add a new entry, please enter the name of the program below.

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.