Merge pull request #15 from PierreDillard/wiki-updates

Wiki updates

.gitignore

@@ -1,6 +1,8 @@
 .ignore/
 site/
 .venv/
+venv/
 __pycache__/
 site.*
 .DS_Store
+node_modules/

content-tagging-system.md

@@ -0,0 +1,137 @@
+
+
+# GPAC Wiki Content Tagging and Level Switch System
+
+## Overview
+
+The GPAC wiki implements a content tagging and level switch system to provide a customized reading experience for users with different levels of expertise. This system allows users to toggle between "Beginner" and "Expert" modes, affecting the visibility of content sections and keywords displayed.
+
+## Purpose
+
+The main goals of this system are:
+1. To help users new to GPAC access simpler, more approachable content.
+2. To provide more in-depth, technical content for experienced users.
+3. To create a dynamic reading experience that adapts to the user's knowledge level.
+
+## Implementation
+
+### Content Tagging
+
+
+Content tagging is implemented in Markdown files using the `attr_list` extension. Tags are applied to H1 headers (single `#` in Markdown) using the following syntax:
+
+```markdown
+# Section Title {: data-level="beginner" }
+```
+
+Available levels:
+- `beginner`: Content suitable for newcomers to GPAC.
+- If not specified: More advanced content (considered as expert level).
+
+### Level Switch
+
+The level switch is a toggle located in the "Settings" menu in the header of the user interface. It allows users to switch between "Beginner" and "Expert" modes.
+
+Default setting: The default level is set to "Expert", displaying all documentation.
+
+User preference storage: The selected level is stored in the browser's local storage, persisting between sessions.
+
+
+## Functionality
+
+### Content Visibility
+
+When switching between levels:
+
+. Expert mode:
+   - All sections are visible (in Howtos).
+   - The full Table of Contents (TOC) is displayed, including all sections and subsections.
+   - For filter options: all options are dispalyed.
+
+2. Beginner mode:
+   - Only sections tagged as "beginner" are visible (in Howtos).
+   - Sections not explicitly tagged as "beginner" disappear(in Howtos).
+   - For filter options: options with the attribute `id="vsize" data-level="basic"` will be visible in beginner mode.
+
+
+Example:
+
+![Beginner](docs/images/ex_beginner.png)
+
+Beginner mode: Only sections tagged as "beginner" are visible.
+
+![Expert](docs/images/ex_expert.png)
+
+Expert mode: All sections are visible.
+
+### Keywords Cloud
+
+The keywords cloud is dynamic and changes based on the selected level:
+
+- In Expert mode: All keywords are displayed.
+- In Beginner mode: Only keywords tagged as "beginner" or "all" are shown.
+
+Keywords are defined in the `data/keywords.json` file with the following structure:
+
+```json
+{
+  "KEYWORD": {
+    "description": "Keyword description",
+    "level": "beginner"
+  }
+}
+```
+
+When a user clicks on a keyword, a modal appears with the keyword's definition.
+
+## Implementation Details
+
+### Key Files
+
+- `javascripts/levels.js`: Main logic for level switching and content filtering.
+- `javascripts/domManipulation.js`: Handles DOM manipulation for showing/hiding content.
+
+### Howtos Section
+
+The level switching functionality is currently implemented only in the "Howtos" section of the documentation.
+
+
+## Developer Guidelines
+
+1. Tagging new content:
+   - Always tag H1 headers in Markdown files.
+   - Use the format: `# Title {: data-level="level" }` where `level` is "beginner".
+
+   - Untagged sections are considered "expert" by default.
+
+2. Adding new keywords:
+   - Add new keywords to the `data/keywords.json` file.
+   - Include a description and appropriate level tag.
+
+3. Testing:
+   - Test new content in both Beginner and Expert modes to ensure proper visibility.
+   - Verify that the TOC updates correctly when switching levels.
+   - Check that the keywords cloud updates appropriately.
+
+## Best Practices for Content Formatting
+
+When adding or editing content in the GPAC wiki, it's crucial to follow certain formatting practices to ensure readability and proper rendering of the documentation. One key aspect to pay attention to is the spacing between code blocks and other elements.
+
+### Spacing Between Code Blocks
+
+Always add a blank line between code blocks and surrounding text. This practice prevents rendering issues and improves readability.
+
+#### Good Practice:
+
+Example:
+
+![Code block formatting issue](docs/images/good_format.png)
+
+#### Bad Practice:
+
+Avoid this:
+Example:
+
+![Code block formatting issue](docs/images/bad_format.png)
+
+

docs/Build/Basic-Player-Application-using-GPAC.md

@@ -1,3 +1,21 @@
+---
+tags:
+- scene
+- source
+- input
+- media
+- data
+- stream
+- raw
+- output
+- frame
+- compositor
+- sink
+- dump
+---
+
+
+
 ## Objective
 
 This example shows a basic GPAC player application. It takes an URL as input and outputs it in a terminal.  

docs/Build/Build-Introduction.md

@@ -1,3 +1,10 @@
+---
+tags:
+- option
+---
+
+
+
 This section describes how to build GPAC from scratch and how to develop with it. 
 
 You can get pre-compiled binaries on [the GPAC website](https://gpac.io/downloads/gpac-nightly-builds/).

docs/Build/GPAC-build-MP4Box-only-all-platforms.md

@@ -1,13 +1,21 @@
+---
+tags:
+- option
+- data
+---
 
-## Build MP4Box with Visual Studio
+
+
+
+# Build MP4Box with Visual Studio {: data-level="all"}
 
 We published a minimal solution to build MP4Box.exe only, with zero dependency. No DLL to distribute.
 
 You need Visual Studio 2010 or more recent (a pop-up will ask you to upgrade your projects, just accept). Open [build/msvc10/gpac\_mp4box\_mini.sln](https://github.com/gpac/gpac/blob/master/build/msvc10/gpac_mp4box_mini.sln) and build (Debug or Release).
 
 That's all!
 
-## Build MP4Box with Make
+# Build MP4Box with Make
 
 On your system, you need the following tools installed on your system:
 
@@ -103,7 +111,7 @@ make -j4
 
 You can find more examples in [our TravisCI script](https://github.com/gpac/gpac/blob/master/.travis.yml).
 
-## Next Step
+# Next Step
 
 We have started [a multimedia component-level build system called Zenbuild](https://github.com/gpac/zenbuild). Zenbuild builds FFmpeg/libav, VLC or GPAC with most of their features enabled (librtmp, jack, openHEVC, etc.). You can start using Zenbuild, it is fully operational!
 

docs/Build/MP4-dmx-examples.md

@@ -1,3 +1,26 @@
+---
+tags:
+- mp4
+- source
+- sample
+- block
+- input
+- media
+- isomedia
+- segment
+- isobmff
+- data
+- stream
+- frame
+- buffer
+- box
+- rebuffer
+- dash
+- chunk
+---
+
+
+
 We have added to GPAC some sample applications demonstrating how to use GPAC to demux MP4 files. 
 
 They are not full applications, just examples taking some MP4 files as input and displaying some information about the media samples contained in the file. 

docs/Build/Upgrading.md

@@ -1,4 +1,13 @@
-# In source tree building
+---
+tags:
+- input
+- data
+- source
+---
+
+
+
+# In source tree building {: data-level="all" }
 If you build GPAC directly in the source tree (i.e., running `./configure && make` in the same directory as the configure script), the following steps must be done when upgrading your code base to a new version of GPAC, or when switching branches:
 
 - uninstall any previous version of GPAC (optional, the build system as of 1.0 is independent from the presence of any other version of libgpac headers on the system)

docs/Build/build/GPAC-Build-Guide-for-Android.md

@@ -1,12 +1,24 @@
-The Android build is a bit complicated. The method described here is the one used for the official Android builds. It is fairly rigid, with some hard-coded paths and versions. It should not be too hard to adapt it to one's own set up, but there is no guarantee that it will work as is on (for example) more recent versions of the ndk/sdk. 
+---
+tags:
+- input
+- data
+- source
+- link
+---
 
-It was tested on Ubuntu 14 to 18. 
 
-The process has three main steps: set up the build environment, cross-compile the dependencies, build the GPAC apk. 
 
-In the following, we'll call the main working directory `<GPAC_ROOT_DIR>`.
+!!! note
+    The Android build is a bit complicated. The method described here is the one used for the official Android builds. It is fairly rigid, with some hard-coded paths and versions. It should not be too hard to adapt it to one's own setup, but there is no guarantee that it will work as is on (for example) more recent versions of the ndk/sdk. 
 
-# Set up the build toolchain
+    It was tested on Ubuntu 14 to 18. 
+
+    The process has three main steps: set up the build environment, cross-compile the dependencies, build the GPAC apk.
+
+    In the following, we'll call the main working directory `<GPAC_ROOT_DIR>`.
+
+
+# Set up the build toolchain {: data-level="all"}
 
 ## JVM and tools
 

docs/Build/build/GPAC-Build-Guide-for-Linux.md

@@ -1,12 +1,23 @@
-_Preliminary notes: the following instructions will be based on Ubuntu and Debian. It should be easily applicable to other distributions, the only changes should be name of the packages to be installed, and the package manager used._
+---
+tags:
+- option
+- data
+- binary
+---
+
+
+
+!!! note
+    Preliminary notes: the following instructions will be based on Ubuntu and Debian. It should be easily applicable to other distributions, the only changes should be the name of the packages to be installed, and the package manager used.
+
 
 GPAC is a modular piece of software which depends on third-party libraries. During the build process it will try to detect and leverage the installed third-party libraries on your system. Here are the instructions to:
 
  * build GPAC easily (recommended for most users) from what's available on your system,
  * build a minimal 'MP4Box' and 'gpac' (only contains GPAC core features like muxing and streaming),
  * build a complete GPAC by rebuilding all the dependencies manually.
 
-# General case for all builds
+# General case for all builds {: data-level="all" }
 
 ## Development tools
 
@@ -185,6 +196,7 @@ If you already have a gpac version installed, or if you have already built gpac
 <GPAC_ROOT_DIR>/gpac_public$ make uninstall
 <GPAC_ROOT_DIR>/gpac_public$ make distclean
 ```
+
 **before** running `./configure`. 
 
 ### Install for developers

docs/Build/build/GPAC-Build-Guide-for-MSYS-MinGW.md

@@ -1,6 +1,15 @@
-The following is the guide to build GPAC on Windows using MSYS2 and the MinGW gcc toolchain. It is a bit clunky and will probably only work on x64 and without cross-compilation.
+---
+tags:
+- input
+- data
+- source
+---
 
-# Setting up
+
+
+_The following is the guide to build GPAC on Windows using MSYS2 and the MinGW gcc toolchain. It is a bit clunky and will probably only work on x64 and without cross-compilation._
+
+# Setting up {: data-level="all"}
 
 ## MSYS
 

docs/Build/build/GPAC-Build-Guide-for-OSX.md

@@ -1,7 +1,16 @@
-Since the OSX build is essentially the same as the Linux build, this doc will be succinct. Please refer to the [Linux build guide](GPAC-Build-Guide-for-Linux) for further details. 
+---
+tags:
+- data
+- encode
+- encoder
+---
 
 
-# MP4Box only
+
+_Since the OSX build is essentially the same as the Linux build, this doc will be succinct. Please refer to the [Linux build guide](GPAC-Build-Guide-for-Linux) for further details._ 
+
+
+# MP4Box only {: data-level="all"}
 
 Same as Linux:
 

docs/Build/build/GPAC-Build-Guide-for-WASM.md

@@ -1,10 +1,23 @@
+---
+tags:
+- option
+- source
+- heif
+- data
+- frame
+---
+
+
+
 [**HOME**](Home) » [**Build**](Build-Introduction) » WASM
 
-This page describes how to build GPAC for WASM/Emscripten.
+_This page describes how to build GPAC for WASM/Emscripten._
+
+!!! note
+    You can check a live demo at [https://wasm.gpac.io](https://wasm.gpac.io).
 
-A live demo can be seen at [https://wasm.gpac.io](https://wasm.gpac.io)
 
-# (Recommended) Use Docker
+# (Recommended) Use Docker {: data-level="all"}
 
 The easiest way to build GPAC for WASM is to use the provided Dockerfile at `build/docker/wasm.Dockerfile` in the GPAC repository.