[Documentation] Réalisation mode d'emploi

Javascript désactivé ou non supporté !!!
Certaines fonctionnalités secondaires sont donc inaccessibles.

Forum : Masquer l’entête

Accès rapide :

Effectuer une Recherche avancée OU

[Documentation] Réalisation mode d'emploi [1 réponse]

Index du Forum » Les annonces

Auteur | réponse

jfr-1

Maître

mardi 8 mai 2018 à 18:07

But de ce topic :

Mettre à contribution les membres afin de réaliser un mode d'emploi complet du portail. Ce document aidera le newbie a prendre en main son portail en évitant les topics de demandes basiques. Attention, on reste dans l'utilisation pure. Aucune modification du portail (toucher au php), si vous avez des astuces (elles sont les bienvenues).

Qualités demandées :

Cette documentation doit être faite depuis un portail tout beau tout neuf, sans contenu, avec le thème par défaut fournit dans l'archive. Chaque documentation du module doit nous parvenir avec des images au format png (lisibles et de bonne qualité). Tout cela avec un document HTML (validé, bien sur...) et dans un dossier zip. Sur ce document HTML, il doit être noté votre pseudo avec le lien jusqu'à votre profil, la version du portail et du module (avec le lien direct pour le download). Faire avec le portail sorti officiellement. Mais si vous êtes un bêta-testeur, sur demande, on peut rajouter dans la liste les modules, mais ne verront le jour dans la documentation qu'à sa sortie. Pour la sortie officielle, faudra revoir la doc afin de vérifier que ça soit toujours d'actualité.

Comment l'envoyer? C'est simple, le mettre sur votre site et simplement envoyer le lien par MP. Cette documentation doit être envoyée à ricky ou Karim10. Quand c'est fait, juste mettre un petit message dans ce topic. La personne qui s'engage, doit être motivée, aller jusqu'au bout et déjà connaître le portail.

On peut et va très certainement modifier ce que vous allez envoyer (mise en page, rajout d'astuces,...), il ne faut pas le prendre mal. On adaptera mais on est bien évidemment à votre disposition si les changements ne conviennent pas.

Modules à faire :

Chaque personne qui accepte de prendre un module, on note son nom à côté du module afin que l'on aie pas des doublons.

~~[admin] = Fifi69~~
~~[afaire] = Fifi69~~
~~[agenda] = Fifi69~~
~~[ajashoot] = Fifi69~~
~~[alerte] = Fifi69~~
~~[articles] = Fifi69~~
~~[citations] = Fifi69~~
~~[contact] = Karim10~~
~~[debug] = Fifi69~~
~~[download] = Fifi69~~
~~[droit] = Fifi69~~
~~[eskuel] = Fifi69~~
~~[espace_membre] = Fifi69~~
~~[espion] = Fifi69~~
~~[forum] = Fifi69~~
[generateur] = Karim10
[groupes] = Karim10
[infoZ] = Karim10
~~[liens_web] = Fifi69~~
~~[livredor] = Karim10~~
[maintenance] = Karim10
[menu] = hervesz
[multi-faq] = Fifi69
[news]
~~[newsletter] = Karim10~~
[page]
[plan] =Karim10
[recherche] = Karim10
[resume] = Karim10
[smileys]
[stats]
[theme_pour_tous]

Modules additionnels proposés par KwsPHPou des membres

[bbcode_sup]
[choixhorloge]
[Choixtheme]
[commentaires]
[FileManager]
[Flash]
[Galerie]
[Google]
[JeuxFlash]
[Liens_rss]
[LinkXchange]
[Menu (déroulant)]
[mg3]
[mmail]
[Notes]
[optimise]
[phpbb]
[Poisson]
[Radio]
[RDV]
[Sauvegarde_bdd]
[Sondage]
[Services]
[sondages]
[Speedzilla]
[Sponsor]
~~[statsmini] = Karim10~~
[TeamSpeak]
[Tiny_mce]
[Translation]
[War Arranger]
[XFire]

* : Version bêta

Merci d'avance pour votre aide. Si vous avez besoin d'autres renseignements, n'hésitez pas...

Je ferai un nettoyage du topic de temps en temps... Merci d'avance d'envoyer un document avec le moins possible de fautes d'orthographe. Mais s'il y en a, on les corrigera.

Pour ceux qui n'ont aucune idée de comment procéder, voici un petit modèle fourni par Karim10:

Code PHP :

Pour copier le contenu exact du code,
Veuillez citer le message

<?php
#####!!!#####
Informations générales sur le module : 
Nom du module : (Nom du module). 
Auteur : (Auteur du module). 
Version actuelle : (Verion actuelle du module). 
 
Utilité du module 
(Résumez ici l'utilité du module). 
 
Astuces & particularités 
(Expliquez ici les différents actions et man�uvres permises par le module).
 
Les fichiers du module: 
(Citez ici les différents fichiers du module)
#####!!!#####
?>

Les docs déjà réalisées sont présentes : ici si en relisant une documentation vous voyez des erreurs, n'hésitez pas à nous en faire part.

Administrateur réseau informatique.
Garant de l’accès au système d’information et de sa sécurité, je préviens les anomalies éventuelles, participe au développement et à la maintenance des applications informatiques. J'interviens également pour rétablir le service en cas de problème.Je suis alias jfr-1.

jfr-1

Maître

mardi 8 mai 2018 à 18:16

Informations générales sur le module :
Nom du module : liens_web
Auteur : KwsPHP
Version actuelle : 1.6

Utilité du module
Ce module référence vos sites favoris triés par catégories

Astuces & particularités
L'ajout d'une nouvelle catégorie s'effectue en même temps que l'ajout d'un lien

Les fichiers du module:
admin.php ==========> Permet l'ajout, la modification et la suppression du bloc du module dans les colonnes du site
aff_drt.php =========> Permet de masquer la colonne de gauche
affadmin.php ========> Cherche les icônes du thème sinon dans le module
bloc.php ===========> Affiche le bloc avec une catégorie choisie
bloc_opt.php ========> Gère les options du bloc
choixcouleur.php =====> Page de choix de couleur
desinstall.sql ========> Désinstallation du module
entete.php ==========> Entête du module permettant
gestion.php =========> Permet d'ajouter, valider, modifier un lien et d'accéder aux options
gestion_options.php ========> Gestion des options du module et du bloc
gestionnaire.txt ========> Paramètres de description du module pour le gestionnaire
index.html ========> Fichier empêchant le listage du répertoire du module.
index.php ========> Affichage du module en page centrale
install.sql ========> Installation du module
legende.php ========> Affichage de la légende
visite.php ========> Incrémentation du nombre de hit par lien

Informations générales sur le module :
Nom du module : espace_membre
Auteur : KwsPHP
Version actuelle : 1.6

Utilité du module
Gestion des membres, inscription, identification, boite aux lettre, listage et recherche des membres

Astuces & particularités

Les fichiers du module:
admin.php Permet l'ajout, la modification et la suppression du bloc du module dans les colonnes du site
aff_drt.php Permet de masquer la colonne de gauche
bloc.php Affiche le profil du membre et ses messages
bloc_message.php Affiche les nombres de messages dans le bloc
boite.php Affichage des éléments la boite aux lettres
carnet.php Gestion du carnet d'adresse
enregistrer.php Formulaire d'inscription
gestionnaire.txt Paramètres de description du module pour le gestionnaire
header.php Accés aux différents dossiers de la boite aux lettres
index.html Fichier empêchant le listage du répertoire du module.
install.sql Installation du module
loging.php Formulaire d'identification et d'affichage des options membres
logout.php Formulaire de déconnection
memberlist.php Listage et recherche des membres
message.php Permet d'écrire un nouveau message ou de visualiser un message existant
meta.php gère les balises meta : title, keyword
parutions.php Listage des contributions d'un membre dans profil.php
perdu.php Renvoi d'un mot de passe perdu
popup.php Fenêtre d'alerte de réception de message
profil.php Affichage du profil d'un membre
stu_attdel.php Avertissement de suppression de compte
stu_attval.php Avertissement d'attente de validation de compte par un webmaster
stu_banni.php Information de compte banni
stu_rglmt.php Formulaire d'acceptation du réglement du site et vérification des caractères autorisé sur le pseudo
stu_suspen.php Information de compte suspendu
theme.php Choix d'un thème préférentiel par le membre
upavatar.php Update d'avatar personnel
update.php Mise à jour du module
val.php Envoi du mail de validation

Informations générales sur le module :
Nom du module : forum
Auteur : KwsPHP
Version actuelle : 1.6

Utilité du module
Forum de discussions complet avec catégories et sous-catégories

Astuces & particularités
Le module permet de suivre les sujets.
Les fichiers du module:
admin.php Permet l'ajout, la modification et la suppression du bloc du module dans les colonnes du site
affadmin.php Cherche les icônes du thème sinon dans le module
affgrd.php Affichage des grades du forum
aff_drt.php Permet de masquer la colonne de gauche
aide.html Description rapide du forum
aide.php Listage des fichiers (obsoléte)
aide_wm.html Listage des fichiers (obsoléte)
annonce.php Permet de mettre de vérouiller un topic où de le mettre en annonce
antidroit.txt Indique que les droits sont gérés directement par le module
bloc.php Affiche le contenu du bloc avec les derniers sujets postés
de_prev.php Gère les sujets suivis
desinstall.sql Desinstallation du module
editer.php Permet de modifier un sujet
entete.php Entête du forum permettant d'accéder à la recherche, liste des gardes...
fonctions.php Mise en forme des dates et récupération des grades
gestion.php Permet d'organiser les catégories et de définir les grades du forum
gestion_options.php Gestion des options : Temps de flood, droits de modération...
gestionnaire.txt Paramètres de description du module pour le gestionnaire
grade2.php Permet d'affecter un grade spécial à un membre. Accès par le profil du membre
index.php Affiche du forum en page centrale
index.html Fichier empêchant le listage du répertoire du module.
install.sql Installation du module
inter_liste.js Fonction de listage des topics
legende.php Affichage de la légende : icônes et tag utilisés
lock.php Vérouillage d'un topic
meta.php gère les balises meta : title, keyword
moderation.js Fonction pour la modération du forum
move.php Déplacement d'un topic et de ses réponses
moveposts.php Déplacement d'un topic et de ses réponses
moveposts_ids.php Déplacement d'un topic et de ses réponses
nonlu.php Permet d'extraire les sujets non lus
no_reponse.php Permet d'extraire les sujets sans réponse
post.php Permet d'ajouter un nouveau sujet
poster.php Permet d'ajouter un nouveau sujet
poster2.php Permet d'ajouter une nouvelle réponse
regles.php Affichge des règles du forum définies par le webmaster
reindexation.php Permet de réindexer les tables du forum et de mettre à jour les compteurs par membre
res_admin.php Affichage des derniers posts pour le module résumé
resume.php Permet de fournir les derniers posts au module resume
rubrique.php Affichage d'une rubrique
supprimer.php Permet de supprimer un topic et ses réponses
theme_prev.php Prévisualisation d'un résultat de recherche
toutlu.php Marquer tous les topics comme lu
voir.php Affichage d'un topic
voir_prev.php Prévisualisation d'un résultat de recherche

Informations générales sur le module :
Nom du module : espion
Auteur : KwsPHP
Version actuelle : 1.6

Utilité du module
Ce module permet d'enregistrer les ip des visiteurs et les pages affichées.

Astuces & particularités
Le module enregistre :
- chaque tentative d'attaque du site.
- Les pages scrutées par les robots.

Les fichiers du module:
admin.php Permet l'ajout, la modification et la suppression du bloc du module dans les colonnes du site
affadmin.php Cherche les icônes du thème sinon dans le module
alerte.php Compte le nombre d'octets de l'historique et lance une alerte
bloc.php Affiche le contenu du bloc : vu dans la journèe
gestion.php Affiche le détail des visites
gestionnaire.txt Paramètres de description du module pour le gestionnaire
historique.php Affiche le contenu des fichiers texte relatifs à l'historique journalier
incrementer.php Ajout une ligne à chaque changement de page
index.html Fichier empêchant le listage du répertoire du module.
initialiser.php Permet d'archiver les visites de la veille dans un fichier texte
install.sql Installation du module

Informations générales sur le module :
Nom du module : citation
Auteur : KwsPHP
Version actuelle : 1.6

Utilité du module
Ce module vous permet d'afficher un bloc contenant une citation aléatoire.
Un index affiche toutes les citations contenues dans la base de données.
Les membres peuvent proposer des citations qui devront être validées par un administrateur.

Astuces & particularités
...

Les fichiers du module:
admin.php Permet l'ajout, la modification et la suppression du bloc du module dans les colonnes du site
bloc.php Affichage des citations dans une colonne
desinstall.sql Désinstallation du module
gestionnaire.txt Paramètres de description du module pour le gestionnaire
index.html Fichier empêchant le listage du répertoire du module.
index.php ajout et validation des citations
info.txt Identique à gestionnaire.txt
install.sql Installation du module
lisez-moi.txt Informations à l'attention des webmasters

Informations générales sur le module :
Nom du module : debug
Auteur : KwsPHP
Version actuelle : 1.6

Utilité du module
Ce module va vous permettre de lister le contenu des répertoires de votre site

Les fichiers du module:
aff_drt.php Permet de masquer la colonne de droite
affadmin.php Cherche les icônes du thème sinon dans le module et affiche le raccourcis dans l'administration
gestionnaire.txt Paramètres de description du module pour le gestionnaire
index.html Fichier empêchant le listage du répertoire du module.
index.php Affichage de la page principale
info.txt Identique à gestionnaire.txt

Informations générales sur le module :
Nom du module : download
Auteur : KwsPHP
Version actuelle : 1.6

Utilité du module
Ce module va vous permettre de gérer vos fichiers téléchargeables. Il est dorénavant inutile de passer par le ftp (à moins d'une limitation de la taille du fichier par votre fournisseur).
Via ce module, vous pourrez autoriser les téléchargements de chacun des fichiers en fonction d'un grade ou d'un groupe.
Le bloc vous permet d'afficher le classement des fichiers les plus téléchargés, les plus récemment téléchargés ou les plus récemment mis en ligne.

Astuces & particularités
Mise en garde 1
Attention, les droits des répertoires ou catégories priment sur les droits des fichiers (genre père/fils).
Il existe une antériorité des catégories sur les droits d'un fichier, c'est-à-dire, si une catégorie ou une sous-catégorie du fichier vous interdit les droits, vous n'aurez pas accès au fichier concerné.

Mise en garde 2
Afin de limiter tout problème, il est fortement recommandé d'utiliser les répertoires et les fichiers en lettres minuscules.

Licence
Si vous placez un fichier "licence.html" dans un répertoire, tous les fichiers de ce répertoire seront soumis à cette licence.
Cette licence sera affichée dans le détail des fichiers. Une confirmation est demandée lors du téléchargement.

Affichage des miniatures Pour afficher les miniatures de vos fichiers ou répertoires :
- uploader votre aperçu dans le dossier de stockage des images des fichiers uploadés.
- lui donnez le même nom (sans l'extension) que le fichier auquel cet aperçu est associé, en rajoutant : _mini

Exemple: Pour mettre un aperçu au fichier test.zip
Uploader un aperçu dans le dossier de stockage des images des fichiers uploadés : (apercu.jpg par exemple)
Renommer en test_mini.jpg (en reprenant l'exemple)

Pour les liens indirects, même manipulation, sauf qu'il faut cette fois rajouter au nom du fichier : ._mini (NE PAS OUBLIER LE POINT !!!)

Les fichiers du module:
admin.php Permet l'ajout, la modification et la suppression du bloc du module dans les colonnes du site
affadmin.php Cherche les icônes du thème sinon dans le module et affiche le raccourcis dans l'administration
afficher_explorateur.php Affiche les téléchargements en forme d'arborescence
afficher_tableau.php Affiche les téléchargement en forme de tableau
afficherid.php Affiche la description d'un téléchargement ainsi que la license si elle existe.
ajouter_fichier.php Permet d'uploader un fichier
ajouter_image.php Permet d'uploader une image
ajouter_repertoire.php Permet de créer un répertoire dans l'arborescence
antidroit.txt Indique que les droits sont gérés par le module
bloc.php Permet d'afficher les meilleurs téléchargements dans un bloc de la colonne droite où gauche
deplacer_fichier.php Permet de déplacer un téléchargement d'un répertoire vers un autre
desinstall.php Déinstallation du module
download.php Permet de télécharger le fichier sélectionné et d'incrémenter le compteur de téléchargement
editer.php Permet de modifier les caratéristique d'un téléchargement
gestion.php Permet la gestion des fichiers en téléchargement et des droits d'accés
gestion_administration.php Gestion des options du module
gestionnaire.txt Paramètres de description du module pour le gestionnaire
index.html Fichier empêchant le listage du répertoire du module.
index.php Affichage de la page principale
info.txt Identique à gestionnaire.txt
install.php Installation du module
install.sql installation de la base de données
lisez_moi.html Info sur l'utilisation du module
meta.php Balise meta à l'attention des robots, Titre, description, keywords
parametres.php Extraction des paramètres du module et des droits
pied_de_page.php Liens vers l'administration et la gestion
securite.php Ligne de sécurité du module
supprimer.php Permet de supprimer un fichier où un répertoire
synchroniser.php Permet de synchroniser le module lorsqu'un fichier a été uploader où un répertoire a été créé via FTP
trier.php Permet d'organiser la liste des téléchargements en fonction d'un critère de tri
trier_fonctions.php Fonctions du fichier trier.php
update.php Utilise lors de la mise à jour du module
vote.php Permet d'enregistrer les votes des visiteurs ou membres sur chaque téléchargement

Informations générales sur le module :
Nom du module : droit
Auteur : KwsPHP
Version actuelle : 1.6

Utilité du module
Ce module gère les droits d'accès aux pages des autres modules

Astuces & particularités
Ce module permet une gestion très fine des droits.
Ainsi, il est tout à fait possible d'autoriser une page aux visiteurs et de verrouiler les autres

Les fichiers du module:
affadmin.php Cherche les icônes du thème sinon dans le module et affiche le raccourcis dans l'administration
aide.html Info à l'attention des codeurs
fonction.php Mise à jour et selection des grades et des groupes
gestion.php Permet l'ajout et la modification des droits d'une page
gestionnaire.php Paramètres de description du module pour le gestionnaire
index.html Fichier empêchant le listage du répertoire du module.
info.txt Identique à gestionnaire.txt
securite.php Ligne de sécurité du module

Informations générales sur le module :
Nom du module : alerte
Auteur : KwsPHP
Version actuelle : 1.6

Utilité du module
Ce module permet à vos membres ou même aux invités, selon votre choix, d'ajouter un article par validation d'un administrateur/modérateur ou automatiquement. Ainsi vous pourrez modifier facilement les options des grades ou de validation dans l'administration des articles de votre site. L'icône qui permettra à vos membres d'ajouter un article apparaîtra automatiquement dans son espace membre si vous autorisez celui-ci à ajouter un nouvel article.

Astuces & particularités
Pour imprimer un article, insérez le lien suivant : imprimer.php?doc=article&id= suivi du numéro de l'article

Les fichiers du module:
admin.php Permet l'ajout, la modification et la suppression du bloc du module dans les colonnes du site
aff_drt.php Force le masquage de la colonne de droite
affadmin.php Cherche les icônes du thème sinon dans le module
affichercat.php ...
aide.php Aide en ligne pour le webmaster
aide_user.php Aide et avertissement à l'attention des membres
ajouter.php Permet d'ajouter et de modifier un article
antidroit.txt Indique que les droits sont gérés directement par le module
bloc.php Affiche le contenu du bloc
commentaire.php Affiche les commentaires et donne la possibilité de voter
desinstall.Php Déinstallation du module
gestion.php Permet l'ajout et la modification d'un article
gestioncat.php Permet de gérer les rubriques avec les droits d'accès
gestionnaire.php Paramètres de description du module pour le gestionnaire
index.html Fichier empêchant le listage du répertoire du module.
index.php Affichage des article en page centrale
info.txt Identique à gestionnaire.txt
install.sql Installation du module
meta.php Mise à jour des balises : title, description, keywords, à l'attention des robots
options.php Option des articles : qui a le droit de faire quoi?
poster.php Gère l'ajout d'un article
print.php Gestion des options d'impression des articles : police des caractères, couleur, taille.
res_admin.php Affichage des derniers articles pour le module résumé
resume.php Extrait les articles pour le module resume
update.php Utilisé par le gestionnaire pour des mises à jour du module
vote.php Gère les votes des membres

Informations générales sur le module :
Nom du module : alerte
Auteur : KwsPHP
Version actuelle : 1.6

Utilité du module
Ce module gère l'ensemble des alertes du site.

Membres en attente d'inscription
Compte suspendu, Compte supprimé
Mails (différents messages suivant la configuration de vos options)
Validation d'un article, d'une news, évenement de l'agenda, citations, livre d'or, liens webs...
Validation ou mise à jour de module

Astuces & particularités
...

Les fichiers du module:
alerte.php Recherche des différentes alertes à afficher
gestionnaire.php Paramètres de description du module pour le gestionnaire
index.html Fichier empêchant le listage du répertoire du module.
index.php Affichage les alertes en page centrale
info.txt Identique à gestionnaire.txt
install.sql Installation du module
scan.php Regarde si un fichier alerte.php existe dans les différents modules et en récupère les alertes
securite.php Ligne de sécurité