Skip to content

Latest commit

 

History

History
76 lines (64 loc) · 5.28 KB

REPO_STRUCTURE.md

File metadata and controls

76 lines (64 loc) · 5.28 KB

Structure of the main library of JClic projects

Projects are hosted in:
https://clic.xtec.cat/projects

Each project has a subdirectory in this root structure. For example, the "demo" project is located in:
https://clic.xtec.cat/projects/demo

Some projects can have subprojects. For example, the "cs18" module of the Andrómeda (codename "androcs") project resides in:
https://clic.xtec.cat/projects/androcs/cs18

The full list of projects is always here:
https://clic.xtec.cat/projects/projects.json

This list is an array of objects. The main fields of these objects are:

  • id: Numeric identifier of this project in the library.
  • path: The subirectory of the root repository where this project resides, as previously seen.
  • title: The main title of the project
  • author: The author or authors of this project, separed by comma.
  • date: The publication date, in format DD/MM/YY.
  • langCodes: An array of ISO-639 two-letter language codes.
  • levelCodes: An array of one or more tags from this list of possible values:
    • INF: Kindergarten (3-6)
    • PRI: Primary school (6-12)
    • SEC: Secondary school (12-16)
    • BTX: High school (16-18)
  • areaCodes: An array of one or more tags from this list of possible values:
    • lleng: Languages
    • mat: Mathematics
    • soc: Social sciences
    • exp: Experimental sciences
    • mus: Music
    • vip: Art & design
    • ef: Physical education
    • tec: Design & technology
    • div: Miscellaneous
  • mainFile: The main ".jclic" (XML) or ".jclic.json" file, used by JClic.js to launch this project. The path of this file is always relative to the location of the project.
  • cover: The cover image of this project, usually at 300 pixels width, in PNG or JPG format.
  • coverWebp: The same cover, in WebP format.
  • thumbnail: Small version of the cover image, usually at 100 pixels width.

This is a just a short version of the metadata of each project. The full metadata is located in a file named project.json, at the root of the project subdirectory. For example, for the "demo" project:
https://clic.xtec.cat/projects/demo/project.json

In addition to the fields described above, the "project.json" file contains this information:

  • meta_langs: List of ISO-639 language codes used in the metadata. They are usually Catalan (ca), Spanish (es) and English (en).
  • school: Name of the school where the project was created.
  • languages, areas and levels: Translation of the meaning of the langCodes, areaCodes and levelCodes fields into all metadata languages.
  • descriptors: Additional metadata tags separed by commas, also provided in all metadata languages.
  • descCodes: Arbitrary numeric codes used by the application, related to descriptors.
  • description: Main descriptions of this JClic project, in all metadata languages. This field may contain line breaks and HTML codes.
  • license: License of use granted by the authors of the project. It is usually of type Creative Commons BY-SA-NC.
  • relatedTo: Optional field with an array of other project paths related to this one.
  • zipFile and instFile: Files used by the original JClic Java app.
  • clicZoneId, clicZoneURL and clicZoneAppletURL: Optional fields related to the publication of this project on the old JClic site. Currently unused.
  • activities: Number of JClic activities included in this project.
  • mediaFiles: Number of images, sounds, videos and other media files used in this project.
  • totalSize: Total size of this project in bytes.
  • files: Comprehensive list of all files that are part of the project.

In addition to the project.json file, there is also another metadata file named all-words.txt. This file contains all the words that appear both in the activities and in the project description, separated by whitespaces. For example:
https://clic.xtec.cat/projects/demo/all-words.txt
WARNING: This file is encoded in UTF-8. You may see incorrect characters if you open it with a web browser, as it usually defaults to ISO-8859 encoding.

The complete list of all projects with all their fields, including the contents of the all-words.txt file, is available in this spreadsheet.

The main web page of the repository is available in three languages: Catalan (ca), Spanish (es) and English (en) at:
https://projectes.xtec.cat/clic/ca/repo
https://projectes.xtec.cat/clic/es/repo
https://projectes.xtec.cat/clic/en/repo

The URL of the page corresponding to each project is formed by adding ?prj=path to these URLs. For example, the "demo" project will be displayed at the URLs:
https://projectes.xtec.cat/clic/ca/repo/?prj=demo
https://projectes.xtec.cat/clic/es/repo/?prj=demo
https://projectes.xtec.cat/clic/en/repo/?prj=demo