diff --git a/bin/changelog-generator b/bin/changelog-generator new file mode 100755 index 0000000..eea944b --- /dev/null +++ b/bin/changelog-generator @@ -0,0 +1,102 @@ +#!/bin/sh + +usage() { + printf "Usage: %s [-h] -f /path/to/CHANGELOG.md\n" "$0" +} + +help() { + cat << EOH + SYNOPSIS + $0 [-h] -f /path/to/CHANGELOG.md + + DESCRIPTION + + $0 generates a markdown content of a changelog file. + + OPTIONS + + -h Show this help + + -f FILE + Path to changelog +EOH +} + +on_interrupt() { + print "Process aborted!\n" + + exit 130 +} + +main() { + while getopts "hf:" option; do + case "${option}" in + h) help; exit 0;; + f) CHANGELOG_FILE="$OPTARG";; + *) usage; exit 1;; + esac + done + + if [ -z "$CHANGELOG_FILE" ]; then + printf "The file of the changelog is required.\n" + exit 1 + fi + + if [ ! -f "$CHANGELOG_FILE" ]; then + printf "No such file: %s\n" "$CHANGELOG_FILE" + exit 1 + fi + + temp_directory="$(mktemp -d)" + version= + is_first=1 + + cat << EOF +--- +hide: + - navigation + - toc +--- + +EOF + +# Changelog" + + while read -r line; do + if printf "%s" "$line" | grep -q -E '^## '; then + version="$(printf "%s" "$line" | sed 's/^## //')" + + if [ "$version" = "[Unreleased]" ]; then + version="" + fi + elif [ -n "$version" ]; then + printf "%s\n" "$line" >> "$temp_directory/$version" + fi + done < "$CHANGELOG_FILE" + + while read -r line; do + if printf "%s" "$line" | grep -q -E '^## '; then + version="$(printf "%s" "$line" | sed 's/^## //')" + + if [ "$version" != "[Unreleased]" ]; then + if [ $is_first -eq 1 ]; then + printf "???+ success \"%s\"\n" "$version" + is_first=0 + else + printf "??? abstract \"%s\"\n" "$version" + fi + + sed \ + -e 's/### \(.*\)/\n **\1**\n/g' \ + -e 's/^/ /g' \ + "$temp_directory/$version" + fi + fi + done < "$CHANGELOG_FILE" + + exit 0 +} + +trap on_interrupt INT + +main "$@" diff --git a/docs/changelog.md b/docs/changelog.md new file mode 100644 index 0000000..80584dc --- /dev/null +++ b/docs/changelog.md @@ -0,0 +1,683 @@ +--- +hide: + - navigation + - toc +--- + +???+ success "3.5.2" + + **Fixed** + + * add check if menu exists before adding event listeners (#210) + +??? abstract "3.5.1" + + **Added** + + * add translations (thanks to p-bo adn gallegonovato) + + **Fixed** + + * fix #189: sorting not applied on mobile + +??? abstract "3.5.0" + + **Added** + + * add dependency check (ci) + * add code quality check (ci) + * add translations (thanks to gallegonovato) + * add option to disable the display labels in the top menu (#194) + + **Fixed** + + * fix missing img alt (settings image) + * fix code quality alerts + +??? abstract "3.4.1" + + **Added** + + * add translations (thanks to zonorti, jorisvandijk, jak2k) + + **Fixed** + + * fix #183: hide custom categories list when empty (admin page) + +??? abstract "3.4.0" + + **Added** + + * add translations (thanks to Pavelb, nier, Timur, p-bo) + * add possibility to define Custom Menu as default app and redirect to the first top menu app (#177) + +??? abstract "3.3.2" + + **Fixed** + + * fix #173: reduce the height of categories list + +??? abstract "3.3.1" + + **Fixed** + + * fix #162: top and side apps does work correctly + +??? abstract "3.3.0" + + **Added** + + * add documentation in admin page + * add app sorter in user config side (#160) + + **Fixed** + + * fix #164: open apps in new tab does not work + * fix #162 #159: top and side apps does work correctly + +??? abstract "3.2.1" + + **Fixed** + + * fix #150: active app is not visible has active in menu (except in default menu) + * fix #151: opener position + +??? abstract "3.2.0" + + **Added** + + * use custom app names using 'app.navigation.name' (#148) + * app sorting with all displays (#147) + +??? abstract "3.1.0" + + **Added** + + * add global custom app sorting for the top menu + + **Fixed** + + * fix admin list/modal look + +??? abstract "3.0.1" + + **Fixed** + + * Remove the gap between the window's top and menu categories (large menu) + +??? abstract "3.0.0" + + **Added** + + * Add compatibility with NC25 (#136/#135) + + **Removed** + + * Nextcloud 20-24 are not supported anymore + * AppOrder is not supported anymore + +??? abstract "2.5.1" + + **Fixed** + + * fix icon render (#133) + +??? abstract "2.5.0" + + **Changed** + + * upgrade dependencies + + **Fixed** + + * remove duplicated code + * remove unused variables and packages + * replace repeated strings with variables + * add html attributes + * replace var with let + * replace v-html with v-text to prevent xss + +??? abstract "2.4.3" + + **Fixed** + + * fix translations + +??? abstract "2.4.2" + + **Fixed** + + * fix typo + + **Changed** + + * change ci/cd + +??? abstract "2.4.1" + + **Fixed** + + * fix user setting save + +??? abstract "2.4.0" + + **Added** + + * remove focus on opener after click + * add button to set default colors + * add menu hover effect + * add translations + + **Fixed** + + * fix deprecated app.php file + * fix menu with categories header + * fix minor issues + + **Changed** + + * change saving progression + + **Removed** + + * Nextcloud 19 is not supported anymore + * PHP 7.3 is not supported anymore + +??? abstract "2.3.5" + + **Fixed** + + * fix white square (#99) + +??? abstract "2.3.4" + + **Fixed** + + * fix blank line when settings are open (#96) + +??? abstract "2.3.3" + + **Added** + + * hide the scrollbar when mouse is out (menu always displayed) + + **Fixed** + + * fix SQL Exception InvalidFieldNameException (#93) + +??? abstract "2.3.2" + + **Fixed** + + - fix hidden menu + +??? abstract "2.3.1" + + **Fixed** + + - fix #88: does not work with default menu + +??? abstract "2.3.0" + + **Added** + + - fix #82: add an option to keep visible an app in both menus + - fix #83: add custom categories + - add auto-reload when settings are saved + +??? abstract "2.2.0" + + **Added** + + - fix #84: update icons + - fix #85: use Nextcloud colors by default + + + **Fixed** + + - fix categories order in large menu + +??? abstract "2.1.0" + + **Added** + + - add compatibility with Nextcloud 23 + +??? abstract "2.0.1" + + **Fixed** + + - fix #78: Top menu is broken - invisible apps are shown + - fix #77: Update personal settings - HTTP error 412 (Precondition Failed) + - fix js error on the personal settings page (undefined sortable) + +??? abstract "2.0.0" + + **Fixed** + + - fix #66: removing usage of setInterval + - fix #73: icon background + + **Changed** + + - fix #67: replace jQuery with Vanilla JS + + **Removed** + + - Nextcloud 18 is not supported anymore + +??? abstract "1.28.0" + + **Added** + + - fix #63: add a new side menu with categories + +??? abstract "1.27.2" + + **Fixed** + + - fix #62: hide app notification icon + +??? abstract "1.27.1" + + **Fixed** + + - fix German translation render + +??? abstract "1.27.0" + + **Added** + + - hide personal settings access when settings are forced by the administrator + + **Fixed** + + - improve German translations + +??? abstract "1.26.0" + + **Added** + + - add Czech translation + +??? abstract "1.25.2" + + **Fixed** + + - fix CHANGELOG + +??? abstract "1.25.1" + + **Added** + + - add PHP version as dependency + - add chinese translation + + **Fixed** + + - fix CHANGELOG + +??? abstract "1.25.0" + + **Added** + + - add compatibility with Nextcloud 22 + - add CHANGELOG.md (fix #59) + - update app icon + +??? abstract "1.24.0" + + **Added** + + - add option to define the background opacity (fix #53) + - add missing translations + +??? abstract "1.23.1" + + **Fixed** + + - fix but wih dark mode opener option + +??? abstract "1.23.0" + + **Added** + + - add support of dark Theme and Breeze Dark + - add support of Nextcloud 21 + +??? abstract "1.22.2" + + **Fixed** + + - fix regression: apps does not open in new tab (fix #55) + +??? abstract "1.22.1" + + **Fixed** + + - fix regression: apps does not open in new tab + +??? abstract "1.22.0" + + **Added** + + - Add option to sort categories (fix #53) + - Update admin UI + +??? abstract "1.21.0" + + **Added** + + - [FEATURE] Logo in the menu links to main page of installation (#51) + +??? abstract "1.20.1" + + **Fixed** + + - Fix translations + +??? abstract "1.20.0" + + **Added** + + - [FEATURE] Ability to remove apps from the Big Menu (#49) + +??? abstract "1.19.1" + + **Fixed** + + - fix #47: setting for list/grid view in files app flashes and dissapears + +??? abstract "1.19.0" + + **Added** + + - add option: the menu is enabled by default for users (fix #46) + +??? abstract "1.18.0" + + **Added** + + - add option to show link to settings (fix #44) + - refactor menus using several components + +??? abstract "1.17.0" + + **Added** + + - compliance with the app checker + - add an action to export the configuration + - add an action to purge the cache + +??? abstract "1.16.3" + + **Fixed** + + - fix links that must be opened in new window (https://help.nextcloud.com/t/external-petit-probleme-concernant-lapplication-external-sites-ou-sites-externes/94884/11) + +??? abstract "1.16.2" + + **Fixed** + + - fix issue with personal settings when global settings are forced + +??? abstract "1.16.1" + + **Fixed** + + - fix #42: add cache to manage failures to access apps.nextcloud.com + - fix #41: side menu was hover apps list + +??? abstract "1.16.0" + + **Added** + + - add an option to force settings to users (fix #38) + +??? abstract "1.15.0" + + **Changed** + + - New name + + **Fixed** + + - Fix #36: always displayed is not expanding + +??? abstract "1.14.0" + + **Added** + + - add an api accessed by components + - add a config proxy in controllers + + **Fixed** + + - fix translations + +??? abstract "1.13.0" + + **Added** + + - add an option to display the avatar instead of the logo (fix #34) + +??? abstract "1.12.3" + + **Added** + + - add a delay before moving elements (fix #33) + +??? abstract "1.12.2" + + **Fixed** + + - fix #30: `Always displayed` menu can not be close using touchscreens + +??? abstract "1.12.1" + + **Fixed** + + - fix typo + - fix translations + +??? abstract "1.12.0" + + **Fixed** + + - fix #30: administrators and users can select what apps must be opened in new tab + - fix typo + +??? abstract "1.11.0" + + **Added** + + - add the option for opening apps in new tab (fix #29) + + **Fixed** + + - fix issue with the header of the always displayed menu + +??? abstract "1.10.0" + + **Added** + + - add images to select the display of the menu + - add live preview + - update translations + - update app info + +??? abstract "1.9.3" + + **Fixed** + + - fix regression with logo display + +??? abstract "1.9.2" + + **Added** + + - add the option “always displayed” which fixes the position of the menu to the left and always displays the application icons (fix #21, fix #2) + +??? abstract "1.8.6" + + **Added** + + - add translations: `fr` and `de` + - improve and publish the `Makefile` + - update documentation + +??? abstract "1.8.5" + + **Fixed** + + - fix #28: menu items invisible after 1.8.4 + +??? abstract "1.8.4" + + **Fixed** + + - fix #27: disable side menu on public pages - broken in 1.8.3 + +??? abstract "1.8.3" + + **Fixed** + + - fix alphabetic order of apps (#26) + +??? abstract "1.8.2" + + **Added** + + - add icon for closing the big menu (fix #25) + + **Fixed** + + - fix hidden icons in the top menu (fix #23) + - fix missing apps (fix #24) + +??? abstract "1.8.1" + + **Fixed** + + - fix issue with links + - fix missing l10n files + +??? abstract "1.8.0" + + **Added** + + - add a `big menu` display (fix #22) + - add the possibility to choose what apps are displayed in the top menu (fix #22) + - add icon color filter + - add icon opacity filter + +??? abstract "1.8.0-rc2" + +??? abstract "1.7.0" + + **Added** + + - add a loader when the page is unloading + - add compatibility with Nextcloud 19 + +??? abstract "1.6.3" + + **Fixed** + + - fix #20: add a shortcut to open and to hide the menu + +??? abstract "1.6.2" + + **Fixed** + + - fix #19: add a cache to limit flashes + +??? abstract "1.6.1" + + **Fixed** + + - fix #19: add a hack to show external sites in the top menu with navigation + +??? abstract "1.6.0" + + **Added** + + - Add a page of personal settings + - Add an option to disable the side menu as user + - Refactoring of javascripts + +??? abstract "1.5.0" + + **Added** + + - add option to force light icons instead of dark icons + + **Fixed** + + - fix #19: add option to keep external sites in the top menu + - fix #16 #17: add dark icons and handle the svg filters + +??? abstract "1.4.1" + + **Added** + + - Rendering harmonization with browsers + + **Fixed** + + - FIX #15: make menu start after icon + +??? abstract "1.4.0" + + **Fixed** + + - Fix #12: add an option to hide the opener and the panel when there is no application + +??? abstract "1.3.4" + + **Fixed** + + - FIX #14: add option to show only the opener + - FIX #13: add alternate hamburger icon + - FIX #11: remove error in the console + +??? abstract "1.3.3" + + **Added** + + - Add a second background color to create a background gradiant + - Update documentation + + **Fixed** + + - FIX #10: add options to select the size of the icons and the text, or hide them + +??? abstract "1.3.2" + + **Fixed** + + - FIX #9: opener icon not visible with multiple apps_paths + +??? abstract "1.3.1" + + **Fixed** + + - FIX #3: Add an opition the choose the position of the opener (after or before the logo) + - FIX #8: Remove extension of dynamic asset's routes (js, css) + +??? abstract "1.3.0" + + **Added** + + - `main.js` is replaced by a controller and a template + + **Fixed** + + - FIX #2: add option to open the menu by hovering over opener + +??? abstract "1.2.4" + + **Fixed** + + - FIX #7: Opener icon not visible in Safari + diff --git a/mkdocs.yml b/mkdocs.yml index edadcb7..bb5fdf1 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -22,6 +22,7 @@ theme: scheme: slate markdown_extensions: + - admonition - pymdownx.highlight: anchor_linenums: true extend_pygments_lang: @@ -36,6 +37,7 @@ markdown_extensions: - pymdownx.superfences - pymdownx.highlight - pymdownx.inlinehilite + - pymdownx.details nav: - Overview: index.md @@ -45,3 +47,4 @@ nav: - Tips: tips.md - Support: support.md - Contribute: contrib.md + - Changelog: changelog.md