Changeset 201 for trunk/project-meta/project-meta

Timestamp:

Apr 28, 2018, 1:21:43 PM (6 years ago)

Author:

g7moreau

Message:

• Add many link in the doc and change licence to license (beginning)

File:

• trunk/project-meta/project-meta (modified) (15 diffs)

trunk/project-meta/project-meta

@@ -32 +32 @@
    'make-zip'        => \&cmd_make_zip,
    'make-author'     => \&cmd_make_author,
-   'make-licence'    => \&cmd_make_licence,
+   'make-license'    => \&cmd_make_license,
    'make-copyright'  => \&cmd_make_copyright,
-   'list-licence'    => \&cmd_list_licence,
+   'list-license'    => \&cmd_list_license,
    );
 
@@ -90 +90 @@
  project-meta remove-link
  project-meta make-zip
- project-meta list-licence
- project-meta make-licence
+ project-meta list-license
+ project-meta make-license
  project-meta make-author
  project-meta make-copyright
@@ -128 +128 @@
    my $data_set    = $meta->{'public-dap'}{'data-set'};
 
-   push @{$data_set}, 'AUTHORS.txt', 'COPYRIGHT.txt', 'LICENCE.txt';
+   push @{$data_set}, 'AUTHORS.txt', 'COPYRIGHT.txt', 'LICENSE.txt';
    {
       # Remove doublon
@@ -187 +187 @@
    my $acronym     = $meta->{'project'}{'acronym'};
 
-   push @{$data_set}, 'AUTHORS.txt', 'COPYRIGHT.txt', 'LICENCE.txt';
+   push @{$data_set}, 'AUTHORS.txt', 'COPYRIGHT.txt', 'LICENSE.txt';
    {
       # Remove doublon
@@ -266 +266 @@
 ################################################################
 
-sub cmd_make_licence {
-   my $meta = YAML::Syck::LoadFile("PROJECT-META.yml");
-
-   my $current_dir = Cwd::getcwd();
-
-   if (-f "$current_dir/LICENCE.txt") {
-      print "Warning: LICENCE.txt already exists\n";
+sub cmd_make_license {
+   my $meta = YAML::Syck::LoadFile("PROJECT-META.yml");
+
+   my $current_dir = Cwd::getcwd();
+
+   if (-f "$current_dir/LICENSE.txt") {
+      print "Warning: LICENSE.txt already exists\n";
       return;
       }
 
-   my $licence = $meta->{'public-dap'}{'data-licence'};
-
-   if (not -f "/usr/share/project-meta/licence.d/$licence.txt") {
-      print "Error: licence $licence doesn't exists in project-meta database\n";
+   my $license = $meta->{'public-dap'}{'data-license'};
+
+   if (not -f "/usr/share/project-meta/license.d/$license.txt") {
+      print "Error: license $license doesn't exists in project-meta database\n";
       exit 1;
       }
 
-   copy("/usr/share/project-meta/licence.d/$licence.txt", "$current_dir/LICENCE.txt")
-      or die "Error: licence copy failed - $!";
-
-   print "Info: LICENCE.txt file create\n";
+   copy("/usr/share/project-meta/license.d/$license.txt", "$current_dir/LICENSE.txt")
+      or die "Error: license copy failed - $!";
+
+   print "Info: LICENSE.txt file create\n";
    return;
    }
@@ -326 +326 @@
          authorlist  => $meta->{'project'}{'authors'},
          description => $meta->{'project'}{'short-description'},
-         licence     => $meta->{'public-dap'}{'data-licence'},
+         license     => $meta->{'public-dap'}{'data-license'},
          doi         => $meta->{'publication'}{'doi'},
       }, \$msg_format) || die $tt->error;
@@ -337 +337 @@
 ################################################################
 
-sub cmd_list_licence {
-   opendir my $dh, '/usr/share/project-meta/licence.d/' or die $!;
-   for my $licence (readdir $dh) {
+sub cmd_list_license {
+   opendir my $dh, '/usr/share/project-meta/license.d/' or die $!;
+   for my $license (readdir $dh) {
       # Keep only file
-      next if not -f "/usr/share/project-meta/licence.d/$licence";
+      next if not -f "/usr/share/project-meta/license.d/$license";
       
       # Keep only .txt file
-      next if not $licence =~ m/\.txt$/;
-
-      $licence =~ s/\.txt$//;
-      print "$licence\n";
+      next if not $license =~ m/\.txt$/;
+
+      $license =~ s/\.txt$//;
+      print "$license\n";
       }
    closedir $dh;
@@ -371 +371 @@
  project-meta remove-link
  project-meta make-zip
- project-meta list-licence
- project-meta make-licence
+ project-meta list-license
+ project-meta make-license
  project-meta make-author
  project-meta make-copyright
@@ -408 +408 @@
 
 Create UNIX soft links on the OpeNDAP folder to the real data.
-Files F<AUTHORS.txt>, F<LICENCE.txt> and F<COPYRIGHT.txt> are mandatory but could be generated (see below).
+Files F<AUTHORS.txt>, F<LICENSE.txt> and F<COPYRIGHT.txt> are mandatory but could be generated (see below).
 The main keys use in the F<PROJECT-META.yml> are:
 
@@ -443 +443 @@
 
 Create a ZIP archive with the open data set.
-Files F<AUTHORS.txt>, F<LICENCE.txt> and F<COPYRIGHT.txt> are mandatory but could be generated (see below).
+Files F<AUTHORS.txt>, F<LICENSE.txt> and F<COPYRIGHT.txt> are mandatory but could be generated (see below).
 The main keys use in the F<PROJECT-META.yml> are:
 
@@ -454 +454 @@
 =back
 
-=head2 list-licence
-
- project-meta list-licence
-
-Give the list of all the open data licence supported by the project-meta licence database.
-At this time the possible licence are:
+=head2 list-license
+
+ project-meta list-license
+
+Give the list of all the open data license supported by the project-meta license database.
+At this time the possible license are:
 
  license-ouverte-v2.0
  open-database-license-v1.0
 
-Note that these licences are dedicated to open data.
-Please do not use open licence that have been written for code or documentation for data.
-
-=head2 make-licence
-
- project-meta make-licence
-
-Copy the licence file from the project-meta licence database at the current folder
-with the file name: F<LICENCE.txt>.
-
-The licence is defined in the F<PROJECT-META.yml> specification under the key C<public-dap/data-licence>.
-The list of possible licence is given with the command L</list-licence>.
+Note that these licenses are dedicated to open data.
+Please do not use an open license that would have been thought for source code or documentation and not for open data.
+
+=head2 make-license
+
+ project-meta make-license
+
+Copy the license file from the project-meta license database at the current folder
+with the file name: F<LICENSE.txt>.
+
+The license is defined in the F<PROJECT-META.yml> specification under the key C<public-dap/data-license>.
+The list of possible license is given with the command L</list-license>.
 
 =head2 make-author
@@ -489 +489 @@
 
 Create or update the F<COPYRIGHT.txt> file at the current folder.
-Authors, licence and copyright data are extracted from the C<PROJECT-META.yml> file.
+Authors, license and copyright data are extracted from the C<PROJECT-META.yml> file.
 
 
@@ -508 +508 @@
 =head1 SEE ALSO
 
-yamllint(1), ysh(1)
-
-In Debian, package for C<yamllint> and C<ysh> are
+yamllint(1), ysh(1), YAML, Archive::Zip
+
+In Debian GNU/Linux distribution, packages for C<yamllint> and C<ysh> are:
 
 =over
@@ -517 +517 @@
 
 =item * C<libyaml-shell-perl> - YAML test shell (Perl)
+
+=back
+
+
+Own project ressources:
+
+=over
+
+=item * L<Web site|http://servforge.legi.grenoble-inp.fr/projects/soft-trokata/wiki/SoftWare/ProjectMeta>
+
+=item * L<Online Manual|http://servforge.legi.grenoble-inp.fr/pub/soft-trokata/project-meta/project-meta.html>
+
+=item * L<SVN repository|http://servforge.legi.grenoble-inp.fr/svn/soft-trokata/trunk/project-meta>
 
 =back
@@ -539 +552 @@
 =head1 LICENSE AND COPYRIGHT
 
-Licence GNU GPL version 2 or later and Perl equivalent
+License GNU GPL version 2 or later and Perl equivalent
 
 Copyright (C) 2017-2018 Gabriel Moreau <Gabriel.Moreau(A)univ-grenoble-alpes.fr>.