From: Banana Date: Mon, 5 Apr 2021 12:11:09 +0000 (+0200) Subject: adding first steps and some more visual cleanups. Adding also a new field X-Git-Tag: 1.1~10 X-Git-Url: http://91.132.146.200/gitweb/?a=commitdiff_plain;h=bf042061a378466a06d1ae082eb901e1e76eec54;p=bibliotheca-php.git adding first steps and some more visual cleanups. Adding also a new field --- diff --git a/CHANGELOG b/CHANGELOG index 8ff2014..b6b232e 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -30,6 +30,10 @@ * Advanced search has a table view option Displayed fields are configured in collection management. See notes there. * Updated installtion files + * Added first-steps.txt. Updated README + * Indication wich inputs are required + * Added a new field: Localized title + * After adding an entry the option to view or edit the entry is now available 1.0 - Castle 20210106 * First usable version diff --git a/README b/README index 807f285..7979514 100644 --- a/README +++ b/README @@ -9,6 +9,8 @@ about your collected stuff. Accessible and usable with a browser. Runs also off a Rapsberry Pi. Tag and category support. Fulltext search an individual fields per collection. +See first-steps.txt for first usage steps. + ## Technical information This is build and tested on a linux based OS. Windows support not yet, but it could work. diff --git a/documentation/first-steps.txt b/documentation/first-steps.txt new file mode 100644 index 0000000..ed509e0 --- /dev/null +++ b/documentation/first-steps.txt @@ -0,0 +1,31 @@ +After your installation and successfull login with the default user change your password. +This is done in the manage -> profile screen. + +Create your own user +There is no need to use the admin account for your daily doings. +To create a new user go to the manage -> user screen and fill the form. +More information about users and rights can be found in usermanagement-and-rights.txt + +Create your first collection +Choose manage -> collections to add your new collection. First make sure to fill the required fields +and save it. Adding fields and choosing default fields will only work after the creation of collection. + +Add fields to your collection +Choose manage -> collections and select the newly created collection from the right. +Click on the list icon (right from the pen icon) +Choose from the right which fields should be available in your collection by tragging them to the left. +Make sure that at least title, coverimage and description is available. Those are the basic fields +which are used to display entries. +On the left you can change the order of the fields. This order will used in the detail- and editview. +See fields.txt to read more about the fields and their features. +After saving you are good to go. + +Add an entry to your collection +Choose manage -> add. You will be presented a collection selection. Choose your newly created collection. +The following screen should match your selected fields and their order. +Input the required information and save. + +Now you have a working collection and also an entry in it. +That's it. + +Thank you for choosing bibliotheca! diff --git a/documentation/setup/bibliotheca.sql b/documentation/setup/bibliotheca.sql index b3cadd2..b6b4414 100644 --- a/documentation/setup/bibliotheca.sql +++ b/documentation/setup/bibliotheca.sql @@ -135,29 +135,30 @@ CREATE TABLE `#REPLACEME#_sys_fields` ( -- INSERT INTO `#REPLACEME#_sys_fields` (`id`, `identifier`, `displayname`, `type`, `searchtype`, `createstring`, `inputValidation`, `value`, `apiinfo`, `created`, `modificationuser`, `owner`, `group`, `rights`) VALUES -(1, 'title', 'Title', 'text', 'entryText', '`title` varchar(128) NOT NULL, ADD FULLTEXT (`title`)', '', NULL, 'string 128', '2019-09-01 18:26:33', 0, 1, 1, 'rw-r--r--'), -(2, 'description', 'Description', 'text3', 'entryText', '`description` varchar(255) NULL DEFAULT NULL, ADD FULLTEXT (`description`)', '', NULL, 'string 255', '2019-09-01 18:28:35', 0, 1, 1, 'rw-r--r--'), -(3, 'content', 'Main content', 'textarea', 'entryText', '`content` text NULL DEFAULT NULL, ADD FULLTEXT (`content`)', '', NULL, 'mysql text', '2019-09-01 18:28:35', 0, 1, 1, 'rw-r--r--'), -(5, 'tag', 'Tag', 'lookupmultiple', 'tag', NULL, '', NULL, 'string 64', '2019-09-01 19:11:18', 0, 1, 1, 'rw-r--r--'), -(6, 'category', 'Category', 'lookupmultiple', 'tag', NULL, '', NULL, 'string 64', '2019-09-01 19:11:18', 0, 1, 1, 'rw-r--r--'), -(7, 'publisher', 'Publisher', 'lookupmultiple', 'tag', NULL, 'allowSpace', NULL, 'string 64', '2019-09-01 19:17:51', 0, 1, 1, 'rw-r--r--'), -(8, 'developer', 'Developer', 'lookupmultiple', 'tag', NULL, 'allowSpace', NULL, 'string 64', '2019-09-01 19:17:51', 0, 1, 1, 'rw-r--r--'), -(9, 'platform', 'Platform', 'selection', 'entrySingleText', '`platform` varchar(32) NULL DEFAULT NULL', '', 'PC,Xbox,Playstation,Nintendo,Nintendo Switch', 'One of PC,Xbox,Playstation,Nintendo,Nintendo Switch', '2019-09-01 19:18:33', 0, 1, 1, 'rw-r--r--'), -(10, 'storage', 'Storage', 'lookupmultiple', 'tag', NULL, '', NULL, 'string 64', '2019-09-01 19:18:33', 0, 1, 1, 'rw-r--r--'), -(13, 'rating', 'Rating', 'selection', 'entrySingleText', '`rating` varchar(16) NULL DEFAULT NULL', '', '0/10,2/10,3/10,4/10,5/10,6/10,7/10,8/10,9/10,10/10', 'One of 0/10,2/10,3/10,4/10,5/10,6/10,7/10,8/10,9/10,10/10', '2019-09-01 19:25:35', 0, 1, 1, 'rw-r--r--'), -(14, 'year', 'Year', 'number', 'entrySingleNum', '`year` int(10) NULL, ADD INDEX (`year`)', '', NULL, 'int 10', '2019-09-01 19:30:11', 0, 1, 1, 'rw-r--r--'), -(15, 'coverimage', 'Cover image', 'upload', NULL, NULL, '', NULL, 'One file in $_FILES[uploads] of post', '2019-09-01 19:48:44', 0, 1, 1, 'rw-r--r--'), -(16, 'attachment', 'Attachments', 'upload_multiple', NULL, NULL, '', NULL, 'Multiple in $_FILES[uploads] of post', '2019-09-01 19:48:44', 0, 1, 1, 'rw-r--r--'), -(17, 'os', 'Operating system and version', 'selection', 'entrySingleNum', '`os` varchar(32) NULL DEFAULT NULL', '', 'Windows 10,Windows 95, Windows 99,Windows XP, Windows ME, Windows 2000,Windows Vista,Windows 8', 'One of Windows 10,Windows 95, Windows 99,Windows XP, Windows ME, Windows 2000,Windows Vista,Windows 8', '2019-09-01 19:55:13', 0, 1, 1, 'rw-r--r--'), -(18, 'actors', 'Actors', 'lookupmultiple', 'tag', NULL, 'allowSpace', NULL, 'string 64', '2020-07-26 07:12:48', NULL, 1, 1, 'rw-r--r--'), -(19, 'countries', 'Countries', 'lookupmultiple', 'tag', NULL, 'allowSpace', NULL, 'string 64', '2020-07-26 07:16:08', NULL, 1, 1, 'rw-r--r--'), -(20, 'directors', 'Directors', 'lookupmultiple', 'tag', NULL, 'allowSpace', NULL, 'string 64', '2020-07-26 07:17:59', NULL, 1, 1, 'rw-r--r--'), -(21, 'genres', 'Genres', 'lookupmultiple', 'tag', NULL, '', NULL, 'string 64', '2020-07-26 07:18:55', NULL, 1, 1, 'rw-r--r--'), -(22, 'languages', 'Languages', 'lookupmultiple', 'tag', NULL, '', NULL, 'string 64', '2020-07-26 07:20:45', NULL, 1, 1, 'rw-r--r--'), -(23, 'runtime', 'Runtime (min)', 'number', 'entrySingleNum', '`runtime` int(10) NULL, ADD INDEX (`runtime`)', '', NULL, 'int 10', '2020-07-26 07:22:24', NULL, 1, 1, 'rw-r--r--'), -(24, 'imdbrating', 'IMDB Rating', 'text', 'entrySingleText', '`imdbrating` varchar(128) NULL DEFAULT NULL', '', NULL, 'string 128', '2020-12-27 10:00:33', 0, 1, 1, 'rw-r--r--'), -(25, 'viewcount', 'View counter', 'number', 'entrySingleNum', '`viewcount` int(10) NULL, ADD INDEX (`viewcount`)', '', NULL, 'int 10', '2020-12-27 10:41:10', 0, 1, 1, 'rw-r--r--'), -(26, 'writers', 'Writers', 'lookupmultiple', 'tag', NULL, 'allowSpace', NULL, 'string 64', '2021-01-05 09:47:20', NULL, 1, 1, 'rw-r--r--'); +(1, 'title', 'Title', 'text', 'entryText', '`title` varchar(128) NOT NULL, ADD FULLTEXT (`title`)', '', NULL, 'string 128', NOW(), 0, 1, 1, 'rw-r--r--'), +(2, 'description', 'Description', 'text3', 'entryText', '`description` varchar(255) NULL DEFAULT NULL, ADD FULLTEXT (`description`)', '', NULL, 'string 255', NOW(), 0, 1, 1, 'rw-r--r--'), +(3, 'content', 'Main content', 'textarea', 'entryText', '`content` text NULL DEFAULT NULL, ADD FULLTEXT (`content`)', '', NULL, 'mysql text', NOW(), 0, 1, 1, 'rw-r--r--'), +(5, 'tag', 'Tag', 'lookupmultiple', 'tag', NULL, '', NULL, 'string 64', NOW(), 0, 1, 1, 'rw-r--r--'), +(6, 'category', 'Category', 'lookupmultiple', 'tag', NULL, '', NULL, 'string 64', NOW(), 0, 1, 1, 'rw-r--r--'), +(7, 'publisher', 'Publisher', 'lookupmultiple', 'tag', NULL, 'allowSpace', NULL, 'string 64', NOW(), 0, 1, 1, 'rw-r--r--'), +(8, 'developer', 'Developer', 'lookupmultiple', 'tag', NULL, 'allowSpace', NULL, 'string 64', NOW(), 0, 1, 1, 'rw-r--r--'), +(9, 'platform', 'Platform', 'selection', 'entrySingleText', '`platform` varchar(32) NULL DEFAULT NULL', '', 'PC,Xbox,Playstation,Nintendo,Nintendo Switch', 'One of PC,Xbox,Playstation,Nintendo,Nintendo Switch', NOW(), 0, 1, 1, 'rw-r--r--'), +(10, 'storage', 'Storage', 'lookupmultiple', 'tag', NULL, '', NULL, 'string 64', NOW(), 0, 1, 1, 'rw-r--r--'), +(13, 'rating', 'Rating', 'selection', 'entrySingleText', '`rating` varchar(16) NULL DEFAULT NULL', '', '0/10,2/10,3/10,4/10,5/10,6/10,7/10,8/10,9/10,10/10', 'One of 0/10,2/10,3/10,4/10,5/10,6/10,7/10,8/10,9/10,10/10', NOW(), 0, 1, 1, 'rw-r--r--'), +(14, 'year', 'Year', 'number', 'entrySingleNum', '`year` int(10) NULL, ADD INDEX (`year`)', '', NULL, 'int 10', NOW(), 0, 1, 1, 'rw-r--r--'), +(15, 'coverimage', 'Cover image', 'upload', NULL, NULL, '', NULL, 'One file in $_FILES[uploads] of post', NOW(), 0, 1, 1, 'rw-r--r--'), +(16, 'attachment', 'Attachments', 'upload_multiple', NULL, NULL, '', NULL, 'Multiple in $_FILES[uploads] of post', NOW(), 0, 1, 1, 'rw-r--r--'), +(17, 'os', 'Operating system and version', 'selection', 'entrySingleNum', '`os` varchar(32) NULL DEFAULT NULL', '', 'Windows 10,Windows 95, Windows 99,Windows XP, Windows ME, Windows 2000,Windows Vista,Windows 8', 'One of Windows 10,Windows 95, Windows 99,Windows XP, Windows ME, Windows 2000,Windows Vista,Windows 8', NOW(), 0, 1, 1, 'rw-r--r--'), +(18, 'actors', 'Actors', 'lookupmultiple', 'tag', NULL, 'allowSpace', NULL, 'string 64', NOW(), NULL, 1, 1, 'rw-r--r--'), +(19, 'countries', 'Countries', 'lookupmultiple', 'tag', NULL, 'allowSpace', NULL, 'string 64', NOW(), NULL, 1, 1, 'rw-r--r--'), +(20, 'directors', 'Directors', 'lookupmultiple', 'tag', NULL, 'allowSpace', NULL, 'string 64', NOW(), NULL, 1, 1, 'rw-r--r--'), +(21, 'genres', 'Genres', 'lookupmultiple', 'tag', NULL, '', NULL, 'string 64', NOW(), NULL, 1, 1, 'rw-r--r--'), +(22, 'languages', 'Languages', 'lookupmultiple', 'tag', NULL, '', NULL, 'string 64', NOW(), NULL, 1, 1, 'rw-r--r--'), +(23, 'runtime', 'Runtime (min)', 'number', 'entrySingleNum', '`runtime` int(10) NULL, ADD INDEX (`runtime`)', '', NULL, 'int 10', NOW(), NULL, 1, 1, 'rw-r--r--'), +(24, 'imdbrating', 'IMDB Rating', 'text', 'entrySingleText', '`imdbrating` varchar(128) NULL DEFAULT NULL', '', NULL, 'string 128', NOW(), 0, 1, 1, 'rw-r--r--'), +(25, 'viewcount', 'View counter', 'number', 'entrySingleNum', '`viewcount` int(10) NULL, ADD INDEX (`viewcount`)', '', NULL, 'int 10', NOW(), 0, 1, 1, 'rw-r--r--'), +(26, 'writers', 'Writers', 'lookupmultiple', 'tag', NULL, 'allowSpace', NULL, 'string 64', NOW(), NULL, 1, 1, 'rw-r--r--'), +(27, 'localizedTitle', 'localized Title', 'text', 'entryText', '`localizedTitle` varchar(128) NOT NULL, ADD FULLTEXT (`localizedTitle`)', '', NULL, 'string 128', NOW(), '0', '1', '1', 'rw-r--r--'); -- -------------------------------------------------------- @@ -351,7 +352,7 @@ ALTER TABLE `#REPLACEME#_menu` -- AUTO_INCREMENT for table `#REPLACEME#_sys_fields` -- ALTER TABLE `#REPLACEME#_sys_fields` - MODIFY `id` int NOT NULL AUTO_INCREMENT, AUTO_INCREMENT=27; + MODIFY `id` int NOT NULL AUTO_INCREMENT, AUTO_INCREMENT=28; -- -- AUTO_INCREMENT for table `#REPLACEME#_tool` diff --git a/documentation/setup/install.txt b/documentation/setup/install.txt index dc8a67f..5c52a34 100644 --- a/documentation/setup/install.txt +++ b/documentation/setup/install.txt @@ -13,8 +13,8 @@ Edit and fill in the DB details. Change PATH_ABSOLUTE to you installation path and PATH_WEB_STORAGE relative to your webroot. -Copy config-imdb.php.default to config-imdb.php. Read the tools.txt and tool-imdbweb.txt and make wanted changes -to that file +Copy config-imdb.php.default to config-imdb.php. +Read the tools.txt and tool-imdbweb.txt and make wanted changes to that file 4. Move files Move the content of webclient folder to your webspace. Make sure the location matches diff --git a/upgrade/from-version-1.0.txt b/upgrade/from-version-1.0.txt index d71d0d3..b94f1c6 100644 --- a/upgrade/from-version-1.0.txt +++ b/upgrade/from-version-1.0.txt @@ -34,6 +34,7 @@ UPDATE `#REPLACEME#_sys_fields` SET `inputValidation` = 'allowSpace' WHERE `bib_ UPDATE `#REPLACEME#_sys_fields` SET `inputValidation` = 'allowSpace' WHERE `bib_sys_fields`.`id` = 26; ALTER TABLE `#REPLACEME#_collection` ADD `advancedSearchTableFields` VARCHAR(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NULL DEFAULT NULL AFTER `defaultSortField`; ALTER TABLE `#REPLACEME#_sys_fields` ADD UNIQUE (`identifier`); +INSERT INTO `#REPLACEME#_sys_fields` (`id`, `identifier`, `displayname`, `type`, `searchtype`, `createstring`, `inputValidation`, `value`, `apiinfo`, `created`, `modificationuser`, `owner`, `group`, `rights`) VALUES (NULL, 'localizedTitle', 'localized Title', 'text', 'entryText', '`localizedTitle` varchar(128) NOT NULL, ADD FULLTEXT (`localizedTitle`)', '', NULL, 'string 128', NOW(), '0', '1', '1', 'rw-r--r--'); # 6 Update your collection settings. There are new options which should be set. diff --git a/webclient/view/default/managecolletions/managecolletions.html b/webclient/view/default/managecolletions/managecolletions.html index 513b17a..16b5ee9 100644 --- a/webclient/view/default/managecolletions/managecolletions.html +++ b/webclient/view/default/managecolletions/managecolletions.html @@ -5,7 +5,7 @@

Add or modify a collection

- +
- +
diff --git a/webclient/view/default/manageentry/manageentry.html b/webclient/view/default/manageentry/manageentry.html index a8b054f..2a72f81 100644 --- a/webclient/view/default/manageentry/manageentry.html +++ b/webclient/view/default/manageentry/manageentry.html @@ -5,7 +5,8 @@ if(!empty($TemplateData['editFields'])) { $_entry = $TemplateData['editData']['id']; ?>

Update an entry in:

-

+

+ View entry

diff --git a/webclient/view/default/manageentry/manageentry.php b/webclient/view/default/manageentry/manageentry.php index ea44208..3abed0a 100644 --- a/webclient/view/default/manageentry/manageentry.php +++ b/webclient/view/default/manageentry/manageentry.php @@ -130,7 +130,7 @@ if(!empty($_collection)) { if (!empty($_fieldsToSave) && isset($_fieldsToSave['title'])) { $do = $ManageEntry->create($_fieldsToSave, $_owner, $_group, $_rights); if (!empty($do)) { - $TemplateData['message']['content'] = "View your new entry"; + $TemplateData['message']['content'] = "View your new entry | Edit your new entry"; $TemplateData['message']['status'] = "success"; } else { // use editData to display given data diff --git a/webclient/view/default/managegroups/managegroups.html b/webclient/view/default/managegroups/managegroups.html index d4e349b..47ea833 100644 --- a/webclient/view/default/managegroups/managegroups.html +++ b/webclient/view/default/managegroups/managegroups.html @@ -4,14 +4,14 @@

Add or modify a group

- +
- +
diff --git a/webclient/view/default/manageusers/manageusers.html b/webclient/view/default/manageusers/manageusers.html index a08d8da..f8dc2fb 100644 --- a/webclient/view/default/manageusers/manageusers.html +++ b/webclient/view/default/manageusers/manageusers.html @@ -4,27 +4,27 @@

Add or modify a user

- +
- +
- +
- +