<?php
/*
// OPDS basic gestion (only add entities and relations, not modify)
// Version: 0.1
// Pierre FAUQUE, <pierre@fauque.net>
// Script: 2014, Script->Class: 2019, Gestion: may 2020
// Encoding: UTF-8
// Text editor: GNU/Linux Debian Vi
// File: doc_ddic.php (v0.1)
// Role: Documentation, dictionary of data
*/
require("init.php");
require("lib_lddocs.php");
?><!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Data dictionary</title>
<link rel="stylesheet" href="opds.css" type="text/css" />
<style type="text/css">
.fc { font-family:courier; font-size:0.9em; color:#000090} /* fixed width characters */
</style>
</head>
<body>
<table border="0" width="100%">
<tr>
<td class="cmen">
<?php menu(); ?></td>
<td class="cont">
<h1>DOC: Data dictionary</h1>
<pre>
<span style="font-weight:bold; color:red">primary keys</span>
<span style="font-style:italic; color:blue">foreign keys</span>
ascii = "abcdefghijklmnopqrstuvwxyz" .................... (in lower or uppsercase)
letters = "abcdefghijklmnopqrstuvwxyzàâäéèêëîïôöùûüç" ..... (in lower or uppsercase)
digits = "0123456789"</pre>
<div style="font-family:arial;font-size:1em"><span style="font-weight:bold;">Important indormation</span> at the <a href="#imp">end of the page</a></div>
<pre> Fields Signification authorized characters
-------------------------------------------------------------------------------------------------------------------------------------------------------
opds_Authors.bdate ............ Date of birth ............................ digits + "-"
opds_Authors.bio .............. Author's brief description ............... letters + digits + ",.;:!? -+*/'_@=\n\"()[]$£#§"
opds_Authors.ddate ............ Date of death ............................ digits + "-"
opds_Authors.fname ............ Author's firstname ....................... letters + "- '"
<span style="font-weight:bold; color:red">opds_Authors.idaut</span> ............ Author ID ................................ numeric auto_increment value (1, 2, 3, ...)
opds_Authors.lname ............ Author's lastname ........................ letters + "- '"
opds_Authors.upda ............. Date of registration update .............. generated timestamp (YYYY-MM-DD HH:MN:SS)
opds_Authors.uri .............. URL of the author's page ................. ascii + digits + "_-:/.?=%+"
opds_Categories.active ........ Displayable in the web catalog (0|1) ..... selected numeric value in a list (0|1)
opds_Categories.cat ........... Category label ........................... letters + digits + " '-"
opds_Categories.descc ......... Brief description ........................ letters + digits + ",.;:!? -+*/'_@=\"()[]$£#§"
<span style="font-weight:bold; color:red">opds_Categories.idcat</span> ......... Category ID .............................. numeric auto_increment value (1, 2, 3, ...)
opds_Categories.updc .......... Date of registration update .............. generated timestamp (YYYY-MM-DD HH:MN:SS)
opds_Config.key ............... Configuration item label ................. defined texts: author,rootsite,rootopds,docsdir,imgdir,authdir,email,favicon
opds_Config.statut ............ Necessity of the field ................... defined texts: "mandatory" or "optional"
opds_Config.value ............. Configuration item value :
author ............................... letters + "' -"
rootsite ............................. ascii + digits + ":/_-."
rootopds ............................. ascii + digits + "/_"
docsdir .............................. ascii + digits + "_"
imgdir ............................... ascii + digits + "_"
authdir .............................. ascii + digits + "_"
email ................................ ascii + digits + "@_-.+"
favicon .............................. ascii + digits + "/_.-"
opds_Documents.active ......... Displayable in the web catalog (0|1) ..... selected numeric value in a list (0|1)
opds_Documents.descd .......... Document description ..................... letters + digits + ",.;:!? -+*/'_@=\n\"()[]$£#§"
<span style="font-weight:bold; color:red">opds_Documents.iddoc</span> .......... Document ID .............................. numeric auto_increment value (1, 2, 3, ...)
<span style="font-style:italic; color:blue">opds_Documents.idscat</span> ......... Sub-category ID .......................... selected numeric value in a list
opds_Documents.issued ......... Year/Date of issue ....................... letters + digits + " .-/"
opds_Documents.title .......... Document title ........................... letters + digits + "'- .(),$%?!:"
opds_Documents.updd ........... Date of registration update .............. generated timestamp (YYYY-MM-DD HH:MN:SS)
<span style="font-weight:bold; color:red">opds_Keywords.idkw</span> ............ Keyword ID ............................... numeric auto_increment value (1, 2, 3, ...)
opds_Keywords.keyword ......... Keyword label ............................ letters + digits + "-_ '"
opds_PublishedIn.descpe ....... Ebook description ........................ letters + digits + ",.;:!? -+*/'_@=\n\"()[]$£#§"
opds_PublishedIn.filename ..... Filename of the ebook .................... ascii + digits + "-_!."
<span style="font-weight:bold; color:red">opds_PublishedIn.iddoc</span> ........ Document ID .............................. selected numeric value in a list
<span style="font-weight:bold; color:red">opds_PublishedIn.idtype</span> ....... Type ID of the ebook ..................... selected numeric value in a list
opds_PublishedIn.lang ......... Language of the document ................. ascii
opds_PublishedIn.thumb ........ Filename of the thumbnail ................ ascii + digits + "-_!."
opds_PublishedIn.updpe ........ Date of registration update .............. generated timestamp (YYYY-MM-DD HH:MN:SS)
<span style="font-weight:bold; color:red">opds_References.iddoc</span> ......... Document ID .............................. selected numeric value in a list
<span style="font-weight:bold; color:red">opds_References.idkw</span> .......... Keyword ID ............................... selected numeric value in a list
opds_SCategories.active ....... Displayable in the web catalog (0|1) ..... selected numeric value in a list (0|1)
opds_SCategories.descsc ....... Brief description ........................ letters + digits + ",.;:!? -+*/'_@=\"()[]$£#§"
<span style="font-style:italic; color:blue">opds_SCategories.idcat</span> ........ Category ID .............................. selected numeric value in a list
<span style="font-weight:bold; color:red">opds_SCategories.idscat</span> ....... Sub-catgory ID ........................... numeric auto_increment value (1, 2, 3, ...)
opds_SCategories.scat ......... Sub-category label ....................... letters + digits + " '-"
opds_SCategories.updsc ........ Date of registration update .............. generated timestamp (YYYY-MM-DD HH:MN:SS)
opds_Types.format ............. Format to use ............................ ascii + digits + "-_+."
<span style="font-weight:bold; color:red">opds_Types.idtype</span> ............. Ebook type ID ............................ numeric auto_increment value (1, 2, 3, ...)
opds_Types.type ............... Ebook Type label ......................... ascii
<span style="font-weight:bold; color:red">opds_Write.idaut</span> .............. Author ID ................................ selected numeric value in a list
<span style="font-weight:bold; color:red">opds_Write.iddoc</span> .............. Document ID .............................. selected numeric value in a list
</pre>
<div style="width:850px">
<a name="imp"><span style="font-weight:bold;">Important informations</span></a>
<p>The authorized characters are written in the 'functions.js' file, in 'ascii', 'letters' and 'digits' variables (as indicated at the top of the page). If, in an entry page, a field requires additional characters, they are added to the variable '<span class="fc">ca_<field-name></span>' (ex: <span class="fc">ca_descc = letters + digits + ",.;:!? -+*/'_@=\"()[]$£#§"</span> or <span class="fc">ca_mail = ascii + digits + "@_-.+"</span>) in the pages.</p>
<p>If you write a language that regularly uses accented letters not mentioned in the javascript variable 'letters', add them there.<p>
<p>Please note that certain characters are not authorized in the OPDS catalogs. For example, the character ampersand ( & ) in a description or a title or in another field, causes an error when consulting the catalog.</p>
</div>
</td>
</tr>
</table>
<p> </p>
<p> </p>
</body>
</html>
|
Download
