Skip to content

Commit 5c8128c

Browse files
committed
port new changes to en
1 parent cd8dba6 commit 5c8128c

File tree

6 files changed

+177
-354
lines changed

6 files changed

+177
-354
lines changed

docs/en/categories-list.rst

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
.. _categories-list:
2+
3+
List of software categories
4+
===========================
5+
6+
Here follows a controlled vocabulary of useful tags for categorizing the
7+
software.
8+
9+
====================================
10+
Tag
11+
====================================
12+
accounting
13+
agile-project-management
14+
applicant-tracking
15+
application-development
16+
appointment-scheduling
17+
backup
18+
billing-and-invoicing
19+
blog
20+
budgeting
21+
business-intelligence
22+
business-process-management
23+
cad
24+
call-center-management
25+
cloud-management
26+
collaboration
27+
communications
28+
compliance-management
29+
contact-management
30+
content-management
31+
crm
32+
customer-service-and-support
33+
data-analytics
34+
data-collection
35+
data-visualization
36+
digital-asset-management
37+
digital-citizenship
38+
document-management
39+
donor-management
40+
e-commerce
41+
e-signature
42+
email-management
43+
email-marketing
44+
employee-management
45+
enterprise-project-management
46+
enterprise-social-networking
47+
erp
48+
event-management
49+
facility-management
50+
feedback-and-reviews-management
51+
financial-reporting
52+
fleet-management
53+
fundraising
54+
gamification
55+
geographic-information-systems
56+
grant-management
57+
graphic-design
58+
help-desk
59+
hr
60+
ide
61+
identity-management
62+
instant-messaging
63+
inventory-management
64+
it-asset-management
65+
it-development
66+
it-management
67+
it-security
68+
it-service-management
69+
knowledge-management
70+
learning-management-system
71+
marketing
72+
mind-mapping
73+
mobile-marketing
74+
mobile-payment
75+
network-management
76+
office
77+
online-booking
78+
online-community
79+
payment-gateway
80+
payroll
81+
predictive-analysis
82+
procurement
83+
productivity-suite
84+
project-collaboration
85+
project-management
86+
property-management
87+
real-estate-management
88+
remote-support
89+
resource-management
90+
sales-management
91+
seo
92+
service-desk
93+
social-media-management
94+
survey
95+
talent-management
96+
task-management
97+
taxes-management
98+
test-management
99+
time-management
100+
time-tracking
101+
translation
102+
video-conferencing
103+
video-editing
104+
visitor-management
105+
voip
106+
warehouse-management
107+
web-collaboration
108+
web-conferencing
109+
website-builder
110+
workflow-management
111+
112+
====================================

docs/en/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Table of contents
3636
schema.rst
3737
country.rst
3838
forks.rst
39-
pa-types.rst
40-
tags.rst
39+
categories-list.rst
40+
scope-list.rst
4141
tools.rst
4242
example.rst

docs/en/pa-types.rst

Lines changed: 0 additions & 117 deletions
This file was deleted.

docs/en/schema.rst

Lines changed: 28 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -197,21 +197,18 @@ Use the predefined values if possible. If the software runs on a
197197
platform for which a predefined value is not available, a different
198198
value can be used.
199199

200-
Key ``tags``
201-
~~~~~~~~~~~~
200+
Key ``categories``
201+
~~~~~~~~~~~~~~~~~~
202202

203203
- Type: array of strings
204204
- Presence: mandatory
205-
- Acceptable values: see :ref:`tags-list`
205+
- Acceptable values: see :ref:`categories-list`
206206

207207
A list of words that can be used to describe the software and can help
208208
building catalogs of open software.
209209

210-
Each tag must be in Unicode lowercase, and should not contain any
211-
Unicode whitespace character. The suggested character to separate
212-
multiple words is ``-`` (single dash).
213-
214-
See also: ``description/[lang]/freeTags/``
210+
The controlled vocabulary :ref:`categories-list` contains the list of allowed
211+
values.
215212

216213
Key ``usedBy``
217214
~~~~~~~~~~~~~~
@@ -264,16 +261,22 @@ Key ``softwareType``
264261

265262
- Type: enumerated string
266263
- Presence: mandatory
267-
- Allowed values: ``standalone``, ``addon``, ``library``,
268-
``configurationFiles``
264+
- Allowed values: ``standalone/mobile``, ``standalone/iot``,
265+
``standalone/desktop``, ``standalone/web``, ``standalone/backend``,
266+
``standalone/other``, ``addon``, ``library``, ``configurationFiles``
269267

270268
The keys are:
271269

272-
- ``standalone`` - The software is a standalone, self-contained
273-
package. Most software will be of this type. Part of this category is
274-
software that can run on a desktop computer (e.g. as an executable),
275-
as a cloud-based application, as a network service or even as a set
276-
of cloud services or microservices.
270+
- ``standalone/mobile`` - The software is a standalone, self-contained
271+
The software is a native mobile app.
272+
- ``standalone/iot`` - The software is suitable for an IoT context.
273+
- ``standalone/desktop`` - The software is typically installed and run in a
274+
a desktop operating system environment.
275+
- ``standalone/web`` - The software represents a web application usable by
276+
means of a browser.
277+
- ``standalone/backend`` - The software is a backend application.
278+
- ``standalone/other`` - The software has a different nature from the once
279+
listed above.
277280
- ``softwareAddon`` - The software is an addon, such as a plugin or a
278281
theme, for a more complex software (e.g. a CMS or an office suite).
279282
- ``library`` - The software contains a library or an SDK to make it
@@ -287,27 +290,6 @@ The keys are:
287290
Section ``intendedAudience``
288291
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
289292

290-
Key ``intendedAudience/onlyFor``
291-
''''''''''''''''''''''''''''''''
292-
293-
- Type: enumerated string or array of strings
294-
- Presence: optional
295-
- Values: see :ref:`pa-types`
296-
- Example: ``"city"``
297-
298-
Public software could be very specific in scope because there is a large
299-
set of tasks that are specific to each type of administration. For
300-
instance, many softwares that are used in schools are probably not
301-
useful in hospitals. If you want to explicitly mark some software as
302-
only useful to certain types of administrations, you should add them to
303-
this key.
304-
305-
The list of allowed values is defined in :ref:`pa-types`,
306-
and can be country-specific.
307-
308-
This list can evolve at any time, separately from the version of this
309-
specification.
310-
311293
Key ``intendedAudience/countries``
312294
''''''''''''''''''''''''''''''''''
313295

@@ -330,6 +312,16 @@ case if there is a conflict between how software is working and a
330312
specific law, process or technology. All countries are specified using
331313
lowercase ISO 3166-1 alpha-2 two-letter country codes.
332314

315+
Key ``intendedAudience/scope``
316+
''''''''''''''''''''''''''''''
317+
318+
- Type: array of strings
319+
- Presence: optional
320+
- Acceptable values: see :ref:`scope-list`
321+
322+
This key contains a list of tags related to the field of application of
323+
the software.
324+
333325
Section ``description``
334326
~~~~~~~~~~~~~~~~~~~~~~~
335327

@@ -465,22 +457,6 @@ Whichever the format for the documentation, remember to make its source
465457
files available under an open license, possibly by committing them as
466458
part of the repository itself.
467459

468-
Key ``description/[lang]/freeTags/``
469-
''''''''''''''''''''''''''''''''''''
470-
471-
- Type: array of strings
472-
- Presence: optional
473-
474-
This key contains a list of free tags that can be applied to a software.
475-
476-
Since they contain values that do not have an official translation, and
477-
as such only make sense to a human in a specific language, tags are
478-
written in a specific language.
479-
480-
Each tag must be in Unicode lowercase, and should not contain any
481-
Unicode whitespace character. The suggested character to separate
482-
multiple words is ``-`` (single dash).
483-
484460
Key ``description/[lang]/features``
485461
'''''''''''''''''''''''''''''''''''
486462

0 commit comments

Comments
 (0)