User Manual - Revision history

Admin: /* Add / Edit Poem */

2023-09-06T06:57:57Z

Add / Edit Poem

← Older revision		Revision as of 06:57, 6 September 2023
Line 62:		Line 62:

	Phase-based annotations match phases in a poem, and the annotations may be shared across poems containing the same phases.		Phase-based annotations match phases in a poem, and the annotations may be shared across poems containing the same phases.
	[[File:~~ManagePhaseBasedAnnotations~~.png\|center\|~~thumb\|Manage Phase-~~based ~~Annotations~~]]		[[File:PoetryEdit2.png\|center\|phase based annotations]]
	Through clicking "Suggest ~~Numbered~~ Annotations" the app will scan the poem for matching existing annotations, then you may select matched annotations and associate with the poem.

			Through clicking "Suggest Annotations" the app will scan the poem for matching existing annotations, then you may select matched annotations and associate with the poem.

	=== Albums ===		=== Albums ===

Admin at 00:44, 28 October 2022

2022-10-28T00:44:19Z

← Older revision		Revision as of 00:44, 28 October 2022
Line 1:		Line 1:
	The ~~UIk~~ of Poetry MP is designed for PC monitors and tablets, while the UI of Poetry Viewer is designed for PC monitors, tablets and mobile phones.		The UI of Poetry MP is designed for PC monitors and tablets, while the UI of Poetry Viewer is designed for PC monitors, tablets and mobile phones.

	== Startup ==		== Startup ==

Admin: /* Login */

2022-10-27T12:05:15Z

← Older revision		Revision as of 12:05, 27 October 2022
Line 13:		Line 13:
	Without login, the users can view published poems only.		Without login, the users can view published poems only.

	The default password for user admin after installation is "~~adminPpp~~*8" and you should alter the password ASAP, and keep the new password in a safe place.		The default password for user admin after installation is "Pppppp*8" and you should alter the password ASAP, and keep the new password in a safe place.

	=== Managing Users ===		=== Managing Users ===

0:0:0:0:0:0:0:1: /* Startup */

2022-10-12T20:50:23Z

Startup

← Older revision		Revision as of 20:50, 12 October 2022
Line 1:		Line 1:
	The UI of Poetry MP is designed for PC monitors and tablets, while the UI of Poetry Viewer is designed for PC monitors, tablets and mobile phones.		The UIk of Poetry MP is designed for PC monitors and tablets, while the UI of Poetry Viewer is designed for PC monitors, tablets and mobile phones.

	== Startup ==		== Startup ==

Admin: 12 revisions imported

2022-10-11T20:29:36Z

12 revisions imported

← Older revision	Revision as of 20:29, 11 October 2022
(No difference)

Admin>Soulmate: /* Maintenance */

2022-10-03T05:08:56Z

Maintenance

← Older revision		Revision as of 05:08, 3 October 2022
Line 82:		Line 82:
	== Maintenance ==		== Maintenance ==
	From time to time, you may need to adjust some settings, backup, export data, or manage locally hosted pictures etc. Please check [[Maintenance]] for more details.		From time to time, you may need to adjust some settings, backup, export data, or manage locally hosted pictures etc. Please check [[Maintenance]] for more details.

	~~== Export ==~~
	~~[[File:Export functions.png\|thumb\|Export functions]]~~
	The export functions could be used to export the poetry collection into JSON files and export all images into a zip file, then you download to a local drive for backup or publishing to a static Website.

	~~=== Export All ===~~
	This will result in downloading the poetry collection including settings in a JSON file. And the data in the JSON file can be used as a backup or become the data in a static Website for publishing. If your poetry collection contain locally hosted images, you may also need to "Export All Images".

	~~=== Export All Published ===~~
	This command is available when "Settings/Edit/Use Published Date" is on. For deceased poets or poems published decades ago, published date is likely insignificant. If you have poems in draft, you may not want to publish them yet, then this command could be useful.
	~~[[File:Published Date.png\|center\|Published Date]]~~
	~~A poem is published if the date published is defined.~~

	~~=== Export All Images ===~~
	If you had uploaded images into the database, you should export all images into a zip file. The zip file could be used as a backup or become the content of the static Website that you use for publishing.

	~~== Backup ==~~

	~~This basically download the poetry database which is with Sqlite database engine.~~

	~~=== Sqlite Database File ===~~
	If you install PoetryApp MP as local desktop app, you may close the app and go to app's sub folder "PoetryApp_Data" and copy file poems.db to your backup drive. And it is better to name the backup file as "poemsYYYYMMDD.db" like "poems20211023.db".

	~~=== JSON File and Optional Images.zip ===~~
	~~The exported JSON file and the optional images.zip could be used as backup to be restored into a blank poems.db.~~

	~~To restore the database, please check '''[[Restore]]'''.~~

	~~== Settings ==~~

	~~=== Author ===~~
	~~PoetryApp is designed for one poet, and you may input the basic poet info here.~~

	~~=== Poetry ===~~
	~~This section defines some language attributes of the poetry collection. It is optional to define the attributes.~~

	~~For Chinese poetry, the situation could be more complex. For more details, check [[Settings for Chinese Poetry]].~~

	~~=== Edit ===~~
	~~When editing a poem, you may apply multiple optional attributes to the poem.~~

	~~=== View ===~~
	The settings affect how the poem viewer displays the attributes of a poem. The settings defined here are stored in Web browser's local storage, not in the DB, thus the settings are effective as per the browser.

	~~== Annotations Management ==~~
	~~[[File:Annotations management.png\|thumb\|annotations management]]~~
	~~Since phase-based annotations may be shared among poems, this is a center for managing annotations.~~

	~~The number associated with each chip indicate how many poems are referencing the same annotation.~~

	~~When you click a chip, you may edit the annotation. Or, if you change the "Click-Chip Action" to "List Poems", clicking a chip results in listing all poems referencing the same annotation.~~

	~~== Local Pictures Management ==~~
	~~[[File:Pictures Management.png\|thumb\|Pictures Management]]~~
	~~This is a center for managing locally hosted images which were uploaded and stored in the database.~~

	~~The number associated with an image is to indicate how many poems are referencing the image, while the poems are listed as chips. Clicking a chip will display the respective poems then you may edit.~~

	~~Since the poem is loading to HTML img tag like:<syntaxhighlight lang="html">~~
	~~<img class="local" src="api/files/file/e65bb512-1a9d-4a78-ac9e-83d74fbf9e8c.jpeg" alt="Pallas Athena" loading="lazy" decoding="async">~~
	</syntaxhighlight>However, the references recorded in the database and the references in HTML codes may lost sync from time to time, for example, you had removed respective HTML tags. Then you need to audit.

	~~=== Audit ===~~
	~~The app will scan associated poems to find out if the image is really referenced in each poem.~~

	~~=== Audit All ===~~
	~~The app will scan all poems to find out if any hosted image is not referenced in any poem.~~

	~~=== Audit and Reconcile ===~~
	~~Audit all, then remove orphaned images from the database.~~

	~~== External Pictures Management ==~~
	~~[[File:External Pictures.png\|thumb\|External Pictures]]~~
	~~A poem may contain images from external source, like:<syntaxhighlight lang="html">~~
	<img width="512" alt="RenÃ©-Antoine Houasse - The Dispute of Minerva and Neptune, 1689" src="https://upload.wikimedia.org/wikipedia/commons/thumb/1/10/Ren%C3%A9-Antoine_Houasse_-_The_Dispute_of_Minerva_and_Neptune%2C_1689.jpg/512px-Ren%C3%A9-Antoine_Houasse_-_The_Dispute_of_Minerva_and_Neptune%2C_1689.jpg">
	~~</syntaxhighlight>This module will scan all poems and list poems referencing external images.~~

	~~=== Remote to Local ===~~
	This will download the external picture and save to the database, and make the respective HTML img tag reference to the locally hosted image. And the description will be come the alt attribute of element img.

	~~'''Remarks:'''~~

	~~It is entirely your responsibility to sort our the copyright issues of the images used in the content.of poetry, through referencing or locally hosting.~~

Admin>Soulmate: /* Backup (Under construction) */

2022-10-03T05:07:11Z

Backup (Under construction)

← Older revision		Revision as of 05:07, 3 October 2022
Line 15:		Line 15:
	The default password for user admin after installation is "adminPpp*8" and you should alter the password ASAP, and keep the new password in a safe place.		The default password for user admin after installation is "adminPpp*8" and you should alter the password ASAP, and keep the new password in a safe place.

	=== Managing Users ~~(Under Construction)~~ ===		=== Managing Users ===
			[[File:After Login.png\|thumb\|After Login]]
			Since the app is for one poet, generally you just need one user admin. In case you may more than one to manage, you may create extra users.

	[[File:AfterLogin.png\|thumb\|AfterLogin]]		[[File:AfterLogin.png\|thumb\|AfterLogin]]

Line 76:		Line 79:
	To quit, click this button highlighted:		To quit, click this button highlighted:
	[[File:Deselect album.png\|center\|frameless\|Deselect album]]		[[File:Deselect album.png\|center\|frameless\|Deselect album]]

			== Maintenance ==
			From time to time, you may need to adjust some settings, backup, export data, or manage locally hosted pictures etc. Please check [[Maintenance]] for more details.

	== Export ==		== Export ==
Line 92:		Line 98:
	If you had uploaded images into the database, you should export all images into a zip file. The zip file could be used as a backup or become the content of the static Website that you use for publishing.		If you had uploaded images into the database, you should export all images into a zip file. The zip file could be used as a backup or become the content of the static Website that you use for publishing.

	== Backup ~~(Under construction)~~ ==		== Backup ==

	This basically download the poetry database which is with Sqlite database engine.		This basically download the poetry database which is with Sqlite database engine.
Line 102:		Line 108:
	The exported JSON file and the optional images.zip could be used as backup to be restored into a blank poems.db.		The exported JSON file and the optional images.zip could be used as backup to be restored into a blank poems.db.

	To restore the database, please check [[Restore]].		To restore the database, please check '''[[Restore]]'''.

	== Settings ==		== Settings ==

Admin>Soulmate: /* Audit and Reconcile */

2022-10-03T01:27:21Z

Audit and Reconcile

← Older revision		Revision as of 01:27, 3 October 2022
Line 146:		Line 146:
	=== Audit and Reconcile ===		=== Audit and Reconcile ===
	Audit all, then remove orphaned images from the database.		Audit all, then remove orphaned images from the database.

			== External Pictures Management ==
			[[File:External Pictures.png\|thumb\|External Pictures]]
			A poem may contain images from external source, like:<syntaxhighlight lang="html">
			<img width="512" alt="RenÃ©-Antoine Houasse - The Dispute of Minerva and Neptune, 1689" src="https://upload.wikimedia.org/wikipedia/commons/thumb/1/10/Ren%C3%A9-Antoine_Houasse_-_The_Dispute_of_Minerva_and_Neptune%2C_1689.jpg/512px-Ren%C3%A9-Antoine_Houasse_-_The_Dispute_of_Minerva_and_Neptune%2C_1689.jpg">
			</syntaxhighlight>This module will scan all poems and list poems referencing external images.

			=== Remote to Local ===
			This will download the external picture and save to the database, and make the respective HTML img tag reference to the locally hosted image. And the description will be come the alt attribute of element img.

			'''Remarks:'''

			It is entirely your responsibility to sort our the copyright issues of the images used in the content.of poetry, through referencing or locally hosting.

Admin>Soulmate: /* Backup (Under construction) */

2022-10-03T01:06:28Z

Backup (Under construction)

@@ Line 96: / Line 96: @@
 This basically download the poetry database which is with Sqlite database engine.
-To restore the database, please check .....
+=== Sqlite Database File ===
 == Settings ==
@@ Line 113: / Line 119: @@
 === View ===
 The settings affect how the poem viewer displays the attributes of a poem. The settings defined here are stored in Web browser's local storage, not in the DB, thus the settings are effective as per the browser.

Admin>Soulmate: /* Edit */

2022-10-01T05:43:18Z

Edit

← Older revision		Revision as of 05:43, 1 October 2022
Line 14:		Line 14:

	The default password for user admin after installation is "adminPpp*8" and you should alter the password ASAP, and keep the new password in a safe place.		The default password for user admin after installation is "adminPpp*8" and you should alter the password ASAP, and keep the new password in a safe place.

			=== Managing Users (Under Construction) ===
	[[File:AfterLogin.png\|thumb\|AfterLogin]]		[[File:AfterLogin.png\|thumb\|AfterLogin]]

Line 107:		Line 109:

	=== Edit ===		=== Edit ===
			When editing a poem, you may apply multiple optional attributes to the poem.

	=== View ===		=== View ===
			The settings affect how the poem viewer displays the attributes of a poem. The settings defined here are stored in Web browser's local storage, not in the DB, thus the settings are effective as per the browser.