CodeMirror/fantasia-archive
1
0
Fork 0
mirror of https://github.com/Elvanos/fantasia-archive.git synced 2024-05-03 11:53:30 +12:00
Code Issues Projects Releases Wiki Activity

mega update: dialogs, translations, colors, etc.

Browse source
This commit is contained in:
Elvanos 2023-10-14 16:41:36 +02:00
parent d56819ddd5
commit 8320a73f75
42 changed files with 3161 additions and 186 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
.eslintrc.cjs
View file

@ -103,5 +103,6 @@ module.exports = {
"object-shorthand": "off",
"quote-props": "off",
camelcase: "off",
"@typescript-eslint/no-explicit-any": ["error", { ignoreRestArgs: true }],
},
};

5
.vscode/settings.json vendored
View file

@ -16,5 +16,8 @@
"[javascript]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"todo-tree.tree.scanMode": "workspace"
"todo-tree.tree.scanMode": "workspace",
"[vue]": {
"editor.defaultFormatter": "dbaeumer.vscode-eslint"
}
}

10
interfaces/I_appMenusDataList.ts
View file

@ -27,7 +27,12 @@ export interface I_appMenusDataList {
/**
* Trigger functionality of the item on click
*/
trigger?: (() => unknown)
trigger?: ((...args: any[]) => unknown|void)
/**
* Extra arguments for the trigger if need be
*/
triggerArguments?: unknown[]
/**
* Conditions to show the menu item as active
@ -46,7 +51,8 @@ export interface I_appMenusDataList {
mode: 'separator' | 'item'
text?: string
icon?: string
trigger?: (() => unknown)
trigger?: ((...args: any[]) => unknown|void)
triggerArguments?: []
conditions?: boolean
specialColor?: string
}[]

15
interfaces/I_faExternalLinksManagerAPI.ts Normal file
View file

@ -0,0 +1,15 @@
export interface I_faExternalLinksManagerAPI {
/**
* Check the type of link input
* true - Is external
* false - is not external
*/
checkIfExternal: (url: string) => boolean
/**
* Open external link in the default browser of the user
*/
openExternal: (url: string) => void
}

1
interfaces/T_documentList.ts Normal file
View file

@ -0,0 +1 @@
export type T_documentList = 'advancedSearchCheatSheet'| 'advancedSearchGuide'| 'changeLog'| 'license'

9
package.json
View file

@ -22,6 +22,7 @@
"pinia": "^2.0.11",
"quasar": "^2.6.0",
"sqlite3": "^5.1.6",
"uuid": "^9.0.1",
"vue": "^3.0.0",
"vue-i18n": "^9.2.2",
"vue-router": "^4.0.0"
@ -30,9 +31,11 @@
"@intlify/vite-plugin-vue-i18n": "^3.3.1",
"@playwright/test": "^1.37.1",
"@quasar/app-vite": "^1.3.0",
"@quasar/quasar-app-extension-qmarkdown": "^2.0.0-beta.10",
"@quasar/quasar-app-extension-testing": "^2.1.0",
"@quasar/quasar-app-extension-testing-unit-vitest": "^0.1.0",
"@types/node": "^16.18.0",
"@types/uuid": "^9.0.5",
"@typescript-eslint/eslint-plugin": "^5.10.0",
"@typescript-eslint/parser": "^5.10.0",
"@vitest/ui": "^0.15.0",
@ -48,6 +51,12 @@
"eslint-plugin-vue": "^9.0.0",
"jsdom": "^22.1.0",
"playwright": "^1.37.1",
"postcss-html": "^1.5.0",
"sass": "^1.69.0",
"stylelint": "^15.10.3",
"stylelint-config-standard": "^34.0.0",
"stylelint-config-standard-scss": "^11.0.0",
"stylelint-config-standard-vue": "^1.0.0",
"typescript": "^4.5.4",
"vitest": "^0.15.0"
},

76
quasar.config.js
View file

@ -8,18 +8,18 @@
// Configuration for your app
// https://v2.quasar.dev/quasar-cli-vite/quasar-config-js
const { configure } = require("quasar/wrappers");
const path = require("path");
const { configure } = require('quasar/wrappers')
const path = require('path')
module.exports = configure(function (/* ctx */) {
return {
eslint: {
// fix: true,
fix: true,
// include: [],
// exclude: [],
// rawOptions: {},
warnings: true,
errors: true,
errors: true
},
// https://v2.quasar.dev/quasar-cli-vite/prefetch-feature
@ -28,33 +28,33 @@ module.exports = configure(function (/* ctx */) {
// app boot file (/src/boot)
// --> boot files are part of "main.js"
// https://v2.quasar.dev/quasar-cli-vite/boot-files
boot: ["i18n", "axios"],
boot: ['i18n', 'axios', 'externalLinkManager'],
// https://v2.quasar.dev/quasar-cli-vite/quasar-config-js#css
css: ["app.scss"],
css: ['app.scss'],
// https://github.com/quasarframework/quasar/tree/dev/extras
extras: [
// 'ionicons-v4',
"mdi-v5",
"fontawesome-v6",
'mdi-v5',
'fontawesome-v6',
// 'eva-icons',
// 'themify',
// 'line-awesome',
// 'roboto-font', // optional, you are not bound to it
"roboto-font-latin-ext", // this or either 'roboto-font', NEVER both!
"material-icons", // optional, you are not bound to it
'roboto-font-latin-ext', // this or either 'roboto-font', NEVER both!
'material-icons' // optional, you are not bound to it
],
// Full list of options: https://v2.quasar.dev/quasar-cli-vite/quasar-config-js#build
build: {
target: {
browser: ["es2019", "edge88", "firefox78", "chrome87", "safari13.1"],
node: "node16",
browser: ['es2019', 'edge88', 'firefox78', 'chrome87', 'safari13.1'],
node: 'node16'
},
vueRouterMode: "history", // available values: 'hash', 'history'
vueRouterMode: 'history', // available values: 'hash', 'history'
// vueRouterBase,
// vueDevtools,
// vueOptionsAPI: false,
@ -75,7 +75,7 @@ module.exports = configure(function (/* ctx */) {
vitePlugins: [
[
"@intlify/vite-plugin-vue-i18n",
'@intlify/vite-plugin-vue-i18n',
{
// if you want to use Vue I18n Legacy API, you need to set `compositionOnly: false`
// compositionOnly: false,
@ -85,23 +85,23 @@ module.exports = configure(function (/* ctx */) {
// runtimeOnly: false,
// you need to set i18n resource including paths !
include: path.resolve(__dirname, "./src/i18n/**"),
},
],
],
include: path.resolve(__dirname, './src/i18n/**')
}
]
]
},
// Full list of options: https://v2.quasar.dev/quasar-cli-vite/quasar-config-js#devServer
devServer: {
// https: true
open: true, // opens browser window automatically
open: true // opens browser window automatically
},
// https://v2.quasar.dev/quasar-cli-vite/quasar-config-js#framework
framework: {
config: {
ripple: false,
dark: true,
dark: true
},
// iconSet: 'material-icons', // Quasar icon set
@ -115,12 +115,12 @@ module.exports = configure(function (/* ctx */) {
// directives: [],
// Quasar plugins
plugins: ["Dialog"],
plugins: ['Dialog']
},
// animations: 'all', // --- includes all animations
// https://v2.quasar.dev/options/animations
animations: "all",
animations: 'all',
// https://v2.quasar.dev/quasar-cli-vite/quasar-config-js#sourcefiles
// sourceFiles: {
@ -151,17 +151,17 @@ module.exports = configure(function (/* ctx */) {
// (gets superseded if process.env.PORT is specified at runtime)
middlewares: [
"render", // keep this as last one
],
'render' // keep this as last one
]
},
// https://v2.quasar.dev/quasar-cli-vite/developing-pwa/configuring-pwa
pwa: {
workboxMode: "generateSW", // or 'injectManifest'
workboxMode: 'generateSW', // or 'injectManifest'
injectPwaMetaTags: true,
swFilename: "sw.js",
manifestFilename: "manifest.json",
useCredentialsForManifestTag: false,
swFilename: 'sw.js',
manifestFilename: 'manifest.json',
useCredentialsForManifestTag: false
// useFilenameHashes: true,
// extendGenerateSWOptions (cfg) {}
// extendInjectManifestOptions (cfg) {},
@ -176,7 +176,7 @@ module.exports = configure(function (/* ctx */) {
// Full list of options: https://v2.quasar.dev/quasar-cli-vite/developing-capacitor-apps/configuring-capacitor
capacitor: {
hideSplashscreen: true,
hideSplashscreen: true
},
// Full list of options: https://v2.quasar.dev/quasar-cli-vite/developing-electron-apps/configuring-electron
@ -186,7 +186,7 @@ module.exports = configure(function (/* ctx */) {
inspectPort: 5858,
bundler: "builder", // 'packager' or 'builder'
bundler: 'builder', // 'packager' or 'builder'
packager: {
// https://github.com/electron-userland/electron-packager/blob/master/docs/api.md#options
@ -202,19 +202,19 @@ module.exports = configure(function (/* ctx */) {
builder: {
// https://www.electron.build/configuration/configuration
appId: "fantasia-archive",
appId: 'fantasia-archive',
win: {
icon: "src-electron/icons/icon.ico",
},
},
icon: 'src-electron/icons/icon.ico'
}
}
},
// Full list of options: https://v2.quasar.dev/quasar-cli-vite/developing-browser-extensions/configuring-bex
bex: {
contentScripts: ["my-content-script"],
contentScripts: ['my-content-script']
// extendBexScriptsConf (esbuildConf) {}
// extendBexManifestJson (json) {}
},
};
});
}
}
})

5
quasar.extensions.json
View file

@ -10,5 +10,8 @@
"typescript",
"ui"
]
},
"@quasar/qmarkdown": {
"import_md": true
}
}
}

18
src-electron/customContentBridgeAPIs/faExternalLinksManagerAPI.ts Normal file
View file

@ -0,0 +1,18 @@
import { shell } from 'electron'
import { I_faExternalLinksManagerAPI } from 'app/interfaces/I_faExternalLinksManagerAPI'
export const faExternalLinksManagerAPI: I_faExternalLinksManagerAPI = {
checkIfExternal (url: string) {
return (
(url.includes('http://') || url.includes('https://')) &&
!url.includes('localhost')
)
},
openExternal (url: string) {
shell.openExternal(url)
}
}

2
src-electron/electron-preload.ts
View file

@ -33,7 +33,9 @@ import { contextBridge } from 'electron'
import { faWindowControlAPI } from 'src-electron/customContentBridgeAPIs/faWindowControlAPI'
import { extraEnvVariablesAPI } from 'src-electron/customContentBridgeAPIs/extraEnvVariablesAPI'
import { faDevToolsControlAPI } from 'src-electron/customContentBridgeAPIs/faDevToolsControlAPI'
import { faExternalLinksManagerAPI } from 'app/src-electron/customContentBridgeAPIs/faExternalLinksManagerAPI'
contextBridge.exposeInMainWorld('faWindowControlAPI', faWindowControlAPI)
contextBridge.exposeInMainWorld('faDevToolsControlAPI', faDevToolsControlAPI)
contextBridge.exposeInMainWorld('faExternalLinksManagerAPI', faExternalLinksManagerAPI)
contextBridge.exposeInMainWorld('extraEnvVariables', extraEnvVariablesAPI)

56
src/App.vue
View file

@ -2,41 +2,33 @@
<router-view />
</template>
<script lang="ts">
import { defineComponent } from 'vue'
<script lang="ts" setup>
import { useRouter } from 'vue-router'
export default defineComponent({
name: 'App',
/**
* Setup is used to determine if the app is running testing of some kind or in normal mode
*/
setup () {
/**
* Local router variable
*/
const router = useRouter()
/**
* Local router variable
*/
const router = useRouter()
/**
* Testing type currently possibly happening
* */
const testingType = window.extraEnvVariables.TEST_ENV
/**
* Testing type currently possibly happening
*/
const testingType = window.extraEnvVariables.TEST_ENV
/**
* Name of the component being possibly tested via component testing
* */
const testingComponentName = window.extraEnvVariables.COMPONENT_NAME
/**
* Name of the component being possibly tested via component testing
*/
const testingComponentName = window.extraEnvVariables.COMPONENT_NAME
/**
* In case of some testing happening:
* - Reroute to the proper component path route assuming all is properly set.
* - Otherwise, make sure we are on homepage on load.
*/
if (testingType && testingType === 'components' && testingComponentName) {
router.push({ path: `/componentTesting/${testingComponentName}` })
} else {
router.push({ path: '/' })
}
/**
* In case of some testing happening:
* - Reroute to the proper component path route assuming all is properly set.
* - Otherwise, make sure we are on homepage on load.
*/
if (testingType && testingType === 'components' && testingComponentName) {
router.push({ path: `/componentTesting/${testingComponentName}` })
} else {
router.push({ path: '/' })
}
}
})
</script>

41
src/boot/externalLinkManager.ts Normal file
View file

@ -0,0 +1,41 @@
import { boot } from 'quasar/wrappers'
export default boot(() => {
document.addEventListener('click', e => {
/**
* Target of the click event
*/
const clickTarget = e.target as HTMLAnchorElement
if (clickTarget) {
/**
* Closest anchor element
* Selector might end up being empty if the anchor itself was clicked. If so, select it instead
*/
let originLink: HTMLAnchorElement|null|false = clickTarget.closest('a')
if (originLink === null) {
originLink = (clickTarget.tagName === 'a') ? clickTarget : false
}
if (originLink) {
/**
* HREF link of the url
*/
const linkURL = originLink.href
/**
* Determines if the URL is extenal or not
*/
const isExternal = window.faExternalLinksManagerAPI.checkIfExternal(linkURL)
if (isExternal) {
/**
* If the URL is external, prevent default and open the URL via the electron API functionality
*/
e.preventDefault()
window.faExternalLinksManagerAPI.openExternal(linkURL)
}
}
}
})
})

1
src/boot/i18n.ts
View file

@ -26,6 +26,7 @@ export default boot(({ app }) => {
locale: 'en-US',
fallbackLocale: 'en-US',
legacy: false,
warnHtmlMessage: false,
messages
})

7
src/components/AppControlMenus/AppControlMenus.vue
View file

@ -15,6 +15,8 @@
<!-- Help & Info Menu-->
<AppControlSingleMenu :data-input="helpInfo" />
</q-btn-group>
<DialogMarkdownDocument />
</div>
</template>
@ -25,12 +27,13 @@ import { project } from 'app/src/components/AppControlMenus/_data/project'
import { tools } from 'app/src/components/AppControlMenus/_data/tools'
import { helpInfo } from 'app/src/components/AppControlMenus/_data/helpInfo'
import DialogMarkdownDocument from 'app/src/components/DialogMarkdownDocument/DialogMarkdownDocument.vue'
</script>
<style lang="scss" scoped>
.appControlMenus {
&__inner{
&__inner {
-webkit-app-region: no-drag;
}
}

36
src/components/AppControlMenus/AppControlSingleMenu/AppControlSingleMenu.vue
View file

@ -37,11 +37,18 @@
clickable
:class="['appControlSingleMenu__item', `text-${menuItem.specialColor}`, 'non-selectable']"
:disable="(!menuItem.conditions)"
@click="(menuItem.trigger) ? menuItem.trigger() : false"
@click="(menuItem.trigger)
? menuItem.triggerArguments
? menuItem.trigger(...menuItem.triggerArguments)
: menuItem.trigger()
: false"
>
<q-item-section>{{ menuItem.text }}</q-item-section>
<q-item-section avatar>
<q-icon :name="menuItem.icon" />
<q-icon
class="appControlSingleMenu__icon"
:name="menuItem.icon"
/>
</q-item-section>
<!-- Sub-menu-->
@ -53,6 +60,7 @@
dark
transition-show="jump-right"
transition-hide="jump-left"
class="-subMenu"
>
<q-list
class="appControlSingleMenu__list"
@ -77,7 +85,10 @@
>
<q-item-section>{{ submenuItem.text }}</q-item-section>
<q-item-section avatar>
<q-icon :name="submenuItem.icon" />
<q-icon
class="appControlSingleMenu__icon"
:name="submenuItem.icon"
/>
</q-item-section>
</q-item>
</template>
@ -108,23 +119,32 @@ const menuData = props.dataInput.data
<style lang="scss" scoped>
.appControlSingleMenu {
&:hover,
&:focus {
color: $appControlMenus_singleHover;
}
&__list{
&__icon {
font-size: $iconSize;
}
&__list {
background-color: $appControlMenus_bgColor;
color: $appControlMenus_color;
}
&__item{
&__item {
min-height: 42px;
&:hover{
&:hover,
&:focus {
color: $appControlMenus_singleHover;
}
}
&__separator{
&__separator {
background-color: $appControlMenus_separatorColor;
height: 0.5px !important;
}
}
</style>

10
src/components/AppControlMenus/_data/helpInfo.ts
View file

@ -4,6 +4,7 @@ import { I_appMenusDataList } from 'app/interfaces/I_appMenusDataList'
// TODO - add functionality for all buttons and conditions
import { toggleDevTools } from 'app/src/scripts/appInfo/toggleDevTools'
import { openDialogMarkdownDocument } from 'app/src/scripts/appInfo/openDialogMarkdownDocument'
export const helpInfo: I_appMenusDataList = {
title: i18n.global.t('AppControlMenus.helpInfo.title'),
@ -22,7 +23,8 @@ export const helpInfo: I_appMenusDataList = {
text: i18n.global.t('AppControlMenus.helpInfo.items.advancedSearchGuide'),
icon: 'mdi-file-question',
submenu: undefined,
trigger: undefined,
trigger: openDialogMarkdownDocument,
triggerArguments: ['advancedSearchGuide'],
conditions: true,
specialColor: undefined
},
@ -43,7 +45,8 @@ export const helpInfo: I_appMenusDataList = {
text: i18n.global.t('AppControlMenus.helpInfo.items.changelog'),
icon: 'mdi-clipboard-text',
submenu: undefined,
trigger: undefined,
trigger: openDialogMarkdownDocument,
triggerArguments: ['changeLog'],
conditions: true,
specialColor: undefined
},
@ -61,7 +64,8 @@ export const helpInfo: I_appMenusDataList = {
text: i18n.global.t('AppControlMenus.helpInfo.items.license'),
icon: 'mdi-script-text-outline',
submenu: undefined,
trigger: undefined,
trigger: openDialogMarkdownDocument,
triggerArguments: ['license'],
conditions: true,
specialColor: undefined
},

2
src/components/AppControlMenus/_data/project.ts
View file

@ -88,7 +88,7 @@ export const project: I_appMenusDataList = {
icon: 'keyboard_arrow_right',
trigger: undefined,
conditions: true,
specialColor: 'accent',
specialColor: 'grey',
submenu: [
{
mode: 'item',

110
src/components/DialogMarkdownDocument/DialogMarkdownDocument.playwright.test.ts Normal file
View file

@ -0,0 +1,110 @@
import { _electron as electron } from 'playwright'
import { test, expect } from '@playwright/test'
import { extraEnvVariablesAPI } from 'app/src-electron/customContentBridgeAPIs/extraEnvVariablesAPI'
/**
* Extra env settings to trigger component testing via Playwright
*/
const extraEnvSettings = {
TEST_ENV: 'components',
COMPONENT_NAME: 'DialogMarkdownDocument',
COMPONENT_PROPS: JSON.stringify({})
}
/**
* Electron main filepath
*/
const electronMainFilePath:string = extraEnvVariablesAPI.ELECTRON_MAIN_FILEPATH
/**
* Extra rended timer buffer for tests to start after loading the app
* - Change here in order manually adjust this component's wait times
*/
const faFrontendRenderTimer:number = extraEnvVariablesAPI.FA_FRONTEND_RENDER_TIMER
/**
* Object of string data selectors for the component
*/
const selectorList = {
image: 'fantasiaMascotImage-image'
}
/**
* Attempt to pass "width" prop to the component and check the result
*/
test('Visually check "width" prop', async () => {
const testString = '300px'
extraEnvSettings.COMPONENT_PROPS = JSON.stringify({ width: testString })
const electronApp = await electron.launch({
env: extraEnvSettings,
args: [electronMainFilePath]
})
const appWindow = await electronApp.firstWindow()
await appWindow.waitForTimeout(faFrontendRenderTimer)
const imageElement = await appWindow.$(`[data-test="${selectorList.image}"]`)
// Check if the tested element exists
if (imageElement !== null) {
const imageBoxData = await imageElement.boundingBox()
// Test if the tested element isn't invisisble for some reason
if (imageBoxData !== null) {
const roundedFirstValue = Math.round(imageBoxData.width)
const roundedSecondValue = Math.round(parseInt(testString))
expect(roundedFirstValue).toBe(roundedSecondValue)
} else {
// Element is invisible
test.fail()
}
} else {
// Element doesn't exist
test.fail()
}
await electronApp.close()
})
/**
* Attempt to pass "height" prop to the component and check the result
*/
test('Visually check "height" prop', async () => {
const testString = '300px'
extraEnvSettings.COMPONENT_PROPS = JSON.stringify({ height: testString })
const electronApp = await electron.launch({
env: extraEnvSettings,
args: [electronMainFilePath]
})
const appWindow = await electronApp.firstWindow()
await appWindow.waitForTimeout(faFrontendRenderTimer)
const imageElement = await appWindow.$(`[data-test="${selectorList.image}"]`)
// Check if the tested element exists
if (imageElement !== null) {
const imageBoxData = await imageElement.boundingBox()
// Test if the tested element isn't invisisble for some reason
if (imageBoxData !== null) {
const roundedFirstValue = Math.round(imageBoxData.height)
const roundedSecondValue = Math.round(parseInt(testString))
expect(roundedFirstValue).toBe(roundedSecondValue)
} else {
// Element is invisible
test.fail()
}
} else {
// Element doesn't exist
test.fail()
}
await electronApp.close()
})

90
src/components/DialogMarkdownDocument/DialogMarkdownDocument.vitest.test.ts Normal file
View file

@ -0,0 +1,90 @@
import { installQuasar } from '@quasar/quasar-app-extension-testing-unit-vitest'
import { mount } from '@vue/test-utils'
import { describe, expect, it } from 'vitest'
import FantasiaMascotImage from './DialogMarkdownDocument.vue'
installQuasar()
describe('Component - "DialogMarkdownDocument"', () => {
/**
* Object of string data selectors for the component
*/
const selectorList = {
image: 'fantasiaMascotImage-image'
}
/**
* Test if the component has an "img" HTML element properly mounted in it.
*/
it('Wrapper should contain an image', () => {
const wrapper = mount(FantasiaMascotImage)
const imageElement = wrapper.get(`[data-test="${selectorList.image}"]`).element
expect(imageElement.tagName).toBe('IMG')
})
/**
* Test if the "img" HTML element has received the "width" prop properly.
* - Testing via "dataset" instead of actual width due to Vitest limitations.
*/
it('Image inside wrapper should have 300px "width"', () => {
const testString = '300px'
const wrapper = mount(FantasiaMascotImage, {
propsData: {
width: testString
}
})
const imageElement = wrapper.get(`[data-test="${selectorList.image}"]`).element as HTMLImageElement
expect(imageElement.dataset.testWidth).toBe(testString)
})
/**
* Test if the "img" HTML element has received the "height" prop properly.
* - Testing via "dataset" instead of actual height due to Vitest limitations.
*/
it('Image inside wrapper should have 300px "height"', () => {
const testString = '300px'
const wrapper = mount(FantasiaMascotImage, {
propsData: {
height: testString
}
})
const imageElement = wrapper.get(`[data-test="${selectorList.image}"]`).element as HTMLImageElement
expect(imageElement.dataset.testHeight).toBe(testString)
})
/**
* Test if the component properly determines if the image will be random.
*/
it('Should generate random image URL', () => {
const wrapper = mount(FantasiaMascotImage)
const imageElement = wrapper.get(`[data-test="${selectorList.image}"]`).element as HTMLImageElement
expect(imageElement.dataset.testIsRandom).toBe('true')
})
/**
* Test if the component properly determines if the image will NOT be random.
*/
it('Should generate non-random image URL', () => {
const testString = 'flop'
const wrapper = mount(FantasiaMascotImage, {
propsData: {
fantasiaImage: testString
}
})
const imageElement = wrapper.get(`[data-test="${selectorList.image}"]`).element as HTMLImageElement
expect(imageElement.dataset.testIsRandom).toBe('false')
})
})

87
src/components/DialogMarkdownDocument/DialogMarkdownDocument.vue Normal file
View file

@ -0,0 +1,87 @@
<template>
<!-- Dialog wrapper -->
<q-dialog
v-model="dialogModel"
:class="['dialogMarkdownDocument', `${documentName}`]"
>
<q-card>
<q-card-section :class="['dialogMarkdownDocument__content', `${documentName}`, 'q-mt-xl', 'q-mb-lg', 'q-mr-lg', 'q-ml-xl', 'q-pt-none']">
<div class="flex justify-center">
<q-markdown
no-heading-anchor-links
:src="$t(`documents.${documentName}`)"
/>
</div>
</q-card-section>
<q-card-actions
align="around"
class="q-mb-lg"
>
<q-btn
v-close-popup
flat
label="Close"
color="accent"
/>
</q-card-actions>
</q-card>
</q-dialog>
</template>
<script setup lang="ts">
import { QMarkdown } from '@quasar/quasar-ui-qmarkdown'
import '@quasar/quasar-ui-qmarkdown/dist/index.css'
import { S_DialogMarkdown } from 'src/stores/S_DialogMarkdown'
import { ref, watch } from 'vue'
const dialogModel = ref(false)
const documentName = ref('')
const openDialog = () => {
documentName.value = S_DialogMarkdown.documentToOpen
dialogModel.value = true
}
watch(() => S_DialogMarkdown.dialogUUID, () => {
openDialog()
})
</script>
<style lang="scss">
.dialogMarkdownDocument {
.q-card {
max-width: calc(100vw - 100px) !important;
}
&.license .q-card {
width: 680px;
}
&.changeLog .q-card {
width: 1100px;
}
&.advancedSearchGuide .q-card {
width: 1100px;
}
&__content {
overflow: auto;
max-height: calc(100vh - 235px);
height: 850px;
&.changeLog {
padding-right: 40px;
}
&.advancedSearchGuide {
padding-right: 40px;
}
}
}
</style>

46
src/components/GlobalWindowButtons/GlobalWindowButtons.vue
View file

@ -9,7 +9,7 @@
flat
dark
size="xs"
class="globalWindowButtons__minimize"
class="globalWindowButtons__button globalWindowButtons__minimize"
data-test="globalWindowButtons-button-minimize"
@click="minimizeWindow()"
>
@ -19,7 +19,10 @@
>
{{ $t('GlobalWindowButtons.minimizeButton') }}
</q-tooltip>
<q-icon name="mdi-window-minimize" />
<q-icon
size="16px"
name="mdi-window-minimize"
/>
</q-btn>
<!-- MinMax button -->
@ -27,7 +30,7 @@
flat
dark
size="xs"
class="globalWindowButtons__resize"
class="globalWindowButtons__button globalWindowButtons__resize"
data-test="globalWindowButtons-button-resize"
@click="[resizeWindow(),checkIfWindowMaximized()]"
>
@ -37,7 +40,10 @@
>
{{ isMaximized ? $t('GlobalWindowButtons.resizeButton') : $t('GlobalWindowButtons.maximizeButton') }}
</q-tooltip>
<q-icon :name="(isMaximized)? 'mdi-window-restore' : 'mdi-window-maximize'" />
<q-icon
size="16px"
:name="(isMaximized)? 'mdi-window-restore' : 'mdi-window-maximize'"
/>
</q-btn>
<!-- Close button -->
@ -45,7 +51,7 @@
flat
dark
size="xs"
class="globalWindowButtons__close"
class="globalWindowButtons__button globalWindowButtons__close"
data-test="globalWindowButtons-button-close"
@click="tryCloseWindow()"
>
@ -55,7 +61,10 @@
>
{{ $t('GlobalWindowButtons.close') }}
</q-tooltip>
<q-icon name="mdi-window-close" />
<q-icon
size="16px"
name="mdi-window-close"
/>
</q-btn>
</q-btn-group>
</template>
@ -121,8 +130,9 @@ let checkerInterval: number
/**
* Hook up a interval timer on mount for continuous checking
* This done due to the fact that dragging via the top header bar doesn't properly fire "drag" event
* Async due to UI render blocking
*/
onMounted(() => {
onMounted(async () => {
checkerInterval = window.setInterval(() => {
checkIfWindowMaximized()
}, 300)
@ -130,8 +140,9 @@ onMounted(() => {
/**
*Unhook the interval timer on unmounting in order to prevent left-over intervals ticking in the app
* Async due to UI render blocking
*/
onUnmounted(() => {
onUnmounted(async () => {
window.clearInterval(checkerInterval)
})
@ -144,12 +155,23 @@ onUnmounted(() => {
z-index: 99999999;
right: 0;
top: 0;
border-radius: 0;
height:$globalWindowButtons_height;
height: $globalWindowButtons_height;
color: $globalWindowButtons_color;
-webkit-app-region: no-drag;
&__button {
&:hover,
&:focus {
color: $globalWindowButtons_hoverColor;
}
}
&__close {
&:hover,
&:focus {
color: $globalWindowButtons_close_hoverColor;
}
}
}
</style>

27
src/css/globals/htmlAdjustments.scss
View file

@ -1,10 +1,20 @@
* {
letter-spacing: 0.025em;
&::before,
&::after {
backface-visibility: hidden !important;
}
}
html,
body{
body {
overflow: hidden !important;
}
body{
&.body--light{
body {
&.body--light {
/* WebKit/Blink Browsers */
::selection {
color: $selectTextColor_lightMode;
@ -18,7 +28,8 @@ body{
}
}
&.body--dark{
&.body--dark {
/* WebKit/Blink Browsers */
::selection {
color: $selectTextColor_darkMode;
@ -32,3 +43,11 @@ body{
}
}
}
a {
color: $aLinkColor;
}
p {
margin: 0 0 16px;
}

120
src/css/globals/quasarComponentsAdjustments.scss
View file

@ -1,23 +1,117 @@
.q-page{
// Max-height of the window minus the height of the top bar
max-height: calc(100vh - 50px);
overflow: auto;
.fullscreen {
/* Tweak for top bar and other element with z-index between 6000 to 7000 */
z-index: 7001;
}
.q-card{
border-radius: $qCard-border-radius;
box-shadow: none;
border: $qCard-border-size solid $qCard-border-color;
background-color: $qCard-background;
color: $qCard-text;
.q-layout {
&__shadow::after {
/* Tweak for default light shadow rendering in the dark-mode variation of the element */
box-shadow: 0 0 10px 2px rgba(0, 0, 0, 0.2), 0 0 10px rgba(0, 0, 0, 0.24) !important;
}
}
.q-menu--dark{
box-shadow: 0 1px 5px rgba(0, 0, 0, 0.2), 0 2px 2px rgba(0, 0, 0, 0.14), 0 3px 1px -2px rgba(0, 0, 0, 0.12) !important;
.q-page {
/* Max-height of the window minus the height of the top bar */
max-height: calc(100vh - 50px);
overflow: auto;
}
.q-card {
box-shadow: $qCard-boxShadow;
}
.q-transition--slide-right-enter-active, .q-transition--slide-right-leave-active, .q-transition--slide-left-enter-active, .q-transition--slide-left-leave-active, .q-transition--slide-up-enter-active, .q-transition--slide-up-leave-active, .q-transition--slide-down-enter-active, .q-transition--slide-down-leave-active, .q-transition--jump-right-enter-active, .q-transition--jump-right-leave-active, .q-transition--jump-left-enter-active, .q-transition--jump-left-leave-active, .q-transition--jump-up-enter-active, .q-transition--jump-up-leave-active, .q-transition--jump-down-enter-active, .q-transition--jump-down-leave-active, .q-transition--fade-enter-active, .q-transition--fade-leave-active, .q-transition--scale-enter-active, .q-transition--scale-leave-active, .q-transition--rotate-enter-active, .q-transition--rotate-leave-active, .q-transition--flip-enter-active, .q-transition--flip-leave-active{
.q-markdown {
color: $qMarkdown-color !important;
line-height: 1.75;
a {
border-bottom: 1px dotted $aLinkColor;
}
pre {
padding: 16px 5px !important;
margin: 0 0 16px !important;
}
.q-markdown--token {
font-weight: 600;
padding: 0 5px;
background-color: $qMarkdown-code-blackgroundColor !important;
color: $qMarkdown-code-textColor !important;
border-color: $qMarkdown-code-borderColor !important;
}
}
.q-menu {
&--dark {
/* Tweak for default light shadow rendering in the dark-mode variation of the element */
box-shadow: 0 1px 5px rgba(0, 0, 0, 0.2), 0 2px 2px rgba(0, 0, 0, 0.14), 0 3px 1px -2px rgba(0, 0, 0, 0.12) !important;
}
&.-subMenu {
/* Submenu having 1 lower z-index than normal menu for fancier looking animation of sliding underneath the parent */
z-index: 5999;
}
}
body.desktop .q-hoverable:hover > .q-focus-helper,
body.desktop .q-manual-focusable--focused > .q-focus-helper {
/* Replacement of the overlay (before/after) elements via simple background-color opacity */
opacity: 0.075 !important;
&::before,
&::after {
/* Fix for color-disrupting overlay elements of buttons/links */
opacity: 0 !important;
}
}
body.desktop .q-focusable:focus > .q-focus-helper {
/* Replacement of the overlay (before/after) elements via simple background-color opacity */
opacity: 0.15 !important;
&::before,
&::after {
/* Fix for color-disrupting overlay elements of buttons/links */
opacity: 0 !important;
}
}
.q-transition--slide-right-enter-active,
.q-transition--slide-right-leave-active,
.q-transition--slide-left-enter-active,
.q-transition--slide-left-leave-active,
.q-transition--slide-up-enter-active,
.q-transition--slide-up-leave-active,
.q-transition--slide-down-enter-active,
.q-transition--slide-down-leave-active,
.q-transition--jump-right-enter-active,
.q-transition--jump-right-leave-active,
.q-transition--jump-left-enter-active,
.q-transition--jump-left-leave-active,
.q-transition--jump-up-enter-active,
.q-transition--jump-up-leave-active,
.q-transition--jump-down-enter-active,
.q-transition--jump-down-leave-active,
.q-transition--fade-enter-active,
.q-transition--fade-leave-active,
.q-transition--scale-enter-active,
.q-transition--scale-leave-active,
.q-transition--rotate-enter-active,
.q-transition--rotate-leave-active,
.q-transition--flip-enter-active,
.q-transition--flip-leave-active {
/* Transitions glitches with user input/select fix */
user-select: none;
pointer-events: none;
}

54
src/css/quasar.variables.scss
View file

@ -1,12 +1,16 @@
// Quasar SCSS (& Sass) Variables
/* Quasar SCSS (& Sass) Variables */
// GENERAL COLORS
/* GENERAL COLORS */
$primary : #d7ac47;
$primary-bright: #ffd673;
$secondary : #f75746;
$accent : #f5f5f5;
$dark : #18303a;
$white : #fff;
$grey : #d4d0c9;
$dark : #1b333e;
$dark-page : #303742;
$dark-lighter: #234655;
@ -16,25 +20,47 @@ $negative : #c10015;
$info : lighten(#d7ac47, 35);
$warning : #f2c037;
// GLOBALS - GENERAL SELECT
/* GLOBALS - HTML ELEMENTS */
$aLinkColor: $primary-bright;
/* GLOBALS - GENERAL SELECT */
$selectTextColor_darkMode: #eedbb0;
$selectBackgroundColor_darkMode: #bb3b32;
$selectTextColor_lightMode: #eedbb0;
$selectBackgroundColor_lightMode: #aa2a21;
// QUASAR COMPONENT - Q-CARD
$qCard-background: #f7eeda;
$qCard-text: $dark;
$qCard-border-color: $dark;
$qCard-border-size: 2px;
$qCard-border-radius: 5px;
/* GLOBALS - GENERAL ICONS */
$iconSize: 21px;
// COMPONENT - GLOBAL WINDOW BUTTONS
/* QUASAR COMPONENT - Q-CARD */
$qCard-background: $dark;
$qCard-text: $white;
$qCard-border-color: $dark;
$qCard-border-size: 0;
$qCard-border-radius: 5px;
$qCard-boxShadow: 0 1px 5px rgba(0, 0, 0, 0.2), 0 2px 2px rgba(0, 0, 0, 0.14), 0 3px 1px -2px rgba(0, 0, 0, 0.12);
/* QUASAR COMPONENT - Q-CARD - Error page special */
$qCard-errorPage-background: #f7eeda;
$qCard-errorPage-text: $dark;
$qCard-errorPage-border-color: $dark;
$qCard-errorPage-border-size: 2px;
$qCard-errorPage-border-radius: 5px;
/* COMPONENT - GLOBAL WINDOW BUTTONS */
$globalWindowButtons_height: 35px;
$globalWindowButtons_color: $accent;
$globalWindowButtons_hoverColor: $primary-bright;
$globalWindowButtons_close_hoverColor: $secondary;
// COMPONENT - APP CONTROL MENUS
/* COMPONENT - APP CONTROL MENUS */
$appControlMenus_bgColor: $dark-lighter;
$appControlMenus_color: $accent;
$appControlMenus_separatorColor: $primary;
$appControlMenus_singleHover: $primary;
$appControlMenus_separatorColor: $primary-bright;
$appControlMenus_singleHover: $primary-bright;
/* COMPONENT - MARKDOWN */
$qMarkdown-color: $grey;
$qMarkdown-code-textColor: $dark;
$qMarkdown-code-blackgroundColor: $accent;
$qMarkdown-code-borderColor: $accent;

12
src/globals.d.ts vendored
View file

@ -1,11 +1,13 @@
import { I_extraEnvVariablesAPI } from 'app/interfaces/I_extraEnvVariablesAPI'
import { I_faWindowControlAPI } from 'app/interfaces/I_faWindowControlAPI'
import { I_faExternalLinksManagerAPI } from 'app/interfaces/I_faExternalLinksManagerAPI'
import { I_faDevToolsControl } from 'app/interfaces/I_faDevToolsControl'
declare global{
interface Window {
faWindowControlAPI: I_faWindowControlAPI,
faDevToolsControlAPI: I_faDevToolsControl,
extraEnvVariables: I_extraEnvVariablesAPI
}
interface Window {
faWindowControlAPI: I_faWindowControlAPI,
faDevToolsControlAPI: I_faDevToolsControl,
faExternalLinksManagerAPI: I_faExternalLinksManagerAPI,
extraEnvVariables: I_extraEnvVariablesAPI
}
}

22
src/i18n/en-US/documents/advancedSearchCheatSheet.md Normal file
View file

@ -0,0 +1,22 @@
- Notes for filter types
- Substitute whitespaces with `-`
- `@` prefix to include `Other names` in the search
- Filter types
- `$` - Document type
- `#` - Tag
- `>` - Hierarchical path
- `^` - Switch
- `^c` - Is a category
- `^d` - Is Dead/Gone/Destroyed
- `^f` - Is finished
- `^m` - Is a minor document
- Full search
- `%` - Beginning of the full-search
- `:` - Division between the field-name and field value
- `%some-field:some-value` - Search through all fields for value
- This can also be used to search for colors: `%color:blue`
- `""` wrap for precise search (field name and/or value)
- Example full precise: `%"some-field":"some-value"`
- Example value precise: `%some-field:"some-value"`
- Example name precise: `%"some-field":some-value`

97
src/i18n/en-US/documents/advancedSearchGuide.md Normal file
View file

@ -0,0 +1,97 @@
# Advanced search guide
---
## Introduction
Fantasia Archive comes with a fairly advanced search-engine present in most of the search fields that look up through either all or at least one type of document - these are for example the multiple and single relationship fields on each document page and the quick-search popup.
---
## Intelligent search matching & sorting
The search itself works the following: You can search any amount of words and the software will process them individually as long as they are separated by whitespace.
### The search follows these rules
- **The search is case-insensitive, which means that you can type everything in UPPER or lower case (or any oThEr WaY), it won't matter**
- **Words can be in any order**
- Example: `Dark scary castle` will be found even if you type `scary castle dark`
- **Even parts of words will result in successful search**
- Example: `Dark scary castle` will be found even if you type `sca tle ark`
- **Documents will priority-sort based on the following rules:**
1. **Direct match has priority over everything else**
- Example: `Dark scary castle` is a direct match for a search containing `dark scary castle`
2. **Full word match has priority over fragments**
- Each fully matched word counts individually; the more full-matches the document has, the higher it will be in the list
- Example: `Dark scary castle` has 2 full word matches from `dark scary tle`
3. **Fragments are at the bottom of the list**
- Each fragment matched counts individually; the more fragments the document has, the higher it will be in the list
- Example: `Dark scary castle` has 2 fragment matches from `sca tle`
- **It is possible to include `Other names` into the search as well, by prefixing `@` in front of the search string**
- Example: `@Vampire lair` (if your `Dark scary castle` had other name filled as `Vampire lair`, the search will find it this way)
---
## Filtering
Except for the advanced search functionality, Fantasia Archive also offers instant filtering via multiple attributes for further narrowing search results.
- **NOTE: All of the following filter values (including the Full-search filtering in the next section) support matching any part of the search-text with any part of the search-term**
- Example: `>nada` will match with `Continent > North America > Canada > Toronto`
### The filtering works in the following ways and follows these rules:
- **Any of the following filter terms WILL NOT conflict with the normal word search; therefore you can use them together**
- **It is possible to use only filter-instance of each of the following filter-types at once; however, each individual filter-type may also be present at the same time**
- **The filter is case-insensitive, which means that you can type everything in UPPER or lower case, it won't matter**
- **If your filter-term contained whitespaces, replace them with the `-` symbol**
- Example: You wish to search for a tag called `Player Characters`, to fully match this tag, you will need to type `#player-characters`
- **Hierarchical path-filter automatically removes all `>` symbols in the path, this result in their omission from the filter string**
- Example: You wish to search for a hierarchical path containing the following `USA > Virginia > Richmond`, to fully match this hierarchical path, you will need to type `>usa-virginia-richmond`
- **The following filter terms may be used**
- `$` - Symbol for document type search
- `#` - Symbol for tag search
- `>` - Symbol for hierarchical path search
- `^` - Symbol for conditional-switch search (specific types and values below)
- `^c` - Displays only documents with `Is a category` ticked on
- `^d` - Displays only documents with `Is Dead/Gone/Destroyed` ticked on
- `^f` - Displays only documents with `Is finished` ticked on
- `^m` - Displays only documents with `Is a minor document` ticked on that are normally invisible and filtered out
## Full-search filtering
This feature is meant mostly for those in need of full-scale search that can crawl through any field in any document to match any value field in almost anywhere. Full-search filtering allows the user to narrow down the search marginally by digging through the whole document database and pinpointing exactly what is needed.
### A few words of caution
**The full-search is a very powerful, but also demanding tool - the more your project will grow, the more demanding it will become. This means that if you for example have 2000+ documents in your project and the search algorithm will have to go crawl through all of them, then the full-search might take a few second to reload your search results - please keep this in mind when using this feature: It can potentially be A LOT of data.**
### The filtering works in the following ways and follows these rules
- **The full-search can be used in combination with any other filters and/or normal search terms**
- **It is possible to have only a single instance of the full-search present in the search at once**
- **The filter is case-insensitive, which means that you can type everything in UPPER or lower case, it won't matter**
- **In the case of lists and multi-relationships, all the entered values get converted to one big text-line for the sake of searching**
- Example with a field called `Local currencies`:
- Original values: `Canadian Dollar` `American Dollar` `Euro` `Klingon Darsek`
- Converted values: `canadian-dollar-american-dollar-euro-klingon-darsek`
- **The following filter terms must be used inside of the search term**
- `%` - Symbol for the beginning full-search
- `:` - Symbol for the division between the field-name and field value
- **Is possible to use precise searching**
- Both the field name and its value can be wrapped inside invidual limiters
- Example for both precise: `%"local-currencies":"some-currency"`
- Example for precise field name: `%"local-currencies":some-currency`
- Example for precise field value: `%local-currencies:"some-currency"`
- **If your filter-term contained whitespaces, replace them with the `-` symbol**
- Example: You wish to search for a field called `Local Currencies` that contains `Canadian Dollars` as value, to fully match this tag, you will need to type `%local-currencies:canadian-dollars`
- **It is possible to do a full-text search, checking all fields for the desired text by doing the following: `%:canadian-dollars`**
- **A list of fields/field types the full-search doesn't work with:**
- The `Break` field type (these are the big titles present throughout the document)
- The `Tags` field type (this one is covered with a more sophisticated tag filter)
- The `Switch` field type (this one doesn't contain any text values to even filter and is partially covered by the switch search option)
- The `Name` field (this one is the main concern of the search and the normal search is far more advanced for searching through this one)
- The `Belongs under` field (this one is covered by a much more advanced hierarchical path search)

659
src/i18n/en-US/documents/changeLog.md Normal file
View file

@ -0,0 +1,659 @@
# Changelog
----------
## 0.2.0 - The Big Rewrite
### New features
- A whole plethora since this is a full rewrite!
### Known issues
- No issues at the date of release.
### Bugfixes & Optimizations
- Too many optimizations to list since this isa rewrite.
- No bugs at the date of release.
## 0.1.12
### Known issues
- Creating a brand new project can very occasionally get stuck. Restarting the app fixes this.
- Loading existing project can very occasionally get stuck. Restarting the app fixes this.
- Saving documents can sometimes leave it in edit mode instead of closing it (data gets saved anyway).
### New features
- Added functionality to rearrange opened document tabs; either left or right
- Added keybind support for rearranging opened document tabs
## 0.1.11
### Known issues
- Creating a brand new project can very occasionally get stuck. Restarting the app fixes this.
- Loading existing project can very occasionally get stuck. Restarting the app fixes this.
- Saving documents can sometimes leave it in edit mode instead of closing it (data gets saved anyway).
### Bugfixes & Optimizations
- Fixed PDF exports in regards to the @at links in text editors (thanks AkroMentos!)
## 0.1.10
### Known issues
- Creating a brand new project can very occasionally get stuck. Restarting the app fixes this.
- Loading existing project can very occasionally get stuck. Restarting the app fixes this.
- Saving documents can sometimes leave it in edit mode instead of closing it (data gets saved anyway).
### New features
- **Added page-wide search option similar to web-browsers with a default keybind of "CTRL+ALT+F"**
- The keybind can be modified to the user's preferences as usual in the Keybinds menu
- **Added support for "@" links inside document editors** (thanks AkroMentos!)
- Pressing "@" inside the big editor fields will now allow you connect links directly inside the text editors
- Clicking on links created this way, while not in edit mode, inside text editors will open the connected document in a new tab
- Clicking on links created this way, while in edit mode, inside text editors and holding CTRL key will also open the connected document in a new tab
- Clicking on links created this way, while in document quick-preview, will open the connected document in a new tab
### Bugfixes & Optimizations
- Slightly improved color scheme for edit mode of documents while in light mode
## 0.1.9
### Known issues
- Creating a brand new project can very occasionally get stuck. Restarting the app fixes this.
- Loading existing project can very occasionally get stuck. Restarting the app fixes this.
- Saving documents can sometimes leave it in edit mode instead of closing it (data gets saved anyway).
### Bugfixes & Optimizations
- Hopefully improved performance and overall optimization due to multiple updated libraries and Electron framework.
- Improved enter key support for different dialogs. (thanks babelfish!)
- Fixed an issue with outdated Electron version and fixed a connected issue with building using the newer Electron version (thanks Wazikamawata!)
## 0.1.8
### Known issues
- Creating a brand new project can very occasionally get stuck. Restarting the app fixes this.
- Loading existing project can very occasionally get stuck. Restarting the app fixes this.
- Saving documents can sometimes leave it in edit mode instead of closing it (data gets saved anyway).
### Bugfixes & Optimizations
- Fixed a few bugs with the export project window not properly displaying on top of other windows/popups
- Fixed a typo in the "Save all opened documents with active changes" keybind
- Fixed a bug that was causing the predefined select list sometimes completely disappear along with the whole select in the single-select field when filtering (eg: Sex field)
- Slightly improved performance when loading the project for the first time
- Fixed a bug in PDF export that was causing export crashes in case of line breaks present in the list/relationship field notes
- Fixed a bug causing some of the legacy field detection to miss some types of legacy fields sometimes
### New features
- **Added document template support**
- Integrated document templates into exports
- Integrated document templates into document view/editing
- Export now automatically take in account individual export templates that take priority over one selected in the select field. This behavior can be disabled via an export setting check that will make FA ignore all individual export templates for the documents.
- **Added document preview in split-view mode**
- **Added mass document deletion tool**
- **Added support for the showing of last opened document list**
- **Added first iteration of the Project settings**
- Added an option to turn off the spellcheck app-wide
- Added project renaming support from inside the app
- Added export functionality to relationships inside document previews
- Added option: Aggressive relationships selection
- Fantasia (the mascot) learned how to cook!
- Multiple new RPG systems added and some existing got updated
- Added unique-identified option for exports
- Added new spoiler/secrets/DM notes field to all document types
- Added spoiler-free export option for exports
- Added support for custom subtitles in list fields
- Added support for mass exports to the hierarchy tree
- Added context, right-click menu to the hierarchy tree to tags
- Preview in split-view mode
- Collapse/Expand all
- Rename tag
- Delete tag
- Add a new document to this tag
- Added more common material/resource properties fields to the Resource document type
### QoL adjustments
- Replaced confusing relationships to Places of Demise/Birth/Residence in Character and Location document types with the normal 2-way relationship. Previous fields have been turned to Legacy fields for easy user removal later on
- Added search to keybinds cheatsheet
- Added hierarchical tree auto-expand to top-tag pseudo-category on startup in order to unify the behavior with how the rest of FA modules work right now
- Set non-aggressive relationships selection as default to make setting up a new project a little easier for users
- Reworded the legacy field warning message
- Compacted the right-click menus across the app to make them a little easier to use
- Optimized document display view to only show titles for sections that actually have content in case the document is tagged as finished or if options are set to only display filled field values
## 0.1.7
### Known issues
- Creating a brand new project can very occasionally get stuck. Restarting the app fixes this.
- Loading existing project can very occasionally get stuck. Restarting the app fixes this.
- Saving documents can sometimes leave it in edit mode instead of closing it (data gets saved anyway).
### Bugfixes & Optimizations
- Fixed infinite vertical scroll of the app caused by buggy behavior of the floating windows being pulled on the bottom of the visible window
- Fixed a limiter for advanced search that was throwing errors in rare cases
- Fixed a bug that was causing single-to-single relationship notes not properly saving
- Fixed the notes window showing on top of popup overlay
- Fixed a bug that was causing changes to document blueprints to not update properly
- Fixed a bug affecting single-to-single and many-to-single relationships in case deleted values were lingering in the connected data
- Fixed a bug that was causing improper rendering of the project overview graph legends
- Fixed a bug where the advanced search wasn't working properly for local relationship fields inside a document in the case of fields value search
### New features
- **Added export support for Markdown**
- **Added export support for PDF**
- **Added on-the-fly relationship documents generation**
- **Added stat/attribute support for multiple RPG systems**
- **Added option to search through the `Other names` field via `@` modifier**
- **Added document preview popup and corresponding options to the settings for them**
- **Added `Skills/Spells/Other`, `Resources/Materials`, `Occupations/Classes` and `Afflictions/Boons/Conditions` document types and all their respected fields across the whole app**
- **Reworked all existing document types to function better with the new additions**
- Added reverse display for lists
- Added a whole category of items adding for lists
- Added precise mode search to full-field search in the relationship search inputs
- Added option: Prevent filled note board showing
- Added an option to save all opened documents upon exiting the app/closing project
- Added `Other Names & Epithets` to `Chapters` document type
- Revamped `Member count` field in all types of groups document types
- Added `Follower/Subject count` field to all types of groups document types
- Added dev option to the menu for quick document ID copying
- Updated the legacy project repair tool to also transfer old stat fields into the new setup
- Added a checker tool for the removal of legacy fields for the user
- Added both keybind and a button for mass-saving of documents with edits
- Added export option into the app menu
- Added a keybind: "Save active document and mark it as finished"
- Added a keybind: "Toggle Developer tools"
- Added a keybind: "Export document"
### QoL adjustments
- All "Export and Import" texts have been changed to "Save and Load" due to the inclusion of the new, actual, "Export" feature
- Added a note about possible color searching in the advanced search cheatsheet popup window
- Added input resetting after adding/selection in the relationship fields
- Revamped the field order in all document types since the `Other names` field moved to `Document settings` from `Basic information` as it is now a mandatory system field specially used in advanced search
- Added tooltips to `Member count` and `Follower/Subject count` fields in all groups document types
- Updated selects to act as text input fields in case there are no prefixed values in the list
- Field labels received a facelift to look more appealing to look at when showing on smaller screens
- Attempted to "prettify" the display mode of the document fields in case the "Hide empty fields" option is ticked on
- Added a tiny bit of color to help discern which relationship is one-way and which is two-way
- Adjusted the single and multi relationship fields not showing suggestion popups when a value has removed the list
- Adjusted the single relationship fields to hide the suggest list when a value is selected from the list
- Adjust font sizes for titles and "sizes" in the text editor field to be actually useable without looks ridiculous
- Rearranged the menu and added a new `Tools` category to make finding stuff a bit easier
## 0.1.6a
### Known issues
- Overusing Tags (20+ with 400+ documents in them for most) currently causes slowdowns/crashes on some PCs when using the Hierarchy tree. If you suffer from this issue, reduce the number of tags and/or objects paired underneath them.
- Importing existing project can sometimes get stuck. Restarting the app fixes this.
### Bugfixes & Optimizations
- Fixed hierarchy tree ignoring "0" value in Order fields
- Fixed a bug where the automatic relationship limter was treating single-to-many field type as single-to-single types
- Fixed a bug that was causing import/merge/repair tools to get stuck after exporting in the same popup
- Fixed an issue with flickering select menus
- Fixed functionality of the `Connected Locations` field in the `Teachings/Religious groups` document type
- Fixed a bug that waas causing the copy document functionality to also copy single-to-single and many-to-single relationships.
- These relationships can not be copied as they are logically unique across the whole web of all relationships the user build and can exist only once in the whole system
- Example: Bilbo has `Place of origin` set to Shire - if you make a copy of Shire, Bilbo will get automatically removed from the `Characters originated from location` in the copy of the Shire as he is already linked to the original Shire and logically couldn't have originated from two places at once.
### New features
- Added a floating Note board window
- Added new options to predefeined select lists across the app
- Added new display for non-edit mode for switch fields
- Added keybind: Show project overview
- Added keybind: Toggle Note board
- Added menu and document control bar buttons to show Note board
### QoL adjustments
- Adjusted label-align of text editor fields to look more representstive of half-coherent UI
- Adjusted the behavior, icon and name of the `Resume project` functionality in the menu
- Renamed "Project screen" to "Project overview" app-wide
## 0.1.6
### Known issues
- Overusing Tags (20+ with 400+ documents in them for most) currently causes slowdowns/crashes on some PCs when using the Hierarchy tree. If you suffer from this issue, reduce the number of tags and/or objects paired underneath them.
- When using the `Legacy project repair` tool, a very small amount of users report being stuck on the progress. If you suffer from the issue, restart the app and then restart the fixing process - this seems to be a workaround for now.
### Bugfixes & Optimizations
- **Massive overhaul of how data is being handled across the app!**
- Fixed buttons for moving list items up and down also showing outside of edit mode
- Fixed `Resume project` button working in instances where it shouldn't
- Fixed a visual bug in the top document control bar
- Added a check against invalid characters in the new project name to prevent issues while exporting on different OSs
- Hopefully finally fixed the new project creation bugs that have been plaguing the app for the last 3 releases
- Fixed app starting in multiple windows when ran multiple times.
- Fixed more typos across the app
- Added debounce timers for all input fields across the whole document to massively improve performance when updating temporary document data across the app
- Fixed a bug that was re-triggering edit mode on document save without any actual edits
- Fixed a bug that was causing improperly filled in URLs in the text editor field to glitch out the whole app and require a restart
- Revamped how tooltips work in already paired documents in single-to-single and many-to-single relationships
### New features
- Added support for filtering via `Is a category` switch field
- Added links to Reddit, GitHub, and FA Website
- Added multiple predefined values list multiple list field across the different document types
- Added a super obnoxious prompt for people to repair their project on start-up so they hopefully actually do it! Woo-hoo!
### QoL adjustments
- Adjusted the `Accessibility - Text shadow` option looks to look better
## 0.1.5a
### Known issues
- POSSIBLY FIXED: When creating a brand new project, Fantasia Archive sometimes doesn't load the default categories in the left hierarchical tree. A temporary workaround before the issue is fixed is restarting the program - the project stays intact, can be normally edited and no data loss occurs.
- POSSIBLY FIXED: Some users report that dialog (popups) don't function the very first time you start FA. This is solved by restarting the application. The bug doesn't seem to appear again once FA has been started at least once before.
- Overusing Tags currently causes app crashes on some PCs. If you suffer from this issue, reduce the number of tags in your project below 10.
### Bugfixes & Optimizations
- Fixed a bug of edit mode "Open in new window" buttons being on a higher level than the document control bar and rendering over it
- Fixed non-working edit button in the hierarchical tree on already opened documents
- Attempted to fixed occasionally buggy functionality regarding known issues of the non-functional new project and importing/merging
### New features
- Added project merge functionality to the app
- Added arrows to move `List` field items up and down
- Added a new `Cost in different Currencies` one-way relationship field to `Items` document type
- Added a new `Connected to Currencies` two-way relationship field to `Items` document type
- Added a new `Connected to Items` two-way relationship field to `Currencies` document type
- Added a few pre-filled location types to `Location type` field in `Locations/Geography` document type
- Added support for toggling of hierarchical tree on and off
- Added option: Hide hierarchical tree
- Added keybind: Toggle hierarchical tree
- Added menu icon and document control bar icon for toggling of hierarchical tree
### QoL adjustments
- Multiple small field name changes to unify meanings across the app
- Unified ordering of connected groups in all document types
## 0.1.5
### Known issues
- When creating a brand new project, Fantasia Archive sometimes doesn't load the default categories in the left hierarchical tree. A temporary workaround before the issue is fixed is restarting the program - the project stays intact, can be normally edited and no data loss occurs.
- Some users report that dialog (popups) don't function the very first time you start FA. This is solved by restarting the application. The bug doesn't seem to appear again once FA has been started at least once before.
- Overusing Tags currently causes app crashes on some PCs. If you suffer from this issue, reduce the number of tags in your project below 10.
### Bugfixes & Optimizations
- Fixed a typo in the `Type of being` field in the `Species/Races/Flora/Fauna` document type
- Fixed even more random typos I don't even recall T_T
- Fixed a bug in light mode that was coloring the `List` field type's addition atributes dropdown wrong
- Fixed a bug that was causing the relationship dropdowns sometimes not to be clickable and instead caused dragging of the app window when shown over the top of the drag-bar at the top of the app
- Updated advanced search guide with missing information about full-text search
- Changes a small bug when the `New Object` dialog wasn't respecting option changes being done in the same session of the program being opened
- Fixed a bug that was sometimes showing improper values inside the user-defined keybinds both in the key settings and the cheatsheet
- Fixed tag groups in the hierarchical tree not respecting custom order and alphabetical order
- Fixed a rather peculiar recurring bug that could cause the database to endlessly attempt to update a document while constantly throwing errors
- Fixed a bug that was causing an "Empty" checkbox popping up at irrelevant places on right-click
- Managed to fix or at least mitigate multiple memory leaks across the app
- Optimized multiple parts of the code to run smoother
- Fixed wrong icons in some fields in some document types
- Fixed a bug that was allowing for an attempted deletion of a document while the document data was still being retrieved. This resulted in an error that both made a mess of a UI and didn't delete the desired document
- Fixed a bug in the scroll of the hierarchical tree that was causing it to not display the last 1-2 items when scrolling down
- Fixed a bug that was causing the hierarchical tree-resizing drag-bar to not scroll down with the rest of the page when viewing documents
- Fixed a typo in delete document confirmation dialog
- Fixed a few typos in `Character` document type
### New features
- Added context menu support and multiple actions (right-click) for top tabs, hierarchical tree, and relationships across the whole app
- New actions for **Top Tabs**
- All Opened Tabs
- A list of all opened tabs for quick navigation
- Copy name
- Copy text color
- Copy background-color
- Create a new document with this document as a parent
- Copy this document
- Close this tab
- Close all tabs without changes except for this
- Close all tabs without changes
- Force close all tabs except for this
- Force close all tabs
- Delete document
- New actions for **Hiearachical Tree**
- Add new document type: `DOCUMENT TYPE`
- Only available in the root-categories
- Expand all under this node
- Collapse all under this node
- Copy name
- Copy text color
- Copy background-color
- Open document
- Edit document
- Create a new document with this document as a parent
- Copy this document
- Delete document
- New actions for **Relationships**
- Copy name
- Copy text color
- Copy background-color
- Open document
- Edit document
- Create a new document with this document as a parent
- Copy this document
- Added a special description field for categories that become visible only when the document is switched to the category mode
- Added an option and corresponding buttons/keybinds to save without exiting edit mode
- Added a new 2-way relationship field `Connected to Lore notes/Other notes` to every single document type across the whole document
- Added a whole new category "Organizations/Other groups" and connected it to other document types
- Added a floating popup window for quick cheatsheet for Advanced Search guide that can be summoned from each relationship search anywhere in the app
- Added and reworded a few trivia lines
- Added filtering via switch value for `Is a minor document`, `Is finished` and `Is Dead/Gone/Destroyed` switch
- Dead is visible in the lists by default but can be used to narrow down the search
- Finished is visible in the lists by default, but can be used to narrow down the search
- Minor is NOT visible in the lists by default but can be included using this option
- Instructions on how to trigger by these additions can be found in the `Advanced Search Guide` help menu
- Added Fantasia mascot in the app! ^\_^
- Different document tabs now keep scroll distance and resume wherever you left them at
- Added support for default empty keybinds
- Added a dedicated button that opens the connected documents straight from the little chips in relationship fields while in edit mode
- Added support for background-color for documents
- Added support for "Minor document" mode switch for better organization and visual representation of documents
- Added support for "Dead/Gone/Destroyed" mode switch for better organization and visual representation of documents
- Added support for "Finished" mode switch for better organization and visual representation of documents
- This is essentially an individual setting for "Hide empty fields" options setting on a per-document basis
- Added trivia concerning Fantasia mascot
- Added support for the direct opening of documents in edit mode from the hierarchy tree without needing to open the document in view mode first
- Added option: Hide Fantasia mascot
- Added option: Accessibility - Hide strike-through
- Added option: Accessibility - Hide order numbers
- Added option: Hide extra icons
- Added option: Hide "Add under" icon
- Added option: Hide "Edit" icon
- Added option: Hide "Open" icon
- Added option: Hide relationships help button
- Added option: Prevent auto-scrolling
- Added functionality to copy existing documents along with all their contents
- Added keybind: Close all tabs without changes except for this
- Added keybind: Close all tabs without changes
- Added keybind: Force close all tabs except for this
- Added keybind: Force close all tabs
- Added keybind: Copy active document
- Added keybind: Toggle the Advanced search cheatsheet
- Added keybind: Save document without exiting edit mode
### QoL adjustments
- Swapped default keybinds between `Save active document` and `Save document without exiting edit mode` for hopefully more intuitive usage (you can still switch it back as it was using custom keybinds if you wish!)
- Added small popup notification upon successful save of a document
- Unified and modified a lot of the root category names/descriptions
- Changed focusing of the hierarchy tree search input from CTRL + SHIFT + W to CTRL + SHIFT +T
- Updated fullscreen editor looks to work more like a proper document editor
- Unified icons for the same actions across the app
- Added responsive layout to the app to adjust based on the size of the window
- Program settings have been separated into multiple tabs and sub-groups to be actually possible to navigate effectively
- Setting now remember which tab the user last closed them on in the same session of the app
- Reordered the basic document settings inside the app and separated them from the document content
- Adjusted maximum width of switch fields to make them look like spaghetti
- Updated the Advanced search guide with new additions and added one new Trivia popup text concerning it
- Made the app a bit more "snappy" by decreasing animation lengths when transitioning between documents
- Updated `readme` file on how to properly compile the app since I made it OSS and all... kinda important
- Added `license` file to the repo so anyone code-savy reading the repository wouldn't get confused
- Modified displaying of `Skills` field on smaller displays in `Characters` document type to be actually usable
---
## 0.1.4
### Known issues
- When creating a brand new project, Fantasia Archive sometimes doesn't load the default categories in the left hierarchical tree. A temporary workaround before the issue is fixed is restarting the program - the project stays intact, can be normally edited and no data loss occurs.
### Bugfixes
- Fixed a bug that was preventing the text editor field from closing the full-screen view upon saving via the CTRL+S shortcut while in the full-screen mode.
- Fixed a bug that was causing top-level documents to randomly expand their respect document type when opened in the active tab list
- Fixed a small bug causing newly created documents to "bounce around" or scroll roughly to the half of the document on their own
- Fixed a bug that was preventing external URL links opening from the text editor field
- Fixed a bug with filter via the document type that was causing the filter to search by document type ID instead of the actual name
- Fixed a bug where the big text editor field was also copying input text styles (colors, backgrounds, fonts)
- Globally changed a typo in the "Connected to myths. legends and stories" field
- Globally changed a typo in the tooltip of the "Tags" field
- Globally changed a typo in the tooltip of "Scientifical" to "Scientific"
- Fixed a typo in "Add under parent" strings
- Fixed a few typos in some keybind strings strings
- Fixed and unified a lot of typos/gramatical errors across multiple fields and document types
- Reworded and fixed typos in the Single and Multi relationship field tooltips
- Fixed horizontal scrollbar looks and functionality
- Fixed a bug that was causing keybinds to register and affect the UI even if a popup was opened over it
- Fixed typos of "Sentience" instead of "Sapience" in some of the "Species/Races/Flora/Fauna" document type fiels
### New features
- Added a custom keybind support to the app
- Added Tips, Tricks & Trivia popup, a menu item, buttons and project screen box
- Added a resizeable hierarchical tree for all your categorical needs
- The app also remembers the tree-size on restart so your preferred width gets transferred between your world-building sessions
- Added dark mode
- Finally added license to the software (oopsy...)
- Added a fancier Welcome screen looks
- Added social links (Discord and Patreon)
- Restyled and pimped-up text editor field to replace most of your MS-word needs (obviously supports both light and dark modes properly)!
- Added a specific field/value support for the relationship and quick-search popups
- This also means added support for filtering by document color
- Added automatic sub-category closure in the hierarchical tree when closing the parent category
- Added new App option keybind
- Added App options
- Added option: Dark mode
- Added option: Accessibility - Text shadow
- Added option: Accessibility - Pronounced count divider
- Added option: Hide Welcome screen social links
- Added option: Hide tips popup on start screen
- Added option: Hide tips on project screen
- Added option: Disable document control bar
- Added option: Disable document guides
- Added option: Disable document tooltips
- Added option: Hide empty fields
- Added option: Stop quick-search close after selection
- Added option: Don't precheck category filter
- Added option: Close quick popups with the same key
- Added option: Stop sublevel collapse in tree
- Added option: Hide project name in the tree
- Added option: Hide document count entirely
- Added option: Hide category count
- Added option: Invert category position
- Added option: Invert tree custom order sorting
- Added option: Hide tags in the tree
- Added option: Top tags in the tree
- Added option: Compact tags
### QoL adjustments
- Globally renamed "Color" field to "Text Color" to allow better filtering via field-search for future addition of background color support
- Added proper coloring to custom links in the text editor field
- Added displaying category and document count in the hierarchical tree by default at first glance
- Added more contrasting text-select colors for dark mode
- Added Quick add/search popup functionality to the Project menu
- Added icons to the app menus
- Added a small debounce timer to the relationship searches to reduce the lag it was causing
- Lightly touched upon the color scheme
- Increased readability of highlit bits of the Advanced search guide
- Added an auto-select of the newly added field upon adding new text items in the list field-type
---
## 0.1.3
### Known issues
- When creating a brand new project, Fantasia Archive sometimes doesn't load the default categories in the left hierarchical tree. A temporary workaround before the issue is fixed is restarting the program - the project stays intact, can be normally edited and no data loss occurs.
### Bugfixes
- Fixed a MASSIVE two-way relationship bug that would have prevented a future integration of user-defined addition fields and document types
- Hopefully fixed a bug with keybinds not registering sometimes
- Added a missing row of connected "Sciences/Technologies" (connected, ally and enemy) to the "Sciences/Technologies" document type
- Added a missing row of connected "Religions/Teachings" (connected, ally and enemy) to the "Religions/Teachings" document type
- Added a missing row of connected "Magic/Spell" (connected, ally and enemy) to the "Magic/Spell" document type
- Fixed an occasional wrong click register on the document tree (opening document instead of expanding/collapsing)
- Fixed non-functional whitespace trimming for multiple document fields upon filling in input
- Fixed the "Name" field disappearing upon full deletion of text
- Fixed a bug with single/multi-select fields working unintuitively for adding new values (eg: Character personality traits field or Sex field)
- Fixed a tiny glitch when the hierarchical tree arrow was sometimes creating new documents instead of opening the category
- Fixed a bug of persisting opened tabs when creating new projects/importing existing project over already opened ones
- Added an auto-remover of no longer existing relationships filled in within single and multi relationship fields
- Fixed a typo with "Sciences/Technologies" missing the plural form
- Adjusted the naming of "Other/Notes" to "Lore notes/Other notes" to be functional with the new search engine (apologies for this one, a new solution might be implemented later)
- Adjusted the naming of "Myths/Legends" to "Myths/Legends/Stories" to cover a wider area of content
- Fixed a bug with a full-screen text editor overlapping the menu
- Fixed a bug where list-typed fields were properly saving temporary data when switching between tabs in the note fields
- Fixed broken padding of the document in "Chapters" and "Lore notes/Other notes"
- Fixed a typo in the "Connected Locations" field inside the "Magic/Spell" document type
- Fixed a visual glitch with icons sometimes "bouncing" or "flickering" when hovered over with the mouse
### New features
- Massive improvement to rendering and performance of the app by leveraging some of the workloads to the GPU from the CPU
- Added a safeguard dialog for new project creation in case an opened project exists
- Added a safeguard dialog for project importing in case an opened project exists
- Added automatic redirecting to the project screen upon importing an existing project or creating a new one
- Added loading transition for longer action (export, import, and creating a new project)
- Added toast messaging informing the user of how the long actions went
- Added a project title above the hierarchical tree
- Added a new 2-way relationship field "Connected characters" for all kinds of groups (Political, Religious, Magical, and Technological) that connect with 4 new respect character fields.
- This change was done due to some characters having relationships with certain ground that didn't necessarily count as memberships, alliances, or hostilities.
- Added support for opening connected document in single and multi-relationships without focusing on the document itself and instead just open it in the tab list
- Added continuous closing of tabs via holding down CTRL + W
- Added an "Advanced search guide" dialog with a manual on how to use the advanced search
- Added a "Changelog" dialog - you might be reading it right now!
- Added an option of "Raw magical energy manipulation" to "General schools of magic" in "Magic/Spell" document type (for those of us who like our characters throwing half a city at each other anime-style!)
- Added "About Fantasia Archive" dialog showing current app version (more details will be added in the future)
- New control bar added for documents and project control along with a more intelligent button redesign
- A new logo added to the app (better visibility of the logo in small scales and icons)
- Massive overhaul of the search engine used by the Quick opening existing document and single/multi relationship fields (now supports tags, categories, document types, intelligent filtering, and intelligent sorting via the importance of the found values)
- Added color support to single/multi relationship fields
- Added a hierarchical path to Quick opening existing document and single/multi relationship fields
- Added filtering to include or exclude documents that are considered categories in the Quick opening existing document dialog
- Removed "Practitioners/Engineers" field from "Sciences/Technologies" document type as it was a duplicate of another one and was causing issues
- Added automatic opening of hierarchical tree branches upon adding/moving documents under/among them
- Added tags support
### QoL adjustments
- Adjusted animations through the app to make it feel a bit more responsive
- Lightly modified the app color-scheme to offer better readability of contrast
- Adjusted document display screen for easier legibility, quicker navigation, and fancy-schmancy look
- Changed icon for the button triggering quick-adding of new documents
- Reworked the way tab closing works - now mimicks the functionality of how web-browsers handle it
- Added syncing of opened tabs to the matching item in the hierarchical tree
- Changed "Character traits" field name to "Traits & Characteristics" in the "Character" document type
- Hierarchical tree looks optimized for more streamlined looks and better space-usage
- Changed the looks of tooltips, relationship fields, and selects to go well with the current app looks
- Adjusted tab-list width to allow for more content to show
- Improved scroll behavior in the keybind cheatsheet dialog (looks a little strange now, but will work better as more keybinds are added)
- Improved response time from the Quick-search popup upon opening
- Renamed "Notable practitioners/scientists" to "Technology/Science users" from "Sciences/Technologies" document type
- Added a highlight for the save document button in case the current document has edits
- Added a tooltip showing how many of the objects in the hierarchical tree are documents and how many are categories
- Hierarchical tree search bar is now attached on the top of the tree and no longer scrolls along with the rest of the content of the tree to allow better useability. The search now also expands to full app width on focus via user's interaction. The search icon was moved to the right and the field reset icon was moved to the left.
- Modified selected and activity indicators for already selected/active items in dropdown lists to not clash with the highlighting from the filter results
- Slightly modified the scrollbar visuals to be less intrusive
- Added a light golden tint to the background of the app to go easy on the user's eyes before the dark mode is added
- Improved performance by reducing the amount of time the side-tree re-renders
- Visually aligned custom order badge for both nodes with and without children
- Added dark visuals to the single-select and multi-select fields to align with the rest of the app
- All popup dialogs have been unified to a dark-color mode
- Prettified a dialog popup for confirmation of closing a document with active edits
- Added a small filter over the big white areas to ease-up on the user's eyes before the dark mode is added
---
## 0.1.2
### Bugfixes
- Fixed a safeguard for opening multiple overlapping dialogs unintentionally
### New features
- Reworked hierarchical left tree
- Added "Add under parent" button to the hierarchical tree, document page view, and quick search existing documents
- Added mouse button support and improved keyboard support to the hierarchical tree
- Reworked the top bar of the app to include tabs, window control elements, and basic menus of the app
- Added a check upon closing the app to avoid unintentional loss of data due to unsaved documents
### QoL adjustments
- Added middle-click closing for the tabs
- Added automatical opening of the project page after opening an existing project from a folder
- Reversed default custom sorting for the "Order" field in the left side tree
- Modified auto-closing behavior of hierarchical left tree nodes when moving/adding/removing documents
- Added a delay for tooltip popups on fields of documents
- Remove persistence from the document with an active edits confirmation dialog
- Unified graphical interface coloring of Quick-add and Quick-search dialogs to work consistently with the coloring of individual documents/document types same as the left hierarchical tree
---
## 0.1.1
### Bugfixes
- Fixed a bunch of typos
- Fixed names not changing with single/multi relationships if one gets name updated showing on the others properly
- Fixed forced lower-case for notes in lists and relationship fields
- Fixed a bug that prevented documents with the same names properly working in the hierarchical tree
### New features
- Added keyboard shortcut support
- Added quick-add new document pop-up
- Added quick-search existing document pop-up
- Added keybinds cheatsheet pop-up
- Added control buttons for keybinds cheatsheet, quick search, and quick add
- Added document coloring support for the document hierarchical tree and tabs on the top
- Added category/document switch for handling custom subcategories
- Added tooltip support for all input fields
- Added "Color picker" type field
- Added "Switch" type field
### QoL adjustments
- Alphabetically sorted most predefined lists (eg: types of political groups) with "Other/Unique" fields at the bottom. The fields that are ordered logically (eg: severity of racial weakness/strength) remain ordered via logical sorting and not by alphabet
- Added explanation via tooltip to "Belongs under", "Order" and "Color" fields
- Adjusted tooltip font-size to be actually readable
- Added program FAVICON support
- Moved the document edit/save/delete buttons to the top
- Adjusted text selection to look better with the aesthetics of the app
- Adjusted scrollbars to look better with the aesthetics of the app
- Added auto-focus on name field when opening edit mode of a document
- Added auto-focus AND auto-select of all text of the name field when creating a new document
- Renamed "Lore notes" to "Other/Notes" for more intuitive usage
- Renamed "Other names" to "Other names & Epithets" across all document types
- Renamed "Power level" to "Combat rating" in "Characters" document type
- Renamed "Level of sentience" to "Level of sapience" in "Species/Races/Flora/Fauna" document type
- Added "Oldest known" and "Average adulthood" fields to the "Species/Races/Flora/Fauna" document type
- Added "Continent" and "Landmass" to prefilled options to the "Location type" field in the "Locations" document type
- Added "Ethnicity" field in "Characters" document type
- Added "Titles" field in "Characters" document type
---
## 0.1.0
### Innitial release

676
src/i18n/en-US/documents/license.md Normal file
View file

@ -0,0 +1,676 @@
### GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc.
<https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.
### Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom
to share and change all versions of a program--to make sure it remains
free software for all its users. We, the Free Software Foundation, use
the GNU General Public License for most of our software; it applies
also to any other work released this way by its authors. You can apply
it to your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you
have certain responsibilities if you distribute copies of the
software, or if you modify it: responsibilities to respect the freedom
of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the
manufacturer can do so. This is fundamentally incompatible with the
aim of protecting users' freedom to change the software. The
systematic pattern of such abuse occurs in the area of products for
individuals to use, which is precisely where it is most unacceptable.
Therefore, we have designed this version of the GPL to prohibit the
practice for those products. If such problems arise substantially in
other domains, we stand ready to extend this provision to those
domains in future versions of the GPL, as needed to protect the
freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish
to avoid the special danger that patents applied to a free program
could make it effectively proprietary. To prevent this, the GPL
assures that patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
### TERMS AND CONDITIONS
#### 0. Definitions
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds
of works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of
an exact copy. The resulting work is called a "modified version" of
the earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user
through a computer network, with no transfer of a copy, is not
conveying.
An interactive user interface displays "Appropriate Legal Notices" to
the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
#### 1. Source Code
The "source code" for a work means the preferred form of the work for
making modifications to it. "Object code" means any non-source form of
a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users can
regenerate automatically from other parts of the Corresponding Source.
The Corresponding Source for a work in source code form is that same
work.
#### 2. Basic Permissions
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not convey,
without conditions so long as your license otherwise remains in force.
You may convey covered works to others for the sole purpose of having
them make modifications exclusively for you, or provide you with
facilities for running those works, provided that you comply with the
terms of this License in conveying all material for which you do not
control copyright. Those thus making or running the covered works for
you must do so exclusively on your behalf, under your direction and
control, on terms that prohibit them from making any copies of your
copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under the
conditions stated below. Sublicensing is not allowed; section 10 makes
it unnecessary.
#### 3. Protecting Users' Legal Rights From Anti-Circumvention Law
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such
circumvention is effected by exercising rights under this License with
respect to the covered work, and you disclaim any intention to limit
operation or modification of the work as a means of enforcing, against
the work's users, your or third parties' legal rights to forbid
circumvention of technological measures.
#### 4. Conveying Verbatim Copies
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
#### 5. Conveying Modified Source Versions
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these
conditions:
- a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
- b) The work must carry prominent notices stating that it is
released under this License and any conditions added under
section 7. This requirement modifies the requirement in section 4
to "keep intact all notices".
- c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
- d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
#### 6. Conveying Non-Source Forms
You may convey a covered work in object code form under the terms of
sections 4 and 5, provided that you also convey the machine-readable
Corresponding Source under the terms of this License, in one of these
ways:
- a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
- b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the Corresponding
Source from a network server at no charge.
- c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
- d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
- e) Convey the object code using peer-to-peer transmission,
provided you inform other peers where the object code and
Corresponding Source of the work are being offered to the general
public at no charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal,
family, or household purposes, or (2) anything designed or sold for
incorporation into a dwelling. In determining whether a product is a
consumer product, doubtful cases shall be resolved in favor of
coverage. For a particular product received by a particular user,
"normally used" refers to a typical or common use of that class of
product, regardless of the status of the particular user or of the way
in which the particular user actually uses, or expects or is expected
to use, the product. A product is a consumer product regardless of
whether the product has substantial commercial, industrial or
non-consumer uses, unless such uses represent the only significant
mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to
install and execute modified versions of a covered work in that User
Product from a modified version of its Corresponding Source. The
information must suffice to ensure that the continued functioning of
the modified object code is in no case prevented or interfered with
solely because modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or
updates for a work that has been modified or installed by the
recipient, or for the User Product in which it has been modified or
installed. Access to a network may be denied when the modification
itself materially and adversely affects the operation of the network
or violates the rules and protocols for communication across the
network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
#### 7. Additional Terms
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders
of that material) supplement the terms of this License with terms:
- a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
- b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
- c) Prohibiting misrepresentation of the origin of that material,
or requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
- d) Limiting the use for publicity purposes of names of licensors
or authors of the material; or
- e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
- f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions
of it) with contractual assumptions of liability to the recipient,
for any liability that these contractual assumptions directly
impose on those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions; the
above requirements apply either way.
#### 8. Termination
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your license
from a particular copyright holder is reinstated (a) provisionally,
unless and until the copyright holder explicitly and finally
terminates your license, and (b) permanently, if the copyright holder
fails to notify you of the violation by some reasonable means prior to
60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
#### 9. Acceptance Not Required for Having Copies
You are not required to accept this License in order to receive or run
a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
#### 10. Automatic Licensing of Downstream Recipients
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
#### 11. Patents
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims owned
or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within the
scope of its coverage, prohibits the exercise of, or is conditioned on
the non-exercise of one or more of the rights that are specifically
granted under this License. You may not convey a covered work if you
are a party to an arrangement with a third party that is in the
business of distributing software, under which you make payment to the
third party based on the extent of your activity of conveying the
work, and under which the third party grants, to any of the parties
who would receive the covered work from you, a discriminatory patent
license (a) in connection with copies of the covered work conveyed by
you (or copies made from those copies), or (b) primarily for and in
connection with specific products or compilations that contain the
covered work, unless you entered into that arrangement, or that patent
license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
#### 12. No Surrender of Others' Freedom
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under
this License and any other pertinent obligations, then as a
consequence you may not convey it at all. For example, if you agree to
terms that obligate you to collect a royalty for further conveying
from those to whom you convey the Program, the only way you could
satisfy both those terms and this License would be to refrain entirely
from conveying the Program.
#### 13. Use with the GNU Affero General Public License
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
#### 14. Revised Versions of this License
The Free Software Foundation may publish revised and/or new versions
of the GNU General Public License from time to time. Such new versions
will be similar in spirit to the present version, but may differ in
detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies that a certain numbered version of the GNU General Public
License "or any later version" applies to it, you have the option of
following the terms and conditions either of that numbered version or
of any later version published by the Free Software Foundation. If the
Program does not specify a version number of the GNU General Public
License, you may choose any version ever published by the Free
Software Foundation.
If the Program specifies that a proxy can decide which future versions
of the GNU General Public License can be used, that proxy's public
statement of acceptance of a version permanently authorizes you to
choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
#### 15. Disclaimer of Warranty
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
CORRECTION.
#### 16. Limitation of Liability
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
#### 17. Interpretation of Sections 15 and 16
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
### How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these
terms.
To do so, attach the following notices to the program. It is safest to
attach them to the start of each source file to most effectively state
the exclusion of warranty; and each file should have at least the
"copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper
mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands \`show w' and \`show c' should show the
appropriate parts of the General Public License. Of course, your
program's commands might be different; for a GUI interface, you would
use an "about box".
You should also get your employer (if you work as a programmer) or
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. For more information on this, and how to apply and follow
the GNU GPL, see <https://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your
program into proprietary programs. If your program is a subroutine
library, you may consider it more useful to permit linking proprietary
applications with the library. If this is what you want to do, use the
GNU Lesser General Public License instead of this License. But first,
please read <https://www.gnu.org/licenses/why-not-lgpl.html>.

15
src/i18n/en-US/index.ts
View file

@ -1,8 +1,23 @@
import { specialCharacterFixer } from '../specialCharactersFixer'
import T_helpInfo from './components/AppControlMenus/T_helpInfo'
import T_project from './components/AppControlMenus/T_project'
import T_tools from './components/AppControlMenus/T_tools'
import advancedSearchCheatSheet from './documents/advancedSearchCheatSheet.md'
import advancedSearchGuide from './documents/advancedSearchGuide.md'
import changeLog from './documents/changeLog.md'
import license from './documents/license.md'
export default {
// GLOBAL - DOCUMENTS
documents: {
advancedSearchCheatSheet: specialCharacterFixer(advancedSearchCheatSheet),
advancedSearchGuide: specialCharacterFixer(advancedSearchGuide),
changeLog: specialCharacterFixer(changeLog),
license: specialCharacterFixer(license)
},
// GLOBAL - APP TEXTS
app: {
name: 'FA - but in english!'

1
src/i18n/externalFileLoader.ts
View file

@ -5,5 +5,6 @@ export const i18n = createI18n({
locale: 'en-US',
fallbackLocale: 'en-US',
legacy: false,
warnHtmlMessage: false,
messages
})

12
src/i18n/specialCharactersFixer.ts Normal file
View file

@ -0,0 +1,12 @@
export const specialCharacterFixer = (inputString: string) => {
const specialCharacterList = [
'@',
'|'
]
specialCharacterList.forEach(Character => {
inputString = inputString.replaceAll(Character, `{'${Character}'}`)
})
return inputString
}

13
src/layouts/MainLayout.vue
View file

@ -39,18 +39,7 @@ import AppControlMenus from 'components/AppControlMenus/AppControlMenus.vue'
.appHeader {
-webkit-app-region: drag;
// Tweak so the menus will slide nicely behind the buttons
// Tweak, so the menus will slide nicely behind/from behind the top bar
z-index: 7000;
}
</style>
<style lang="scss">
// Unscoped due to impossibility of being matched with the rendered elements otherwise
.appHeader {
// Tweak for default white shadow rendering in the dark-mode variation of the element
.q-layout__shadow:after{
box-shadow: 0 0 10px 2px rgba(0, 0, 0, 0.2), 0 0px 10px rgba(0, 0, 0, 0.24) !important;
}
}
</style>

4
src/markdown.d.ts vendored Normal file
View file

@ -0,0 +1,4 @@
declare module '*.md' {
const value: string
export default value
}

3
src/pages/ComponentTesting.vue
View file

@ -8,6 +8,7 @@
</template>
<script lang="ts" setup>
import type { Component } from 'vue'
import { useRoute } from 'vue-router'
/**
@ -33,7 +34,7 @@ const componentList = import.meta.globEager('components/**/*.vue')
/**
* Placeholder variable for the matched component
*/
let currentComponent = null as unknown
let currentComponent: Component
/**
* Loops through the component list

12
src/pages/ErrorNotFound.vue
View file

@ -2,7 +2,7 @@
<div class="fullscreen bg-dark text-primary text-center q-pa-md flex column flex-center">
<GlobalWindowButtons />
<q-card
class="q-pl-xl q-pr-xl q-pb-xl"
class="q-pl-xl q-pr-xl q-pb-xl errorPage-card"
>
<q-card-section>
<h2 class="text-negative">
@ -38,3 +38,13 @@
import GlobalWindowButtons from 'src/components/GlobalWindowButtons/GlobalWindowButtons.vue'
import FantasiaMascotImage from 'src/components/FantasiaMascotImage/FantasiaMascotImage.vue'
</script>
<style lang="scss" scoped>
.errorPage-card{
border-radius: $qCard-errorPage-border-radius;
box-shadow: none;
border: $qCard-errorPage-border-size solid $qCard-errorPage-border-color;
background-color: $qCard-errorPage-background;
color: $qCard-errorPage-text;
}
</style>

7
src/pages/IndexPage.vue
View file

@ -2,11 +2,9 @@
<q-page class="row">
<FantasiaMascotImage width="400px" />
<div>
<button
@click="toggleDevTools()"
>
<router-link to="/testeee">
test
</button>
</router-link>
</div>
<div>
<div
@ -21,5 +19,4 @@
<script lang="ts" setup>
import FantasiaMascotImage from 'src/components/FantasiaMascotImage/FantasiaMascotImage.vue'
import { toggleDevTools } from 'src/scripts/appInfo/toggleDevTools'
</script>

8
src/scripts/appInfo/openDialogMarkdownDocument.ts Normal file
View file

@ -0,0 +1,8 @@
import { T_documentList } from 'app/interfaces/T_documentList'
import { S_DialogMarkdown } from 'app/src/stores/S_DialogMarkdown'
export const openDialogMarkdownDocument = (inputDocumentName: T_documentList) => {
S_DialogMarkdown.documentToOpen = inputDocumentName
S_DialogMarkdown.generateDialogUUID()
}

19
src/stores/S_DialogMarkdown.ts Normal file
View file

@ -0,0 +1,19 @@
import type { Ref } from 'vue'
import { T_documentList } from 'app/interfaces/T_documentList'
import { v4 as uuidv4 } from 'uuid'
import { defineStore } from 'pinia'
import { ref } from 'vue'
export const S_DialogMarkdown = defineStore('S_DialogMarkdown', () => {
const documentToOpen: Ref<T_documentList> = ref('license')
const dialogUUID: Ref<string> = ref('')
function generateDialogUUID () {
dialogUUID.value = uuidv4()
}
return { documentToOpen, dialogUUID, generateDialogUUID }
})()

10
src/stores/S_MainMenuState.ts Normal file
View file

@ -0,0 +1,10 @@
import type { Ref } from 'vue'
import { defineStore } from 'pinia'
import { ref } from 'vue'
export const S_MainMenuState = defineStore('S_MainMenuState', () => {
const mainMenuState: Ref<boolean> = ref(false)
return { mainMenuState }
})()

15
src/stores/example-store.ts
View file

@ -1,15 +0,0 @@
import { defineStore } from 'pinia'
export const useCounterStore = defineStore('counter', {
state: () => ({
counter: 0
}),
getters: {
doubleCount: (state) => state.counter * 2
},
actions: {
increment () {
this.counter++
}
}
})

933
yarn.lock
View file

File diff suppressed because it is too large Load diff