For a common use of PlanFacile, it is not necessary to know all the language of PlanFacile. The goal of
this section is to present the minimum necessary to know how to write a document.
DocumentIdeas A document, as said before, is a set of ideas the author wants to communicate to the reader. One
idea is a part of the document that can be represented by a title. For example, if the writer sees that
one title does not accurately represent the text of the same idea, he should just make sure that two
concepts are not put in one #idea command... The syntax of an idea is quite simple :
#idea{reference}title#texttext#end
Also, some ideas are dependent in one document, so they are linked by dependencies (See paragraph
Dependencies).
Automaticideas Sometimes, PlanFacile adds an idea to the document. In that case, the writer can replace
the default text by an idea that suits the document. To do this, there are two commands, which are like
#idea :
#missing{index}{reference}title#texttext#end
The index parameter is given by PlanFacile, in the default message...
In the same way :
#generic{parentreference}{reference}title#texttext#endDependencies In a document with ideas about the same subject, it is quite natural that ideas need some of
the others to be understood by the reader. This relation is a dependency between ideas.
If the writer puts a dependency in the text of idea A to the idea B, this means that the reader will need
to understand idea B before reading idea A in order to understand this last idea.
The syntax of a dependency, in its simplest form, is :
#dep{reference}{#depref}{}
However, the writer may need to add a positive number to specify the weighting of the dependency if the
organisation of the document is not the right one, even if the writer has put the correct dependencies :
#dep{pertinence}{reference}{#depref}{}
The reference must be one of the words used in the #idea command.
Completesourcecode
The ideas are not sufficient to produce a document. To complete a source code, the writer needs to learn
a bit more about the language of PlanFacile.
Standard The first command of the source can be #standard, that indicates to PlanFacile to load standard
definitions, to be able to produce a document in LaTeX or in HTML (more formats will be present in the
future).
Optionsandmacros When the writer uses the command #standard, the compiler will be able to generate all
formats. The writer must indicate his choice with some commands.
A choice, such as the output format, can be set with an option :
#option{optionname}
and a text parameter can be set with a macro, for a very specific use :
#define{parametername}{value}