Commit 5ab0f990 authored by Hugues Pecout's avatar Hugues Pecout
Browse files

feat: update

parent 40915837
Pipeline #8206 passed with stage
in 15 seconds
This diff is collapsed.
@Manual{SubmitRzine,
title = {Processus de soumission d'une fiche},
@Misc{,
title = {Processus de soumission d'une fiche Rzine},
author = {{Comité éditorial Rzine}},
organization = {Rzine},
journal = {Rzine},
publisher = {FR 2007 CIST},
year = {2021},
url = {https://rzine.gitpages.huma-num.fr/help_rzine_submit/},
}
figures/commit.png

78.1 KB | W: | H:

figures/commit.png

90.6 KB | W: | H:

figures/commit.png
figures/commit.png
figures/commit.png
figures/commit.png
  • 2-up
  • Swipe
  • Onion skin
This diff is collapsed.
figures/final.png

81 KB | W: | H:

figures/final.png

594 KB | W: | H:

figures/final.png
figures/final.png
figures/final.png
figures/final.png
  • 2-up
  • Swipe
  • Onion skin
figures/folder_fiche.png

25.6 KB | W: | H:

figures/folder_fiche.png

26.6 KB | W: | H:

figures/folder_fiche.png
figures/folder_fiche.png
figures/folder_fiche.png
figures/folder_fiche.png
  • 2-up
  • Swipe
  • Onion skin
figures/readme.png

72.6 KB | W: | H:

figures/readme.png

714 KB | W: | H:

figures/readme.png
figures/readme.png
figures/readme.png
figures/readme.png
  • 2-up
  • Swipe
  • Onion skin
This diff is collapsed.
figures/readme2.png

81.5 KB | W: | H:

figures/readme2.png

56.6 KB | W: | H:

figures/readme2.png
figures/readme2.png
figures/readme2.png
figures/readme2.png
  • 2-up
  • Swipe
  • Onion skin
This diff is collapsed.
......@@ -14,26 +14,24 @@ logo: "figures/rzine.png"
nocite: |
@*
link_citations: true
licence: "[![licensebuttons by-sa](https://licensebuttons.net/l/by-sa/3.0/88x31.png)](https://creativecommons.org/licenses/by-sa/4.0)"
giturl: "[![Code source on GitLab](https://badgen.net/badge/Code%20source%20on%20/GitLab/blue?icon=gitlab)](https://gitlab.huma-num.fr/rzine/help_rzine_submit)"
# doi: "[![DOI:xxx ](https://zenodo.org/badge/DOI/xxx .svg)](xxx )"
# licence: "by-sa"
gitlab: "gitlab.huma-num.fr/rzine/help_rzine_submit"
# doi: "[![DOI:xxx ](https://zenodo.org/badge/DOI/xxx .svg)](xxx)"
---
```{r setup, include=FALSE}
library(knitr)
library(rzine)
## Global options
options(max.print="75")
opts_chunk$set(echo=FALSE,
knitr::opts_chunk$set(echo=TRUE,
cache=FALSE,
prompt=FALSE,
tidy=TRUE,
comment=NA,
message=FALSE,
warning=FALSE)
opts_knit$set(width=75)
warning=FALSE,
class.source="bg-info",
class.output="bg-warning")
```
......@@ -45,18 +43,13 @@ opts_knit$set(width=75)
Une fois votre fiche rédigée, vous devriez être en possession d'un répertoire contenant les fichiers et sous-répertoires suivants. Comme indiqué dans la [documentation](https://rzine.gitpages.huma-num.fr/Help_Rzine_Layout/), **les fichiers** *biblio.bib* **et** *featured.png* **ne sont pas obligatoires** :
```{r, echo=FALSE, fig.align='center', out.width = "25%"}
include_graphics("figures/folder_fiche.png")
knitr::include_graphics("figures/folder_fiche.png")
```
<div class="alert alert-danger" role="alert">
**Avant de commencer le processus de soumission, il est impératif de renommer les fichiers** "***.Rmd***" et "***.html***" de la façon suivante : "***index.Rmd***" et "***index.html***" **!**</div>
**Il est impératif que les fichiers** "***.Rmd***" et "***.html***" **soient nommés** "***index.Rmd***" et "***index.html***" **pour la suite du processus.**</div>
```{r, echo=FALSE, fig.align='center', out.width = "22%"}
include_graphics("figures/folder_fiche_2.png")
```
**Vous êtes alors en mesure de soumettre votre travail au comité de lecture Rzine**. Pour cela, vous allez devoir :
**Vous êtes alors en mesure de soumettre votre travail au comité de lecture Rzine**. Pour cela, vous devez :
1) **Déposer votre travail sur un dépôt Git** ([logiciel de gestion de versions décentralisé](https://fr.wikipedia.org/wiki/Git)).
2) **Déployer la fiche en format HTML depuis le dépôt Git** pour la rendre consultable en ligne.
......@@ -74,7 +67,7 @@ include_graphics("figures/folder_fiche_2.png")
**Connectez-vous à la** [**page de création de compte GitHub**](https://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F&source=header-home).
```{r, echo=FALSE, fig.align='center', out.width = "60%"}
include_graphics("figures/email_github.png")
knitr::include_graphics("figures/email_github.png")
```
**Saisissez le courriel que vous souhaitez utiliser, un mot de passe, un nom d'utilisateur et répondez aux questions de sécurité pour créer votre compte.** Un code de sécurité vous sera envoyé au courriel renseigné afin de valider la création du compte...
......@@ -84,7 +77,7 @@ include_graphics("figures/email_github.png")
Vous avez désormais un compte GitHub :
```{r, echo=FALSE, fig.align='center', out.width = "100%"}
include_graphics("figures/welcome_github.png")
knitr::include_graphics("figures/welcome_github.png")
```
**Cliquez sur** "***Start a project***" ou "***Create repository***" **pour créer un dépôt qui hébergera votre fiche**.
......@@ -93,19 +86,19 @@ include_graphics("figures/welcome_github.png")
Vous pouvez également créer un nouveau dépôt en cliquant sur "***+***" puis "***New repository***" en haut à droite de la fenêtre :
```{r, echo=FALSE, fig.align='center', out.width = "40%"}
include_graphics("figures/new_repo.png")
knitr::include_graphics("figures/new_repo.png")
```
Un fois sur la page de création d'un nouveau dépôt, **saisissez un nom de dépôt** (sans espaces ni caractères spéciaux) et éventuellement une description. **Initialisez ce dépôt comme** ***Public*** et **demandez l'ajout automatique d'un fichier** ***README.md*** :
```{r, echo=FALSE, fig.align='center', out.width = "70%"}
include_graphics("figures/create_repo.png")
knitr::include_graphics("figures/create_repo.png")
```
Puis cliquez sur "***Create repository***". **Votre dépôt**, uniquement rempli d'un fichier README.md, **a été créé :**
```{r, echo=FALSE, fig.align='center', out.width = "100%"}
include_graphics("figures/new_repo_2.png")
knitr::include_graphics("figures/new_repo_2.png")
```
# Remplissage du dépôt
......@@ -117,25 +110,25 @@ include_graphics("figures/new_repo_2.png")
Pour cela, cliquez sur "***Add file***", puis sur "***Upload files***" :.
```{r, echo=FALSE, fig.align='center', out.width = "45%"}
include_graphics("figures/upload_file.png")
knitr::include_graphics("figures/upload_file.png")
```
**Faîtes glisser l'ensemble des fichiers et sous-répertoires de votre fiche dans le dépôt** :
```{r, echo=FALSE, fig.align='center', out.width = "100%"}
include_graphics("figures/drag_files.png")
knitr::include_graphics("figures/drag_files.png")
```
**Ajoutez un commentaire et cliquez sur** "***Commit changes***" :
```{r, echo=FALSE, fig.align='center', out.width = "100%"}
include_graphics("figures/commit_changes.png")
knitr::include_graphics("figures/commit_changes.png")
```
**Vous venez de réaliser votre premier** "***commit***" (enregistrement des changements). **L'ensemble des fichiers sont désormais stockés sur le dépôt :**
```{r, echo=FALSE, fig.align='center', out.width = "100%"}
include_graphics("figures/commit.png")
knitr::include_graphics("figures/commit.png")
```
Ce dépôt étant paramétré comme *Public*, **tout le monde peut désormais consulter et récupérer ces fichiers**.
......@@ -149,16 +142,16 @@ Les fichiers sont consultables à l'état brut, mais **une manipulation supplém
**Cliquez sur** "***Settings > Pages > Source (none)***" et sélectionnez la branche "***main***" :
```{r, echo=FALSE, fig.align='center', out.width = "100%"}
include_graphics("figures/deploy.png")
knitr::include_graphics("figures/deploy.png")
```
<div class="alert alert-danger" role="alert">
**Pour que cela fonctionne, le fichier html à déployer (et le rmd pour plus de cohérence) doivent impérativement avoir été renommés** "***index***". (Cf. [introduction](#introduction)) </div>
**Pour que cela fonctionne, le fichier html à déployer (et le rmd pour plus de cohérence) doivent impérativement avoir été renommés** "***index***".</div>
**Ne modifiez pas le répertoire ciblé par défaut** **(**"***root***"**)** qui indique la racine du dépôt. **Cliquez sur** "***save***" **:**
```{r, echo=FALSE, fig.align='center', out.width = "80%"}
include_graphics("figures/GitHub_Pages.png")
knitr::include_graphics("figures/GitHub_Pages.png")
```
......@@ -169,52 +162,42 @@ include_graphics("figures/GitHub_Pages.png")
**Vous pouvez retrouver l'URL d'accès dans le menu** "***Settings > Pages***" **:**
```{r, echo=FALSE, fig.align='center', out.width = "90%"}
include_graphics("figures/deploy_url.png")
knitr::include_graphics("figures/deploy_url.png")
```
**Cliquez sur le lien affiché pour consulter la fiche mise en ligne :**
```{r, echo=FALSE, fig.align='center', out.width = "100%"}
include_graphics("figures/online.png")
knitr::include_graphics("figures/online.png")
```
## README.md
**Le fichier markdown** "***README***" est utilisé **pour présenter les informations importantes à propos du dépôt**. **Son contenu est automatiquement affiché** (et mise en forme grâce à la syntaxe markdown) **en dessous des fichiers listés du dépôt**.
**Il est possible de l'éditer et de le modifier facilement depuis l'interface GitHub** en cliquant sur le **symbole crayon** :
**Vous pouvez éditer et modifier facilement ce fichier depuis l'interface GitHub** en cliquant sur le **symbole crayon** :
```{r, echo=FALSE, fig.align='center', out.width = "90%"}
include_graphics("figures/readme.png")
```
**Cliquez sur le symbole**, et **copiez-collez ces quelques lignes** dans le fichier édité en ligne :
knitr::include_graphics("figures/readme.png")
```
# Fiche Rzine
Ce dépôt héberge le code source d'une [fiche Rzine](https://rzine.fr/publication_rzine/).
Cette fiche présente....
**Vous pouvez alors personnalisez le fichier** en modifiant : le **titre**, le **sous-titre**, le.s **auteur.e.s** (et **affiliation.s**), ainsi que l'**URL de consultation de la fiche**. Exemple :
**Vous pouvez la consulter à ce** [**lien**](https://username.gitub.io/repository_name/)
[![licensebuttons by-sa](https://licensebuttons.net/l/by-sa/3.0/88x31.png)](https://creativecommons.org/licenses/by-sa/4.0)
```{r, echo=FALSE, fig.align='center', out.width = "100%"}
knitr::include_graphics("figures/readme2.png")
```
**Personnalisez le texte de présentation de la fiche** (*Cette fiche présente...*) et **remplacez l'URL** *https://xxxxxxx.gitub.io/xxxxxxxxx/* **par l'URL correcte de votre fiche déployée.**
Une fois les modifications terminées, **commentez votre** ***commit***, puis **cliquez sur** ***Commit changes*** pour enregistrer les changements effectués :
**Commentez votre** ***commit***, puis **cliquez sur** ***Commit changes*** pour enregistrer les changements effectués :
```{r, echo=FALSE, fig.align='center', out.width = "100%"}
include_graphics("figures/readme2.png")
```{r, echo=FALSE, fig.align='center', out.width = "80%"}
knitr::include_graphics("figures/readme3.png")
```
**Et voilà ! vous avez terminé la mise en ligne de votre fiche**. Désormais, **un lien vers votre fiche déployée est affiché à la racine du dépôt grâce au fichier** "***README.md***" **:**
```{r, echo=FALSE, fig.align='center', out.width = "100%"}
include_graphics("figures/final.png")
knitr::include_graphics("figures/final.png")
```
# Soumission
......@@ -247,20 +230,39 @@ Pour toute question relative au processus de soumission et de relecture d'une fi
```{r session_info, echo=FALSE}
kableExtra::kable_styling(kable(rzine::sessionRzine()[[1]], row.names = F))
kableExtra::kable_styling(kable(rzine::sessionRzine()[[2]], row.names = F))
kableExtra::kable_styling(knitr::kable(rzine::sessionRzine()[[1]], row.names = F))
kableExtra::kable_styling(knitr::kable(rzine::sessionRzine()[[2]], row.names = F))
```
## Citation {-}
```{r generateBibliography, echo=FALSE}
```{r ReadCitation, echo=FALSE}
rref <- bibentry(
bibtype = "misc",
title = "Processus de soumission d'une fiche Rzine",
author = person("Comité éditorial Rzine"),
journal = "Rzine",
publisher = "FR 2007 CIST",
year = 2021,
url = "https://rzine.gitpages.huma-num.fr/help_rzine_submit/")
```
`r capture.output(print(rref))`
### BibTex : {-}
```{r generateBibTex, echo=FALSE}
cat(readLines('cite.bib'), sep = '\n')
writeLines(toBibtex(rref), "cite.bib")
toBibtex(rref)
```
<br/>
This diff is collapsed.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment