From 5561fb38573f4ec2046c37dab8b93a0f5745b45a Mon Sep 17 00:00:00 2001
From: Allan Blanchard <allan.blanchard@cea.fr>
Date: Mon, 31 Aug 2020 10:33:40 +0200
Subject: [PATCH] Slightly reorganizes publications and adds guidelines to add
 a new one.

---
 _data/publications.yml  |  8 ++---
 _fc-publications/README | 79 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 83 insertions(+), 4 deletions(-)
 create mode 100644 _fc-publications/README

diff --git a/_data/publications.yml b/_data/publications.yml
index 516da557..1b1d7f7a 100644
--- a/_data/publications.yml
+++ b/_data/publications.yml
@@ -31,14 +31,14 @@
 - id: external
   name: External plug-ins
   plugins:
-  - id: jessie
-    name: Jessie
-  - id: cost
-    name: Cost
   - id: c2s
     name: Conc2Seq
+  - id: cost
+    name: Cost
   - id: fanc
     name: Fan-C
+  - id: jessie
+    name: Jessie
   - id: sante
     name: SANTE
   - id: sidan
diff --git a/_fc-publications/README b/_fc-publications/README
new file mode 100644
index 00000000..d43f3b6e
--- /dev/null
+++ b/_fc-publications/README
@@ -0,0 +1,79 @@
+--------------------------------------------------------------------------------
+  How to add a publication
+--------------------------------------------------------------------------------
+
+# My publication is about a plug-in which is not in the list
+
+Add your plug-in to the file `_data/publications.yml`. Note there are 3
+categories:
+
+  - distributed with Frama-C
+	- internal CEA plug-in
+	- external plug-in
+
+Put your plug-in in the right one.
+
+There are two mandatory fields and an optional one:
+
+  - id: a unique identifier, with only lower-case characters
+	- name: the name of your plug-in
+	- short: a short name for your plug-in if its name is more than 10 characters
+	  long.
+
+Create a directory named as the unique identifier of your plugin in the
+directory `_fc-publications`.
+
+Once your plug-in is added to this list, you can follow the guidelines for "My
+ publication is about a plug-in which is in the list".
+
+
+# My publication is about a plug-in which is in the list
+
+In `_fc-publications/<your-plug-in>`, create a file named as follows:
+
+- <year of publication>-<conference/journal short name>-<initial letter of the name of each author>.md
+
+For example, for a publication, published in 2019 in the "Verification, Model
+Checking, and Abstract Interpretation" conference, by "Sandrine Blazy, David
+Bühler and Boris Yakobowski", the path to the file is:
+
+- `_fc-publications/eva/2019-vmcai-bby.md`
+
+Note that when a field does not make sense (for example, for a user manual,
+the name of the conference), it can be simply ignored, see for example:
+
+- `_fc-publications/general/user-manual.md`
+
+Then the file is structured as follows:
+
+```md
+---
+plugin: <plug-in identifier>
+authors: "<the authors>"   <-- optional
+title: "<Title of the publication>
+book: "<Name of the conference/journal>" <-- optional
+link: URL to access to the publication <-- optional
+year: year of publication
+category: "<kind of publication>"
+short: "A short description for the publication." <-- optional
+---
+Abstract of the publication <-- optional (but highly recommended)
+```
+
+In the "General" directory, the category can be:
+
+- manuals
+- foundational
+- kernel
+- tutorials
+
+In other directories, it can be:
+
+- manuals
+- thesis
+- foundational
+- tutorials
+- others
+
+Note that if you think you need a new category, it can be added, but the file
+`html/publications.html` should be updated accordingly.
\ No newline at end of file
-- 
GitLab