do•doc (or dodoc) is a free and open-source documentation tool, initially designed for use in classrooms with children. It enables one to capture traces from an on-going experience for later reflections, reconstructions and creation of narratives. A physical device can be associated with the software to simplify usage, especially with young people. Two versions are available: the local app that can be installed for offline use, and the online webapp that can be accessed from any device connected to the Internet.
do•doc is created by a variety of people: pupils, teachers, trainers, makers, artists, etc. Anyone is welcome to contribute to its development, on Github or via the forum (contributions can be in English or French): https://forum.latelier-des-chercheurs.fr/
do•doc was initially created by l'Atelier des chercheurs (Sarah Garcin, Pauline Gourlet & Louis Eveillard).
More information:
- in English: https://latelier-des-chercheurs.fr/en/tools/dodoc
- en Français : https://latelier-des-chercheurs.fr/outils/dodoc
And on the forum (mainly in French but you can post in English):
https://forum.latelier-des-chercheurs.fr/
do•doc is free and open source. The code is licensed under AGPLv3, and the graphic assets (icons, pictograms, user interface) are under a CC-BY-SA license.
The font Luciole is licensed under the Creative Commons Attribution 4.0 and embedded with permission from Laurent Bourcellier and Jonathan Fabreguettes. The font Belle Allure is used with permission from Jean Boyault.
-
main --> default branch, latest stable version (currently v11), in Electron (offline app). See release page for Linux/Mac/Windows installers.
-
main-node --> latest stable version without Electron, to use on online servers.
-
main-dev --> fixes and small improvements on top of the current version, in Electron. Used for testing before merging changes to main.
-
main-dev-node --> fixes and small improvements on top of the current version, for servers. Used for testing before merging changes to - main-node.
-
next --> code for the next major version (v11), in Electron. Use at your own risks.
-
next-node --> code for the next major version, without Electron. Use at your own risks.
Note 1: on Ubuntu 22.04, you may need to install the dependency sharp 0.31.3 as the most recent version (0.33.5) is not compatible.
Note 2: bufferutil seems to be necessary specifically for intel macOS.
Download the latest release from the release page.
See https://forum.latelier-des-chercheurs.fr/t/installer-do-doc-en-mode-developpement/426
Everything is structured in folders/files, so as to mirror the content in the filesystem. No database is used, almost all the content are saved in the content folder (by default /Documents/dodoc_next).
Folders contain a meta.txt file and media files (images, videos, audios, 3D/stl, texts, or any other kind of files).
Default values are:
- $admins (Array, editable) list of admins paths
- $contributors (Array, editable) list of contributors paths
- $cover (Object, editable) if a meta_cover.jpeg is present in the root of the folder
- $preview (String, editable) if set, search for a meta filename in this folder and read it when reading folder (useful for advanced cover of this folder)
- $date_created (Date) when the folder was created
- $date_modified (Date) when the folder was last edited
- $files (Array) list of all the files in this folder (see Files below) (bypass with no_files=true to improve performance where files are not needed)
- $status (String, editable) determines whether the folder gets listed
- $public (Boolean, editable) if true, return that folder, its files, and its source medias even when request is not auth
- $password (String, editable, stored as hash) limit editing to users with password
- $path (String) path to folder, matches filesystem structure and URL
- $infos (Object) data gathered from the folder itself (only available when url is appended with ?detailed=true)
- size (Number) size in bytes
Custom values can be defined in the schema property in settings_base.json. Editable default values and all custom values can only be edited by an $admins.
Each file has default values and custom values as well. Default values are:
- $admins (Array, editable) list of admins paths (will be used to set file permissions in the future)
- $contributors (Array, editable) list of contributors paths (will be used to set file permissions in the future)
- $authors (Array, editable) list of authors paths (information only, not actually used server-side)
- $path (String) path to meta text file, matches filesystem structure and URL
- $date_created (Date) when the file was created
- $date_uploaded (Date) when the file was uploaded
- $date_modified (Date) when the file was last edited
- $media_filename (String, editable) name of the file
- $type (String, editable) type of media file among the following: _image, video, audio, stl, text, pdf, other_
- $status (String, editable) determines whether the file gets listed when getFiles is called by non-authors
- $origin (String, editable) used to indicate the origin of the media (capture page, upload, etc.)
- $optimized (Boolean, editable) used to indicate whether the media has been optimized or not
- $thumbs (object) list of possible media image thumbs
- $content (String, editable) text content of a file
- $credits (String, editable) Credits for media
- $location (Object, editable) GPS location for file
- $infos (object) data gathered from the file itself
- mtimems (Date) last modified time for media file
- duration (Number) for videos and audios
- width (Number) for images and videos
- height (Number) for images and videos
- ratio (Number) for images and videos
- size (Number) size in bytes
- gps (Object)
- hash (String) file hash (to find duplicates)
Custom values can be defined in the schema property in settings_base.json. Editable default values and all custom values can only be edited by an $admins.
Each folder and each file have a "$status" property, which defines who can read them using getFolders, getFolder, getFiles and getFile:
- by default, it is set to private: folder will only be listed by their respective authors and instance admins.
- otherwise, if set to anything else, they will be listed by anyone (loggedin or not, as long as they have access to dodoc)
If a folder has a $password, then this ressource and its content can only be edited by people that are logged in to this folder using its password.
If a folder has $admins, only people logged in with a token that matches one of these $admin path can edit/remove this folder's meta and its subfolders.
If a folder has $contributors, people logged in with a token that matches one of these $contributors can not edit this folder's meta but can create/edit/remove subfolders or import/edit/remove files.
If a folder has $contributors = "everyone", all users (including anonymous, non logged-in users) have contributors' permissions.
If a folder has $admins = "everyone", all users (including anonymous) have admins' permissions.
If a folder has $admins = "parent_contributors" then all parent's $contributors are admins to this folder. This is the same behaviour as files in that parent folder.
These permissions trickle down: an instance admin has admin rights to all the instance contents. A space admin has admin rights to all its projects. A project admin has admin rights to all its content (medias, stopmotions, publications).
An instance contributor, though, only has contributors rights to the direct content it contains. For instance, a contributor to a space can create a project, but not remove a project he/she is not an $admin of.
If a folder type schema has the property $can_be_created_by: "everyone", this overrides the above behaviour and such folder can be created by all users even those that are not logged in. This is useful for accounts creation.
If a folder has $can_be_remixed = true, it can be remixed: duplicated somewhere else to the same level. When it is remixed, the path to the new folder gets appended to the array $list_of_remixes and the remix folder gets a $is_remix_of string.
The path to a ressource is decomposed like this:
/type-of-ressource/name-of-ressource/type-of-child-ressource/name-of-child-ressource
For example, with the following schema:
{
"schema": {
"$folders": {
"spaces": {
"$cover": {
"width": 1200,
"height": 1200,
"thumbs": {
"resolutions": [50, 320, 640, 1200]
}
},
"fields": {
"title": {
"type": "string"
}
},
"$folders": {
"projects": {
"$cover": {
"width": 2000,
"height": 2000,
"thumbs": {
"resolutions": [50, 320, 640, 2000]
}
},
"fields": {
"title": {
"type": "string",
"unique": true
}
},
"$folders": {
"publications": {
"$cover": {
"width": 1200,
"height": 1200,
"thumbs": {
"resolutions": [50, 320, 640, 1200]
}
},
"fields": {
"title": {
"type": "string"
}
}
}
}
}
}
}
}
}
}
Then the following routes will redirect to:
-
/spaces --> returns a list of all folders in /spaces with their metas
-
/spaces/bonjour --> returns the meta of a single "bonjour" folder with a list of all their files with their metas
-
/spaces/bonjour/projects --> returns a list of all folders in /spaces/bonjour/projects with their metas
-
/spaces/bonjour/projects/elephant-with-plywood --> returns the meta of a single "elephant-with-plywood" folder with a list of all their files with their metas
-
/spaces/bonjour/projects/elephant-with-plywood.zip --> downloads a zip file with all the content of that folder
For an existing folder:
Role | Edit | Upload file | Create subfolder | Export | Copy | Download | GeneratePreview |
-------------------------------------------------------------------------------------------------------------
Instance admins | x | x | x | x | x | x | x |
Folder $admins | x | x | x | x | x | x | x |
Folder $contributors | | x | x | | | | |
-------------------------------------------------------------------------------------------------------------
So, for example for a space /bonjour, its $admins can edit all meta properties while a contributor can only import/edit/remove files, and create projects (of which they'll be $admins by default).
Data stored in the LocalStorage (similar to cookies) :
- sessionID: random identifier to persist connection
- general_password: access password for dodoc if set for that instance, and if "remember" is checked
- tokenpath: login identifier, to reconnect to a logged in account when the page is refreshed
- selected_devices: selected video/audio devices in Capture page
- location_to_add_to_medias: coordinates picked to add to captured media
- fontLastUsed: last font used in a text block
- language: lang picked by user if it was changed from the default (browser or OS langage)
- translations_to_share: when using the translation helper, translations entered by a user
- show_meta_sidebar: show/hide the information sidebar when opening the modal for a media in Collect
- library_tile_mode: last used media preview mode in Collect
- page_settings: for each publication, remember grid options (show/hide, snap, gridstep)