Difference between revisions of "Form:Entry"

From Free Software Directory
Jump to: navigation, search
(+improve security; +correct support for GNU; +missing documentation)
 
(19 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
<noinclude>
 
<noinclude>
'''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.'''  
+
'''Before adding a new entry to the <abbr title="Free Software Directory">FSD</abbr>, please make sure that entry does not already exist by first using the ''[[Special:Search|Search page]]'' or 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.  
 
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.  
+
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 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 &mdash; 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.
 
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|placeholder=Name of the new software}}
  
  
  
  
</noinclude><includeonly>
+
</noinclude><includeonly>=1. General info =
=1. General info =
+
This form contains 9 tabs. Please include the license ('''the (2nd) tab''') and the basic information on this tab. You may optionally add
This form contains 9 tabs. Please include the license and other basic information. The '''Save''' button appears on the '''last (9th) tab'''.  
+
additional information via the other tabs. Once you've made your edits, you can save via the '''Save page''' button, which 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>
 +
<!-- See Template:Entry and Template:Show, then the others at the same level of the hierarchy -->
 
{{{for template|Entry|strict}}}
 
{{{for template|Entry|strict}}}
<div style="width:500">
+
<div>
 
{| class="formtable"
 
{| class="formtable"
  
! 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. }}  
+
! Name<sup>*</sup>: {{#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}}}
 
| {{{field|Name|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.}}
+
! <span style="font-size:smaller">Short description<sup>*</sup></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}}}
 
| {{{field|Short 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].}}  
+
! Full description<sup>*</sup>: {{#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}}}
+
| {{{field|Full description|input type=textarea|autogrow|rows=2|mandatory}}}
 
|-
 
|-
  
 +
! Homepage URL<sup>*</sup>: {{#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}}}
 +
|-
  
! Version download: {{#info:Direct download of this free software package.}}  
+
! Ver. download: {{#info:Direct download URL of this specific version of the free software package.}}  
 
| {{{field|Version download|size=60}}}
 
| {{{field|Version download|size=60}}}
|-
 
 
 
|}
 
|}
 +
{{{end template}}}
  
It is recommended to add as many details of your software as possible for better popularity and faster indexing by public search engines.
+
<p style="text-align:right">&lowast;&nbsp;=&nbsp;required</p>
 +
</div>
  
''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 style="display:none">{{{field|Status|hidden|strict|multiple}}}</div>
  
</div>
+
=2. License =
 +
<!-- See Template:Project_license -->
 +
{{{for template|Project license|strict}}}
 +
'''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}}}
  
<div style="display:none">{{{field|Status|hidden}}}</div>
 
 
=2. Licenses =
 
{{{for template|Project license|strict|multiple}}}
 
'''License and version:''' {{#info:Must correspond to the license of the specific version of the free software published here. Should be present in 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 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}}}
 
'''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}}}
Line 64: Line 66:
  
 
=3. Categories=
 
=3. Categories=
 +
<!-- See Template:Software_category -->
 
{{{for template|Software category|strict}}}
 
{{{for template|Software category|strict}}}
 
{| class="formtable"
 
{| class="formtable"
Line 183: Line 186:
  
 
=4. GNU =
 
=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.
+
A project is GNU only 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.
 
+
<!-- See Template:EntryGNU -->
 +
{{{for template|EntryGNU|strict}}}
 
{| class="formtable"
 
{| class="formtable"
 
! Is GNU:
 
! Is GNU:
Line 193: Line 197:
 
| {{{field|GNU package identifier}}}
 
| {{{field|GNU package identifier}}}
 
|}
 
|}
 
 
{{{end template}}}
 
{{{end template}}}
  
 
=5. Software prerequisites=
 
=5. Software prerequisites=
 +
<!-- See Template:Software_prerequisite -->
 
{{{for template|Software prerequisite|multiple}}}
 
{{{for template|Software prerequisite|multiple}}}
 
'''Prerequisite kind:''' {{{field|Prerequisite kind}}}
 
'''Prerequisite kind:''' {{{field|Prerequisite kind}}}
Line 205: Line 209:
  
 
=6. Person info =
 
=6. Person info =
 +
<!-- See Template:Person -->
 
{{{for template|Person|multiple}}}
 
{{{for template|Person|multiple}}}
 
{| class="formtable"
 
{| class="formtable"
Line 227: Line 232:
  
 
=7. Resource info=
 
=7. Resource info=
 +
<!-- See Template:Resource -->
 
{{{for template|Resource|multiple}}}
 
{{{for template|Resource|multiple}}}
 
{| class="formtable"
 
{| class="formtable"
Line 241: Line 247:
  
 
=8. Etc.=
 
=8. Etc.=
If a program has been featured somewhere, such as the FSF Supporter, then you may fill out the following:
+
It is recommended to add as many details of your software as possible for better popularity and faster indexing by public search engines:
 
+
<!-- See Template:EntryDetails -->
{{{for template|Featured|strict}}}
+
{{{for template|EntryDetails|strict}}}
'''Featured date:''' {{{field|Featured date|input type=datepicker|date format=yy-mm-dd}}}
+
{| class="formtable"
 
 
'''Featured source:''' {{{field|Featured source|maxlength=100}}}
 
 
 
'''Featured category:''' {{{field|Featured category|maxlength=100}}}
 
 
 
{{{end template}}}
 
 
 
If a program has been imported from a distribution or packaging system.
 
 
{{{for template|Import|multiple}}}
 
'''Date:''' {{{field|Date|property=Import date|restricted|input type=datepicker|date format=yy-mm-dd}}}
 
 
 
'''Source:''' {{{field|Source|property=Import source|restricted}}}
 
 
 
'''Source link:''' {{{field|Source link|property=Import source link|restricted}}}
 
{{{end template}}}
 
 
 
{{{for template|Entry|strict}}}
 
 
 
 
! 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.}}
 
! 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}}}
 
| {{{field|Screenshot 1|input type=text|uploadable|property=Screenshot 1|size=60}}}
Line 274: Line 261:
 
! Screenshot 3:
 
! Screenshot 3:
 
| {{{field|Screenshot 3|input type=text|uploadable|property=Screenshot 3|size=60}}}
 
| {{{field|Screenshot 3|input type=text|uploadable|property=Screenshot 3|size=60}}}
|-
 
 
! 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}}}
 
 
|-
 
|-
  
Line 284: Line 267:
 
|-
 
|-
  
! 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).}}  
+
! VCS clone shell 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}}}
 
|{{{field|VCS checkout command}}}
 
|-
 
|-
Line 292: Line 275:
 
|-
 
|-
  
! 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.}}  
+
! Doc notes: {{#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}}}
 
|{{{field|Documentation note}}}
 
|-
 
|-
Line 303: Line 286:
 
| {{{field|Decommissioned details|input type=textarea}}}
 
| {{{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.}}  
+
! Replaced by package: {{#info:URL of the page or name of package (as "&lbrack;&lbrack;PKGNAME]]") which replaces current package.}}  
 
| {{{field|Replaced by|input type=text|size=60}}}
 
| {{{field|Replaced by|input type=text|size=60}}}
 
|}
 
|}
Line 345: Line 328:
 
|-
 
|-
  
! 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]].}}  
+
! Ver. 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}}}
 
| {{{field|Version status}}}
 
|-
 
|-
Line 373: Line 356:
 
|-
 
|-
  
! This is an extension, add-on, or plugin to: {{#info:Name of a single FSD entry.}}
+
! This is an extension/add-on/plugin to: {{#info:Name of a single FSD entry.}}
 
| {{{field|Extension of|input type=text with autocomplete}}}
 
| {{{field|Extension of|input type=text with autocomplete}}}
 
|-
 
|-
  
! This is an inbuilt extension, add-on, or plugin to: {{#info:Name of a single FSD entry.}}
+
! This is an inbuilt extension/add-on/plugin to: {{#info:Name of a single FSD entry.}}
 
|  {{{field|Inbuilt extension of|input type=text with autocomplete}}}
 
|  {{{field|Inbuilt extension of|input type=text with autocomplete}}}
 
|-
 
|-
Line 405: Line 388:
 
|-
 
|-
  
! Test entry:{{#info:Mark this page as a test entry. It is intended for use by unexperienced users but it is not a sandbox. Deactivate when the page is ready for official pubblication.}}
+
! 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}}}
 
| {{{field|Test entry|input type=checkbox}}}
 +
|}
 +
{{{end template}}}
 +
 +
If a program has been featured somewhere, such as the FSF Supporter, then you may fill out the following:
 +
<!-- See Template:Featured -->
 +
{{{for template|Featured|strict|label=Public media:}}}
 +
'''Featured date:''' {{{field|Featured date|input type=datepicker|date format=yy-mm-dd}}}
 +
 +
'''Featured source:''' {{{field|Featured source|maxlength=100}}}
 +
 +
'''Featured category:''' {{{field|Featured category|maxlength=100}}}
 +
 +
{{{end template}}}
 +
 +
If a program has been imported from a distribution or packaging system:
 +
<!-- See Template:Import, which should be repeatable -->
 +
{{{for template|Import|multiple|label=External import:}}}
 +
'''Date:''' {{{field|Date|property=Import date|restricted|input type=datepicker|date format=yy-mm-dd}}}
 +
 +
'''Source:''' {{{field|Source|property=Import source|restricted}}}
  
 +
'''Source link:''' {{{field|Source link|property=Import source link|restricted}}}
 
{{{end template}}}
 
{{{end template}}}
  
 
=9. Save=
 
=9. Save=
{{{standard input|summary}}}
+
{{{standard input|summary}}} {{#info:Never leave it empty. Unless you are creating a new page, the summary ''must'' contain an explicative list of changes. It will be stored permanently in the public history of the page.}}
  
{{{standard input|minor edit}}} {{{standard input|watch}}}
+
{{{standard input|minor edit}}} {{#info:A minor edit is a version that the editor believes requires no review and could never be the subject of a dispute. An edit marked as minor appears on the right of a lower case, bolded "m" character (m) in the history. If unsure leave unchecked. Check this ''only'' if superficial differences exist between the current and previous version: typo corrections, formatting and presentational changes, rearranging of text without modifying content, &hellip;}} {{{standard input|watch}}} {{#info:Check this only if you want to be notified for future major changes of this page via your [[Special:Watchlist|watchlist]].}}
  
 
The new page is stored permanently, <b>double check all fields before saving the page</b>.<br/>
 
The new page is stored permanently, <b>double check all fields before saving the page</b>.<br/>

Latest revision as of 06:58, 24 February 2021


Before adding a new entry to the FSD, please make sure that entry does not already exist by first using the Search page or 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 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.