Skip to content

Latest commit

 

History

History
146 lines (125 loc) · 12.1 KB

README.md

File metadata and controls

146 lines (125 loc) · 12.1 KB

PLX_EBook (runs with PluXml >= 5.8.7. | compatible plx_gc_categorie & vip_zone)

Turns PluXml into an epub editor , allows you to save entirely or partially your site into epubs and make them avalaible for download.


Modifs en cours:

[+] 19/04/2023

  • Nettoyage des titre (") si injecté dans un attribut
  • reorganisation des formulaires dans la config
  • modif visuel des onglet passés en fléche.
  • option: bref descriptif/aide de l'onglet/étape ouvert(e).

[+] 04/05/2022

  • fix wrong mimetype for woff & woff2 (EBook.php)
  • timestamp on loading drawcover.xml (config.php)
  • MAJ html bouton delete epub et styles (epub.ebook.php/site.css)

[+] 28/04/2022

  • cache temporairement les warnings pour les fonction ZIP (PHP 8) dans epub.ebook.php
  • arrondis du calcul des dimensions et positions pour la creations des couvertures (PHP8) dans EBook.php
  • fix , typo sur variable $thi => $thI dans config.php

[~]17/04/22 (config.php)

  • maj edition theme
  • maj Javascript scripts (extraction et affichage couleur et fonts du fichier de configuration du theme édité)
  • renommage des themes par nom de dossier

[+] 25/03/2022

  • Ajout et edition de thème(config.php)
  • Upload image et polices pour les thèmes(config.php)
  • upfonts.php Ajout polices en glisser/déposer dans l'edition pour en faire usage avant d'enregistrer le thème en edition ou en création.
  • ajout scripts javascript.

[+] 10/03/2022

  • ajout bouton 'delete' sur la page ebook si connecté comme administrateur. (epub.ebook.php)
  • ajout CSS pour ce bouton.(site.css)
  • Réarrangement des titres, sous-titres et nom de catégories sur la couverture en fonction de l'option choisie pour le titre principale(nom de site ou catégorie)(EBook.php)
  • Données onglets crédits Options ajout à la page remerciements.
  • maj fichiers langues

[+] 08/03/2022

  • integre a l'epub une image située en dehors du repertoire data/medias via cURL (EBook.php, config.php)

[+] 07/03/2022

  • ajout choix du titre de la couverture pour les catégories selectionnées = nom de categorie(defaut) ou nom du site (config.php, EBook.php, varEBook.php)

[+] 06/03/2022

  • Ajout javascript: désactive le bouton de création si des changement sont effectués dans l'onglet configuration et crèation.
  • Maj fichier fr.php/en.php
  • warning message if publish mode not yet configured (config.php)
  • rename: function listdir_by_date -> listdir_by_natsort (epub.ebook.php)
  • initialisation de $file_array=array(); par defaut si repertoire epubs vide(epub.ebook.php)

[+] 05/03/2022

  • bug tri sur multi-utilisateur validé si isset() (config.php)

[+] 04/03/2022

  • cover updates on demand only(config.php)

[+] 03/03/2022

  • javascript, historique dossier epub, couleurs(config.php)

[+] 11/2/22

  • reformat le chemin du repertoire de stockage des epubs(config.php)
  • ajout lien direct dans le menu admin(EBook.php)
  • valeur $format de la fonction catList() pris en compte(EBook.php)
  • n'affiche que les auteurs qui ont au moins une publication(config.php)
  • comptage article par categorie selon l'auteur selectionné (categorie vides non affichées)
  • ajout du champ description commun aux pages statiques(config.php)
  • modif mineures du CSS coté admin

Aide

Fichier d'aide du plugin PLX_EBook

A quoi sert-il ?

Il permet de transformer tous ou parties des contenus de votre site en livres electroniques au standard Epub3, c'est un format ouvert et gratuit lisible dans les differents systéme d'exploitation de vos ecrans (Android, Linux, Mac, Windows ...).

Ce livre est contenu dans un seul fichier avec l'extension .epub, il peut-être télecharger et lu localement avec une liseuse. De nombreux programmes gratuits de lecture de Livre electroniques sont disponibles pour chaque systéme d'exploitations. Si votre appareil n'en dispose pas déjà d'un, il y a de nombreux programmes gratuits disponibles. Chaque programmes aura la capacité de lire differents type de Livre électronique (PDF,HTML,MOBI,EPUB,...) et peut avoir des fonctions de classement en extrayant les informations des livres electronique (titre,auteur,ISBN,image de couverture,etc.) .

Onglets de configurations

! Chaque onglet doit-être individuellement enregistré pour finaliser les modifications de configuration.

Options d'affichage

Cette onglet correspond à la page affichée coté public sur votre site.

Une page public peut être affichée à partir du site pour lister les epubs disponibles et télechargeable.
Plusieurs options sont disponibles pour l'affichage de cette page:

  1. Titre du menu: le titre du lien affichée dans le menus des pages statiques du site

  2. Afficher la page E-Book dans le menu : option d'affichage du lien

  3. Paramètre de l'url : libéllé en fin d'adresse de la page

  4. Position du menu : position dans le menu au coté des liens Accueil et autres statiques

  5. Repértoire de stockage des Epubs:. Un repertoire sera crée a la racine de votre site

    Ce repertoire sert a stocker les epubs généré par le plugin et ceux que vous aurez téléversé. La page coté site listera les epubs présents dans ce repertoire et affichera pour chacun :l'image de couverture, le nom de l'auteur, sa description , la date de création ainsi que le lien de télechargement

  6. Template Choix du template d'affichage de cette page qui se comporte comme une page statique

  7. Contenu personnalisé sous le titre Ajoute de contenus avant la liste des epubs disponibles. format HTML possible.

  8. Contenu personnalisé fin de liste. ajout d'un element de liste avec un texte ou HTML de votre choix

  9. Option de debogage affiche les eventuelles messages d'erreur à l'enregistrement d'un onglet ou à la création d'un epub pour débusquer d'eventuels bugs ou erreurs. Un lien s'affiche pour retourner sur l'onglet de configuration en cours.

Mode de publication

Cette onglet vous permet de selectionner la façon de generer votre epub en collant au plus prés aux type de contenus que vous publiez. Si vous utiliser PluXml comme un blog, les articles les plus récents seront affichés en premier, l'option de parametrer une période définie permet de générer des epubs de façon periodique pour les integrer en piece jointe à une 'newsletter' par exemple. Si vous ecrivez des petits romans, nouvelles, des tutoriaux, ... alors le mode Livre sera adapté.

Vous pouvez configurer l'ordre d'intégration par date de vos articles dans votre livre electronique et de selectionner une période si vous le souhaitez

En selectionnant le type de publication, une boite s'affiche en dessous indiquant les caractéristique du mode et si necessaire les périodes à selectionnées.Le mode Bande Dessinnée ajoute une fonctionnalité indépendante.

Un mode Bande Dessinée, à part, simplifié et indépendant des autres onglets de configuration, vous permet aussi de generer un epub constitué d'images (planches BD, ou juste un album d'images).

Un dossier spécifique pour les images est créer par défaut et peut-etre modifier. Chaque modification de dossier crée un nouveau dossier sans effacer le précedent, vous pouvez donc configurer et stocké les images pour plusieurs epubs.

Dans chaque dossier d'images, il vous faudra y inclure une image de couverture au format jpg/jpeg en la renommant cover.jpg Cette image servira de couverture et sera vue dans la partiee public de votre Plugin.

Le mode choisi doit-être enregistré pour finalisé la configuration avant de generer l'epub.

Configuration et Creation

Cet onglet permet de selectionner des pages annexes et statiques à votre epub qui ne sont pas necessairement à l'affichage sur votre site

Ces pages que vous pouvez inclures sont au choix:

  1. En début de livre : page dédicaces, page préface et page avant propos

  2. Les articles actifs des catégories à inclure dans votre epub. Chaque option selectionné génerera un epub en reprenant le nom de la catégorie, sans espaces et avec un maximum de 12 lettres - en selectionnant Toutes les catégories le titre de votre site sera utilisé pour le nom de votre fichier epub.

    Chaque catégorie selectionnée peut se voir attribuée un theme different parmis ceux disponibles

    Si vous avez installé le plugin plx-gc-categories - télécharger pour chaque catégories mere selectionnée chacune de ses catégories filles seront incluses dans l'epub

    Il n'y a encore pas d'option implémenter pour selectionner plusieurs catégories à inclure dans un seul epub (exepté le cas mere/filles si le plugin correspondant est installé et actif). Pour cela, il vous faudra selectionner 'toutes les catégories' et désactiver momentanément les catégories que vous ne souhaitez pas inclure à partir de la page parametres catégories.

  3. Les pages statiques actives sur votre site

  4. La page : auteur(s), postface et remerciement

  5. Une page remerciement en selectionnant un nombre de commentaire issue d'un seul article.

  6. Une page Index, généré à partir des mots clés des articles intégrés à l'epub

Si l'une de ces pages selectionnées est inactive ou vide, elle ne sera pas insérée dans l'epub

Fiche d'identité

Les informations essentielles de votre livre, par defaut le titre et la description sont ceux de votre site. Vous pouvez aussi selectionné un type de licence , son url et ses termes au format HTML.

Crédits

Credits des differentes contributions, ajoutées en partie au fichier opf de votre epub. (actuellement en cours de devellopement 01/22)

Themes disponibles

Slider montrant quelques exemples disponibles de couvertures et styles utilisable pour vos epubs

Chaque théme est composé de :

  1. une image de couverture sans textes nommée coverX.jpg (X = N° du theme) dans le repertoire /plugins/EBook/covers Cette image est utilisé pour créer l'image de prévisualisation du théme sur laquelle sont ajouté le titre et la description de votre site ainsi qu'un logo PluXml. Elle est inclus dans le dossier du theme
  2. Une image cover.jpg générée à partir de l'image de couverture du theme sur laquelle est ajouté le titre (de la catégorie selectionnée), sa description, le nom de l'auteur et un logo de pluxml. c'est l'image de couverture uniquement insérer dans votre epub.
  3. Un repertoire fonts pour y stockées des polices. Les formats otf et woff sont epub compatible.Ce repertoire est copié dans l'epub
  4. un fichier font.css pour integrer les polices au livre
  5. un fichier theme.css avec les styles particuliers aux differents thémes

  6. un fichier test.html pour visualiser les styles dans l'administration.

Chaque théme comprend aussi les fichiers: epub.css (reset epub) et commun.css, ces fichiers sont inserer dans le livre au moment de sa création.

Ajout thème

Cette Onglet vous permet d'editer un théme ou d'en créer un nouveau.

Vous pouvez uploader de nouvelles polices et images pour vos couvertures

Un editeur vous permet de visualiser et repositionner verticalement les textes de couverture en utilisant les fonts(police) disponibles ainsi que de choisir vos couleurs.

Pour les contenus, les titres, titres secondaire et textes peuvent aussi avoir les fonts et couleurs de votre choix