[planfacile] Présentation

[pappy]

Voila, un thread sur PlanFacile...

PlanFacile est un compilateur de documents, qui permet de générer un document non formatté à partir d'un ensemble d'idées, de concepts reliés entre eux par des dépendances. (Cette représentation est assimilable à un mindmap)

PlanFacile est d'ailleurs disponible à cette adresse :

http://forums.archlinux.fr/viewtopic.php?t=30

Pour se familiariser avec PlanFacile, qui sera sans doute utilisé pour la rédaction d'un ou plusieurs documents en rapport avec ArchLinux, il a été décidé de mettre sur le wiki d'archlinux.fr une version adaptée du tutorial fourni avec le paquet source :

http://wiki.archlinux.fr/doku.php?id=planfacile

Vous pouvez poster ici (ou sur IRC) toute question concernant l'utilisation de PlanFacile, ou la rédaction des codes sources de PlanFacile.

En vous souhaitant une bonne lecture...

[pappy]

Pour information, je vous mets ici le fichier wiki.plf qui à servi au formattage du texte par le wiki :

Code : Tout sélectionner

#comment{
Ce fichier contient les commandes pour générer une page de wiki (dokuwiki)
à partir d'un code source PlanFacile utilisant les défintions standard.

Il vous est authorisé de distribuer ce fichier, de le modifier sans aucune
restriction, à condition que ce commentaire reste à l'identique en début de
fichier.

Julien Bruguier.
}

#comment{L'idée racine correspond au document entier}
#start{document}

#comment{Messages du compilateur : ils seront placés en footnote pour ne
pas interrompre le fil de la lecture}
#comment{#message{((#mesg ))}}
#message{}

#comment{En-tête et pied de document : vides pour le moment}
#head{}
#foot{}

#comment{Niveaux de concepts}

	#comment{Document : idée vide}
#section{0}{document}{}{}{}{}

	#comment{Partie : headline 1}
#section{1}{partie}{
======= #title# =======

#txt#

}{}{}{}

	#comment{Chapitre : headline 2}
#section{2}{chapitre}{
====== #title# ======

#txt#

}{}{}{}

	#comment{Section : headline 3}
#section{3}{section}{
===== #title# =====

#txt#

}{}{}{}

	#comment{Sous-section : headline 4}
#section{4}{sous-section}{
==== #title# ====

#txt#

}{}{}{}

	#comment{Sous-sous-section : headline 5}
#section{5}{sous-sous-section}{
=== #title# ===

#txt#

}{}{}{}

	#comment{Paragraphe : headline 6}
#section{6}{paragraphe}{
=== #title# ===

#txt#

}{}{}{}

	#comment{Autres niveaux : le plus simple, c'est la liste
	a puce}
#section{idée}{
* #title#

#txt#
}{}{}{}

#comment{Références sur les niveaux : a priori, les références seront
intégrées au corps du texte, placées entre parenthèses.}

	#comment{Document : c'est rare, mais ca pourrait arriver.
	Néanmoins, une telle référence sera vide.}
#reference{document}{}

	#comment{Partie}
#reference{partie}{# (Voir #sec# **#title **) }

	#comment{Chapitre}
#reference{chapitre}{# (Voir #sec# **#title **) }

	#comment{Section}
#reference{section}{# (Voir #sec# **#title **) }

	#comment{Sous-section}
#reference{sous-section}{# (Voir #sec# **#title **) }

	#comment{Sous-sous-section}
#reference{sous-sous-section}{# (Voir #sec# **#title **) }

	#comment{Paragraphe}
#reference{paragraphe}{# (Voir #sec# **#title **) }

	#comment{Idée}
#reference{# (Voir #sec# **#title **) }

#comment{Macros diverses permettant d'avoir un code source
non spécifique : la spécialisation au wiki se fait ici sous
vos yeux ébahis... (ah non ? tant pis pour vous)}

#define{§}
{
#
#
}
#comment{L'énumération est transformée en
liste à puce à cause du côté obscur (et
ch##ant) de dokuwiki...}
#define{enumeration}
{
#1
	#define{items}
	{
	# # * #0#
	}
}
#define{verbatim}
{
''#2''#
}
#define{verbatimlong}
{
<code>#1</code>
	#define{verbligne}{#
	}
}
#define{listeapuce}
{
#1
	#define{items}
	{
	# # * #0#
	}
}
#define{oe}{oe}
#define{...}{...}
#define{espace}{# }
#define{apposition}{-- #1# -- }
#define{cesure}{}
#define{description}
{
#1
	#define{items}
	{
	# # * #0#
	}
	#define{item}
	{
	**#1 :** #2#
	}
}
#define{dièse}{##}
#define{accouvrante}{#{}
#define{accfermante}{#}}
#define{citation}{file #1 file}
#options{Inclusion images}
#case{inclusion image}
	#define{image}{
		#{#{wiki:#1.#2#}#}((#6))
	}
#end
#missing{idee_manquante_#index}Idée manquante #index#text
Ceci est une idée automatiquement ajoutée par #PlanFacile . Vous devriez utiliser la commande missing correspondant à cet index
pour remplacer ce texte par celui de votre document.
Cette idée contient des références vers : #extrefs{(#ref# ; #title )}.#
#end
#options{Idées génériques}
#case{sans générique}
	#warning{Veuillez compiler avec l'option de ligne de commande -A}
#other
	#generic{idee_generique_#index}Idée générique #index#text
	Ceci est une idée automatiquement ajoutée par #PlanFacile . Vous devriez utiliser la commande generic correspondant à cet index
	pour remplacer ce texte par celui de votre document.#
	#end
#end

#define{PlanFacile}{**PlanFacile**}

Oila, oila...

Vous pourrez regénérer la page du wiki avec des modifications si vous le désirez.

La ligne d'appel de planfacile est alors :

Code : Tout sélectionner

PLANFACILE=wiki.plf planfacile -Aucd -O 'sans générique' -o tuto.wiki tuto.plf

[harold]

Oua merci pour cette intro pappy, ca permet quand même d'y voir plus clair.
Je suis de retour sur irc ce ouikend

[pappy]

hihi...

merci, ce fut naturel...

Puisse-t-il vous servir autant qu'à moi...