Update doc

This commit is contained in:
sparkyx 2004-03-18 14:34:05 +00:00
parent ca338b5385
commit f3a19550d9
6 changed files with 219 additions and 125 deletions

103
doc/FAQ
View file

@ -1,103 +0,0 @@
Début de FAQ
-------------------
Q: Quel le nom du soft ??
- phpcompta,
- wcompta,
- webcompta
R: En fait c'est phpcompta, au départ c'était wcompta, contraction de
WebCompta mais malheureusement, c'est le nom d'un soft qui existait
déjà, j'ai été obligé de changer vers phpcompta.
Q: Par où commence-t-on et comment ?
R:
Etape 1, créer un dossier, qui contiendra la comptabilité d'une
entreprise (sur 1 an ou plus).
Menu Administration -> Dossier, choisir un nom pour le dossier, create
folder
Etape 2, on peut créer des utilisateurs mais ce n'est obligatoire.
Etape 3, on revient à l'accueil :)
Si vous avez pris Comptabilité basique, vous devrez créer les journaux,
les fiches, mettre à jour votre plan comptable... Allez voir dans le
répertoire doc du tarball
Q: Ou trouvez les patch
R : sur http://savannah.nongnu.org/patch/?group=phpcompta
On peut y arriver à partir de la page de savannah
Q: Comment adapter le fichier php.ini
R:
Avec PHP 4.3.1
Les variables sont passés de page en page dans un tableau _POST[nom_var] alors
qu'avec les versions précédentes, on y accédait directement avec $nom_var
voir la variable register_globale = off dans le php.ini
php.ini doit contenir pour wcompta
[PHP]
include_patch=../include:.
[Session]
session.name = PHPSESSID
; name of the session
; is used as cookie name
session.auto_start = 1 ; initialize session on request startup
session.cookie_lifetime = 0 ; lifetime in seconds of cookie
; or if 0, until browser is restarted
session.cookie_path = /tmp ; the path the cookie is valid for
R: Quand on réinitialise le mot de passe, que vaut-il ?
Q: Le mQ: J'ai trouvé un tit bug, comment faire un patchs ??
R:
Retirez la version du CVS que vous avez corrigée.
Le numéro de version c'est normalement r pour release p pour prelease
suivit par le numéros (ex r092 qui veut dire release 0.9.2) (regardez les
branches existantes dans le CVS de savannah
http://savannah.nongnu.org/cgi-bin/viewcvs/phpcompta/phpcompta/)
Remplacez (version) par la version
Exemple :
export CVS_RSH="ssh"
cvs -z3 -r (version) -d:ext:anoncvs@savannah.nongnu.org:/cvsroot/phpcompta
co phpcompta
Normalement un répertoire phpcompta va apparaitre, puis vous le copiez
cp -Rvp phpcompta phpcompta.orig
Appliquez éventuellement les patch puis corrigé les bugs, effacer les
fichiers inutiles, les ~, les corefiles...
Puis enfin, pour prendre tout le répertoire (avec prudence)
diff -Nru phpcompta phpcompta.orig > patch-(numéro de version)-votre-email
IMPORTANT : relire le patch-(numéro de version)-votre-email pour voir si
tout ok et le tester
Pour le tester creer un répertoire appelé phpcompta n'importe où
ailleurs, reprenez la version d'origine, puis essayer
patch -p0 < patch-(numéro de version)-votre-email si vous êtes dans le
répertoire au-dessus de celui de phpcompta
patch -p1 < patch-(numéro de version)-votre-email si vous êtes dans le
répertoire courant de phpcompta
Si cela ne marche pas c'est pas bon
Pour un seul fichier, plus simple
copiez le fichier de phpcompta.orig dans le même répertoire que celui du
fichier changé puis placez vous dans le répertoire de au-dessus de celui
de phpcompta ( cd .. ) .
remplacez (sous-directory) par le nom du répertoire ou se trouve le fichier
modifié.
diff -u phpcompta/(sous-directory)/fichier
/phpcompta/(sous-directory)fichier.orig > patch-(numero de
version)-votre-email.
Testez le:
sauvez votre fichier modifié sous un autre nom, faites cp -f fichier.orig
fichier, puis testez avec la commande patch (voir plus haut)
ot de passe par défaut est phpcompta

View file

@ -7,7 +7,7 @@
</author>
<date>$Revision$</date>
<abstract>
Ce document contient les réponses aux questions les plus fréquemment posées sur
Ce document contient les réponses aux questions les plus fréquemment posées sur
PhpCompta <url url="http://www.alchimerys.be/FR/phpcompta" name="PhpCompta">
site savannah <url url="http://savannah.nongnu.org/projects/phpcompta/" name="PhpCompta Savannah">
</abstract>
@ -22,7 +22,7 @@ adapt
pays mais par manque de documentation, ce n'est pas encore implémenté, idem
pour les traductions. </P>
<P>Si vous voulez contribuez n'hésitez pas : <url url="http://mail.nongnu.org/mailman/listinfo/phpcompta-contrib" name="Mailing List Contribution">
<newline> Si vous avez besoin d'aide <url url="http://mail.nongnu.org/mailman/listinfo/phpcompta-support"
<newline> Si vous avez besoin d'aide <url url="http://mail.nongnu.org/mailman/listinfo/phpcompta-support"
name="Mailing List support">.
</p>
<sect> Quel le nom du soft ??
@ -63,18 +63,20 @@ En fait c'est phpcompta, au d
</sect>
<sect>Ou trouvez les patches
<p>
sur http://savannah.nongnu.org/patch/?group=phpcompta
On peut y arriver à partir de la page de savannah
sur la page d'origine, malheureusement, il n'est pas encore possible de téléchargez des fichiers sur Savannah
On peut y arriver à partir de la page de savannah (Homepage)
</p>
</sect>
<sect>Comment adapter le fichier php.ini
<p>
<quote>
Avec PHP 4.3.1 :
Les variables sont passés de page en page dans un tableau _POST[nom_var] alors
qu'avec les versions précédentes, on y accédait directement avec $nom_var
voir la variable register_globale = off dans le php.ini
</p>
<p>
</quote>
php.ini doit contenir pour wcompta
<verb>
[PHP]
@ -143,7 +145,7 @@ r
</p>
<p>
Si cela ne marche pas c'est pas bon
Si cela ne marche pas ce n'est pas bon
</p>
<p>
Pour un seul fichier, plus simple
@ -173,7 +175,11 @@ urpmi linuxdoc-tools, pour les autres, je ne sais pas :(
</p>
<p>
Une fois, les linuxdoc tools installés il peut être nécessaire
d'installer d'autres outils comme jade, sgml,... </p>
d'installer d'autres outils comme jade, sgml,...
Il faudra en tout cas ajouter les tetex-dvips, textex-xdvi, latex2html
<p>
De toute façon, vous
pouvez imprimer le guide, pour le trouver faites :
@ -184,8 +190,8 @@ pouvez imprimer le guide, pour le trouver faites :
</p>
<p>
Ensuite, editez le fichier sgml,
et surtout pensez à utilisez aspell -H --lang=fr_FR check FAQ.sgml pour
rifier l'orthographe. Pour le visionner, faites linuxdoc -B html FAQ.sgml
et surtout pensez à utilisez aspell -H --lang=fr_FR check FA-fr.sgml pour
véifier l'orthographe. Pour le visionner, faites linuxdoc -B html FAQ.sgml
soit linuxdoc -B rtf pour avoir un fichier rtf...
</p>
<sect>Comment contribuer ?
@ -209,7 +215,7 @@ Cela m'
A. se connecter en tant que l'utilisateur Unix postgres
et éxécuter la commande
createuser -d -a phpcompta
puis faire exécuter l'install.sh en tant que root.
puis exécuterinstall.sh en tant que root.
Il serait prudent de changer le propriétaire des fichiers installer
</p>
</sect>
@ -254,5 +260,32 @@ ERROR: table "fichedef" does not exist
</verb></tscreen>
Du à une commande drop sur un objet inexistant, n'y pretez pas attention
</p>
</sect>
<sect> Comment appliquer un patch ?
<p>
<sect1>Quel patch utiliser ?
<p>
Dans certains cas, le dernier patch reprend les autres, il faudra lire la release note du patch
pour savoir ce qu'il faut appliquer avant.
Sinon, les patchs sont toujours nommés ainsi
<bf>path-(numéro_version)-(numéro_de_path).tgz</bf>
exemple
path-r092-1.tgz, est le premier patch pour la release 0.9.2
</p>
</sect1>
<sect1> Comment appliquer le patch
<p>
Après l'avoir télécharger, allez dans le répertoire au-dessus du répertoire qui installe PhpCompta, c'est-à-dire celui qui contient les sources (pas le répertoire où PhpCompta est installé!)
<enum>
<item>Décompresser le patch (gzunip patch-...)
<item>puis appliquez le patch -p9 &lt; patch...
</enum>
</p>
</sect1>
</sect>
</article>

View file

@ -2,19 +2,24 @@
# html, txt format
# $Revision$
.PHONY: all html pdf clean txt
.PHONY: all html .pdf clean .txt
all: html pdf txt
all: manuel-fr.pdf html FAQ-fr.pdf INSTALL-fr.pdf INSTALL-fr.txt FAQ-fr.txt
html:
linuxdoc -B html --charset=latin FAQ.sgml
linuxdoc -B html --charset=latin FAQ-fr.sgml
linuxdoc -B html --charset=latin INSTALL-fr.sgml
pdf:
linuxdoc -B latex --charset=latin --output=pdf FAQ.sgml
linuxdoc -B latex --charset=latin --output=pdf INSTALL-fr.sgml
txt:
linuxdoc -B txt --charset=latin FAQ.sgml
linuxdoc -B html --charset=latin manuel-fr.sgml
FAQ-fr.pdf: FAQ-fr.sgml
linuxdoc -B latex --papersize=a4 --charset=latin --output=pdf FAQ-fr.sgml
manuel-fr.pdf:manuel-fr.sgml
linuxdoc -B latex --papersize=a4 --charset=latin --output=pdf manuel-fr.sgml
INSTALL-fr.pdf:INSTALL-fr.sgml
linuxdoc -B latex --papersize=a4 --charset=latin --output=pdf INSTALL-fr.sgml
FAQ-fr.txt: FAQ-fr.sgml
linuxdoc -B txt --charset=latin FAQ-fr.sgml
cp FAQ-fr.txt ..
INSTALL-fr.txt: INSTALL-fr.sgml
linuxdoc -B txt --charset=latin INSTALL-fr.sgml
cp INSTALL-fr.txt ..
cp FAQ.txt ..

View file

@ -3,8 +3,8 @@ BASE_DIR=`pwd`
ext_dir ()
{
for i in *.php; do
( echo $i
awk '/\/\* function/,/\*\// {print $0;}' $i
( echo "************************* File = $i ****************"
awk '/\/\* function/,/\*\// {print "'$i' "$0;}' $i
) >> $BASE_DIR/function.txt
done
}

Binary file not shown.

159
doc/manuel-fr.sgml Normal file
View file

@ -0,0 +1,159 @@
<!doctype linuxdoc system>
<article>
<title> PhpCompta Manuel d'utilisation</title>
<author>
<name>originally written by Dany De Bontridder
</name>
</author>
<date>$Revision$</date>
<abstract>
Ce document est le manuel d'utilisation de PhpCompta.<url url="http://savannah.nongnu.org/projects/phpcompta/" name="Ph pCompta Savannah">.
Il aborde des thèmes
comme la sécurité, l'utilisation de PhpCompta, les trucs et astuces, et
de la documentation pour ceux qui aimeraient contribuer.
Il ne reprend pas ce qui a déjà été dit dans l'INSTALL-fr et la FAQ-fr.
<!-- Table of contents -->
<toc>
<sect>Vue Général
<sect1>Définition des termes
<p>
<itemize>
<item> Gestion : art de gérer une entreprise ou une activité d'indépendant
<item> Comptabilité : tenue de journaux qui sont l'historique des opérations faites
par une entreprise ou un indépendant
<item> Catégorie de fiches : Ensemble de fiche qui ont un point en commun
exemple : Fourniture bureau est un ensemble des fiches bic, papiers, téléphone, électricité...
<item> Fiche : chaque fiche, correspond à un élément: un fournisseur, un client, un article
<item> Journaux Comptables : Il existe 3 journaux minimum et indispensables à la tenue de la
comptabilité, il s'agit du journal des ventes qui contient toutes les ventes effectuées, journal
d'achat qui contient tous les achats effectués, journal financier qui contient toutes les opérations
financières (banques, caisses)
<item> Postes Comptables : afin de simplifier, chaque type d'opération à un poste comptable, c'est
un chiffre dans un tableaux, exemple en Belgique 5500 représente les comptes bancaires, 600 les
achats de fournitures... Ces postes comptables ne sont pas les mêmes dans tous les pays. Ils sont
regroupés dans un plan comptable. En général, le plan comptable se subdivise en 6 grandes familles
<itemize>
<item>1. Les comptes de capital (immobilisé)
<item>2. Les immobilisations corporelle (Actif a plus d'un an)
<item>3. Les Stocks et commandes
<item>4. Les comptes de tiers (clients, fournisseurs,tva)
<item>5. Les comptes d'actifs (compte en banque,caisse...)
<item>6. Les charges d'exploitations
<item>7. Les produits d'exploitations.
</itemize>
<item> Débit et crédit
Les postes comptables sont en parties doubles, l'une est le débit l'autre est le crédit.
Les actifs diminuent quand le crédit augmentent, les comptes de passifs diminuent quand
le débit augmentent. Par exemple, si un compte en banque est débité il augmente, mais dans
la vie courante, votre compte en banque est une dette que votre banque a envers vous, donc
quand sa dette augmente on dit que le compte est crédité mais dans votre comptabilité, cela
correspond à l'inverse: de votre point de vue, votre compte en banque est une créance sur
votre banque donc s'il augmente, il est débité !!!
</itemize>
</p>
</sect1>
<sect1>Logiciel de comptabilité ou de gestion ?
<sect2>Définition
<p>
La comptabilité consiste, de la manière prévue par les lois sur la comptabilité,
à enregistrer toutes les opérations d'une activité commerciale, industrielle ou artisanale.
</p>
La grande différence avec la gestion, est que la comptabilité est tenue
en suivant des lois précises, qui malheureusement changent suivant le pays.
De plus, elle doit entre autre permettre les déclarations
fiscale, permettre des analyses bilantaires et surtout être conforme à la législation.
Ce n'est pas le cas, de la gestion, la gestion consiste à gérer une entreprise ou une activité
d'indépendant, ce qui inclut aussi la gestion du courrier, du personnel...
</sect2>
<sect2> Documentation sur la comptabilité
</sect2>
</sect1>
<sect1> Les profils
<p>
Dans le menu dans préférence, il existe deux sortes de profil que vous pouvez utiliser,
</p>
<sect2>soit le profil comptable
<p>
Dans ce cas, vous verrez votre comptabilité comme un comptable s'attend à la voir
avec des postes comptables, des écritures comptables impliquant des débits et des crédits
</p>
</sect2>
<sect2>soit le profil utilisateur
<p>
Dans ce cas, vous verrez votre comptabilité comme un utilisateur, facture à payer, facture à encoder...
</p>
C'est le profil par défaut des utilisateurs que vous créerez, sans formation de comptable, l'autre
profil ne pourrait que vous perturbez, il s'agit pourtant de la même chose mais vue différemment.
Certaines opérations ne sont cependant possible que dans le profil comptable, il s'agit d'opération
assez rare et qui demande une réelle connaissance de ce domaines pour être encodés correctement
par exemple une augmentation de capital, une reprise d'amortissement...
</sect2>
</sect1>
<sect1>Les journaux
<p> Il existe 4 sortes de journaux
<itemize>
<item> Celui regroupant les ventes
<item> Celui regroupant les achats
<item> Celui regroupant tous les mouvements financiers (banque, caisse...)
<item> Et celui regroupant toutes les autres opérations (augmentation de bilan, amortissement
</itemize>
La première chose à faire quand on crée un journal est de le paramètrer correctement
L'écran est divisé en deux parties, celle du dessus, s'adresse au profil "comptable" celui
du dessous au profil utilisateur.
</sect1>
<sect1>Création d'une catégorie de fiche
<p>
Les catégories de fiches sont en fait le rassemblement de fiche ensembles, par exemple, les
marchandises, les clients, les fournisseurs...
Pour créer une catégorie, cliquer sur Fiche et à droite sur création. Vous devez donner le
nom de la catégorie et le type de fiche que vous voulez.
La classe de base est le poste comptable parent de vos fiche, ce poste doit exister, il faut alors
cliquer aussi sur "create account for each" qui permet de générer automatiquement le poste comptable voulu, ce poste sera automatiquement ajouté dans le Plan Comptable. Si cette option n'est pas
cochée, vous devrez ajouter manuellement le poste comptable et le donner explicitement. Si vous ne souhaitez pas que chaque fiche aie son propre comptable, ne cochez l'option et n'ajoutez pas manuellement le poste comptable. Dans ce cas, ce sera le poste du modéle de fiche par défaut qui sera utilisé, si vous ne l'indiquez pas ce sera la classe par défaut de ce type de modèle.
Pour simplifier :
<itemize>
<item>Vous voulez que chaque fiche aie son propre poste comptable et vous souhaitez que ce poste soit crée automatiquement : cochez la case 'Create account for each'
<item>Vous souhaitez qu'il n'y a pas de poste comptable attaché à chaque fiche: ne la cochez pas
<item>Vous souhaitez qu'il y aie un poste comptable attaché à chaque fiche
mais pas généré automatiquement: ne cochez pas. Par la suite, ajoutez
l'attribut 'Poste Comptable', vous devrez mettre manuellement le poste comptable
que vous souhaitez pour chaque fiche. Dans ce cas, <bf /toutes/ les
fiches devront avoir un poste comptable. Sinon ce sera le poste comptable
par défaut qui sera utilisé.
</itemize>
</sect1>
<sect1>Création d'une fiche
<p>
</p>
</sect1>
<sect1>Encodage d'opération
<sect2>Achat
</sect2>
<sect2>Vente
</sect2>
<sect2>Opération financière
</sect2>
</sect1>
</sect>
<sect>Sécurité
<p>
</p>
</sect>
</article>