asciidoctor 1.5.6.1 → 1.5.6.2

data/lib/asciidoctor/version.rb

@@ -1,3 +1,3 @@
 module Asciidoctor
-  VERSION = '1.5.6.1'
+  VERSION = '1.5.6.2'
 end

data/man/asciidoctor.1

@@ -1,13 +1,13 @@
 '\" t
 .\"     Title: asciidoctor
 .\"    Author: Dan Allen, Sarah White, Ryan Waldron
-.\" Generator: Asciidoctor 1.5.6.1
-.\"      Date: 2017-07-23
+.\" Generator: Asciidoctor 1.5.6.2
+.\"      Date: 2018-03-20
 .\"    Manual: Asciidoctor Manual
-.\"    Source: Asciidoctor 1.5.6.1
+.\"    Source: Asciidoctor 1.5.6.2
 .\"  Language: English
 .\"
-.TH "ASCIIDOCTOR" "1" "2017-07-23" "Asciidoctor 1.5.6.1" "Asciidoctor Manual"
+.TH "ASCIIDOCTOR" "1" "2018-03-20" "Asciidoctor 1.5.6.2" "Asciidoctor Manual"
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .ss \n[.ss] 0
@@ -235,7 +235,7 @@ Refer to the \fBAsciidoctor\fP issue tracker at \c
 .URL "http://discuss.asciidoctor.org" "" ""
 .SH "COPYING"
 .sp
-Copyright (C) 2012\-2017 Dan Allen, Ryan Waldron and the Asciidoctor Project.
+Copyright (C) 2012\-2018 Dan Allen, Ryan Waldron and the Asciidoctor Project.
 Free use of this software is granted under the terms of the MIT License.
 .SH "AUTHOR(S)"
 .sp

data/man/asciidoctor.adoc

@@ -2,7 +2,7 @@
 Dan Allen; Sarah White; Ryan Waldron
 :doctype: manpage
 :man manual: Asciidoctor Manual
-:man source: Asciidoctor 1.5.6.1
+:man source: Asciidoctor 1.5.6.2
 :page-layout: base
 
 == NAME
@@ -182,5 +182,5 @@ Refer to the *Asciidoctor* issue tracker at https://github.com/asciidoctor/ascii
 
 == COPYING
 
-Copyright \(C) 2012-2017 Dan Allen, Ryan Waldron and the Asciidoctor Project.
+Copyright \(C) 2012-2018 Dan Allen, Ryan Waldron and the Asciidoctor Project.
 Free use of this software is granted under the terms of the MIT License.

data/test/extensions_test.rb

@@ -180,6 +180,24 @@ class SampleExtensionGroup < Asciidoctor::Extensions::Group
   end
 end
 
+def create_cat_in_sink_block_macro
+  Asciidoctor::Extensions.create do
+    block_macro do
+      named :cat_in_sink
+      process do |parent, target, attrs|
+        image_attrs = {}
+        unless target.nil_or_empty?
+          image_attrs['target'] = %(cat-in-sink-day-#{target}.png)
+        end
+        if (alt = attrs.delete 1)
+          image_attrs['alt'] = alt
+        end
+        create_image_block parent, image_attrs
+      end
+    end
+  end
+end
+
 context 'Extensions' do
   context 'Register' do
     test 'should register extension group class' do
@@ -1161,7 +1179,6 @@ sample content
       end
     end
 
-
     test 'should append docinfo to document' do
       begin
         Asciidoctor::Extensions.register do
@@ -1181,5 +1198,42 @@ sample content
         Asciidoctor::Extensions.unregister_all
       end
     end
+
+    test 'should raise an exception if mandatory target attribute is not provided for image block' do
+      input = <<-EOS
+.Cat in Sink?
+cat_in_sink::[]
+      EOS
+      exception = assert_raises ArgumentError do
+        render_embedded_string input, :extension_registry => create_cat_in_sink_block_macro
+      end
+      assert_match(/target attribute is required/, exception.message)
+    end
+
+    test 'should assign alt attribute to image block if alt is not provided' do
+      input = <<-EOS
+.Cat in Sink?
+cat_in_sink::25[]
+      EOS
+      doc = document_from_string input, :header_footer => false, :extension_registry => create_cat_in_sink_block_macro
+      image = doc.blocks[0]
+      assert_equal 'cat in sink day 25', (image.attr 'alt')
+      assert_equal 'cat in sink day 25', (image.attr 'default-alt')
+      output = doc.convert
+      assert_includes output, '<img src="cat-in-sink-day-25.png" alt="cat in sink day 25">'
+    end
+
+    test 'should create an image block if mandatory attributes are provided' do
+      input = <<-EOS
+.Cat in Sink?
+cat_in_sink::30[cat in sink (yes)]
+      EOS
+      doc = document_from_string input, :header_footer => false, :extension_registry => create_cat_in_sink_block_macro
+      image = doc.blocks[0]
+      assert_equal 'cat in sink (yes)', (image.attr 'alt')
+      refute(image.attr? 'default-alt')
+      output = doc.convert
+      assert_includes output, '<img src="cat-in-sink-day-30.png" alt="cat in sink (yes)">'
+    end
   end
 end

data/test/links_test.rb

@@ -499,6 +499,21 @@ A summary of the first lesson.
     assert_xpath '//a[@href="#tigers"][text() = "[tigers]"]', doc.render, 1
   end
 
+  test 'multiple xref macros with implicit text in single line' do
+    input = <<-EOS
+This document has two sections, xref:sect-a[] and xref:sect-b[].
+
+[#sect-a]
+== Section A
+
+[#sect-b]
+== Section B
+    EOS
+    result = render_embedded_string input
+    assert_xpath '//a[@href="#sect-a"][text() = "Section A"]', result, 1
+    assert_xpath '//a[@href="#sect-b"][text() = "Section B"]', result, 1
+  end
+
   test 'xref using macro syntax with explicit hash' do
     doc = document_from_string 'xref:#tigers[]'
     doc.register :refs, ['tigers', (Asciidoctor::Inline.new doc, :anchor, 'Tigers', :type => :ref, :target => 'tigers'), 'Tigers']

data/test/sections_test.rb

@@ -820,9 +820,9 @@ text in standalone
 // end simulated include::[]
       EOS
 
-      output = warnings = nil
+      warnings = nil
       redirect_streams do |out, err|
-        output = render_string input
+        render_string input
         warnings = err.string
       end
 
@@ -2761,9 +2761,9 @@ more part intro
 intro
       EOS
 
-      doc = warnings = nil
+      warnings = nil
       redirect_streams do |out, err|
-        doc = document_from_string input
+        document_from_string input
         warnings = err.string
       end
 

data/test/substitutions_test.rb

@@ -1550,13 +1550,13 @@ EOS
     test 'complex inline passthrough macro' do
       text_to_escape = %q{[(] <'basic form'> <'logical operator'> <'basic form'> [)]}
       para = block_from_string %($$#{text_to_escape}$$)
-      result = para.extract_passthroughs(para.source)
+      para.extract_passthroughs(para.source)
       assert_equal 1, para.passthroughs.size
       assert_equal text_to_escape, para.passthroughs[0][:text]
 
       text_to_escape_escaped = %q{[(\] <'basic form'> <'logical operator'> <'basic form'> [)\]}
       para = block_from_string %(pass:specialcharacters[#{text_to_escape_escaped}])
-      result = para.extract_passthroughs(para.source)
+      para.extract_passthroughs(para.source)
       assert_equal 1, para.passthroughs.size
       assert_equal text_to_escape, para.passthroughs[0][:text]
     end

data/test/test_helper.rb

@@ -145,13 +145,13 @@ class Minitest::Test
 
   def xmldoc_from_string(content)
     if content.match(RE_XMLNS_ATTRIBUTE)
-      doc = Nokogiri::XML::Document.parse(content)
+      Nokogiri::XML::Document.parse(content)
     elsif !(doctype_match = content.match(RE_DOCTYPE))
-      doc = Nokogiri::HTML::DocumentFragment.parse(content)
+      Nokogiri::HTML::DocumentFragment.parse(content)
     elsif doctype_match[1].start_with? 'html'
-      doc = Nokogiri::HTML::Document.parse(content)
+      Nokogiri::HTML::Document.parse(content)
     else
-      doc = Nokogiri::XML::Document.parse(content)
+      Nokogiri::XML::Document.parse(content)
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor
 version: !ruby/object:Gem::Version
-  version: 1.5.6.1
+  version: 1.5.6.2
 platform: ruby
 authors:
 - Dan Allen
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-23 00:00:00.000000000 Z
+date: 2018-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciimath
@@ -91,14 +91,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -169,34 +169,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.0
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.9.8
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.9.8
-- !ruby/object:Gem::Dependency
-  name: yard-tomdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.7.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -223,16 +195,12 @@ extensions: []
 extra_rdoc_files:
 - CHANGELOG.adoc
 - CONTRIBUTING.adoc
-- LICENSE.adoc
+- LICENSE
 files:
 - CHANGELOG.adoc
 - CONTRIBUTING.adoc
 - Gemfile
-- LICENSE.adoc
-- README-fr.adoc
-- README-jp.adoc
-- README-zh_CN.adoc
-- README.adoc
+- LICENSE
 - Rakefile
 - asciidoctor.gemspec
 - bin/asciidoctor
@@ -372,7 +340,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: An implementation of the AsciiDoc text processor and publishing toolchain

data/README-fr.adoc

@@ -1,423 +0,0 @@
-= Asciidoctor
-Dan Allen <https://github.com/mojavelinux[@mojavelinux]>; Sarah White <https://github.com/graphitefriction[@graphitefriction]>; Ryan Waldron <https://github.com/erebor[@erebor]>
-v1.5.6.1, 2017-07-23
-// settings:
-:page-layout: base
-:idprefix:
-:idseparator: -
-:source-language: ruby
-:language: {source-language}
-ifndef::env-github[:icons: font]
-ifdef::env-github[]
-:status:
-:outfilesuffix: .adoc
-:caution-caption: :fire:
-:important-caption: :exclamation:
-:note-caption: :paperclip:
-:tip-caption: :bulb:
-:warning-caption: :warning:
-endif::[]
-// Variables:
-:release-version: 1.5.6.1
-// URIs:
-:uri-org: https://github.com/asciidoctor
-:uri-repo: {uri-org}/asciidoctor
-:uri-asciidoctorj: {uri-org}/asciidoctorj
-:uri-asciidoctorjs: {uri-org}/asciidoctor.js
-:uri-project: http://asciidoctor.org
-ifdef::env-site[:uri-project: link:]
-:uri-docs: {uri-project}/docs
-:uri-news: {uri-project}/news
-:uri-manpage: {uri-project}/man/asciidoctor
-:uri-issues: {uri-repo}/issues
-:uri-contributors: {uri-repo}/graphs/contributors
-:uri-rel-file-base: link:
-:uri-rel-tree-base: link:
-ifdef::env-site[]
-:uri-rel-file-base: {uri-repo}/blob/master/
-:uri-rel-tree-base: {uri-repo}/tree/master/
-endif::[]
-:uri-changelog: {uri-rel-file-base}CHANGELOG.adoc
-:uri-contribute: {uri-rel-file-base}CONTRIBUTING.adoc
-:uri-license: {uri-rel-file-base}LICENSE.adoc
-:uri-tests: {uri-rel-tree-base}test
-:uri-discuss: http://discuss.asciidoctor.org
-:uri-irc: irc://irc.freenode.org/#asciidoctor
-:uri-rubygem: https://rubygems.org/gems/asciidoctor
-:uri-what-is-asciidoc: {uri-docs}/what-is-asciidoc
-:uri-user-manual: {uri-docs}/user-manual
-:uri-install-docker: https://github.com/asciidoctor/docker-asciidoctor
-//:uri-install-doc: {uri-docs}/install-toolchain
-:uri-install-osx-doc: {uri-docs}/install-asciidoctor-macosx
-:uri-render-doc: {uri-docs}/render-documents
-:uri-themes-doc: {uri-docs}/produce-custom-themes-using-asciidoctor-stylesheet-factory
-:uri-gitscm-repo: https://github.com/git/git-scm.com
-:uri-prototype: {uri-gitscm-repo}/commits/master/lib/asciidoc.rb
-:uri-freesoftware: https://www.gnu.org/philosophy/free-sw.html
-:uri-foundation: http://foundation.zurb.com
-:uri-tilt: https://github.com/rtomayko/tilt
-:uri-ruby: https://ruby-lang.org
-// images:
-:image-uri-screenshot: https://raw.githubusercontent.com/asciidoctor/asciidoctor/master/screenshot.png
-
-{uri-project}/[Asciidoctor] est un processeur de texte _rapide_ et une chaîne de publication pour convertir du contenu {uri-what-is-asciidoc}[AsciiDoc] en HTML5, DocBook 5 (ou 4.5) et d'autres formats.
-Asciidoctor est écrit en Ruby, packagé sous forme de RubyGem et publié sur {uri-rubygem}[RubyGems.org].
-La gemme est aussi incluse dans plusieurs distributions Linux, dont Fedora, Debian et Ubuntu.
-Asciidoctor est open source, {uri-repo}[hébergé sur GitHub] et distribué sous {uri-license}[licence MIT].
-
-ifndef::env-site[]
-Ce document est traduit dans les langues suivantes :
-
-* {uri-rel-file-base}README.adoc[Anglais]
-* {uri-rel-file-base}README-zh_CN.adoc[Chinois]
-* {uri-rel-file-base}README-jp.adoc[Japonais]
-endif::[]
-
-.Documentation clé
-[.compact]
-* {uri-docs}/what-is-asciidoc[Qu'est ce qu'AsciiDoc ?]
-* {uri-docs}/asciidoc-writers-guide[Guide pour Rédacteur AsciiDoc]
-* {uri-docs}/asciidoc-syntax-quick-reference[Syntaxe de Référence AsciiDoc]
-* {uri-docs}/user-manual[Manuel Utilisateur Asciidoctor]
-
-.Asciidoctor est disponible partout où Ruby est disponible
-****
-Vous pouvez exécuter Asciidoctor dans la JVM en utilisant JRuby.
-Pour invoquer l'API Asciidoctor directement depuis Java ou d'autres langages de la JVM, utilisez {uri-asciidoctorj}[AsciidoctorJ].
-Des plugins basés sur AsciidoctorJ permettent d'intégrer le processeur Asciidoctor avec Apache Maven, Gradle ou Javadoc.
-
-Asciidoctor s'exécute également au sein de JavaScript.
-Nous utilisons http://opalrb.org[Opal] pour transcrire le code source Ruby en JavaScript afin de produire {uri-asciidoctorjs}[Asciidoctor.js], une version pleinement fonctionnelle d'Asciidoctor qui s'intègre dans tout environnement JavaScript, comme un navigateur web ou Node.js.
-Asciidoctor.js est utilisé pour faire fonctionner les extensions AsciiDoc Preview pour Chrome, Atom, Brackets et autres outils web.
-****
-
-ifdef::status[]
-.*Santé du projet*
-image:https://img.shields.io/travis/asciidoctor/asciidoctor/master.svg[Build Status (Travis CI), link=https://travis-ci.org/asciidoctor/asciidoctor]
-image:https://ci.appveyor.com/api/projects/status/ifplu67oxvgn6ceq/branch/master?svg=true&amp;passingText=green%20bar&amp;failingText=%23fail&amp;pendingText=building%2E%2E%2E[Build Status (AppVeyor), link=https://ci.appveyor.com/project/asciidoctor/asciidoctor]
-//image:https://img.shields.io/coveralls/asciidoctor/asciidoctor/master.svg[Coverage Status, link=https://coveralls.io/r/asciidoctor/asciidoctor]
-image:https://codeclimate.com/github/asciidoctor/asciidoctor/badges/gpa.svg[Code Climate, link="https://codeclimate.com/github/asciidoctor/asciidoctor"]
-image:https://inch-ci.org/github/asciidoctor/asciidoctor.svg?branch=master[Inline docs, link="https://inch-ci.org/github/asciidoctor/asciidoctor"]
-endif::[]
-
-== En un mot
-
-Asciidoctor lit du contenu écrit en texte brut, comme présenté dans la partie gauche de l'image ci-dessous, et le convertit en HTML5, comme présenté dans la partie droite.
-Asciidoctor applique une feuille de style par défaut au document HTML5 afin de fournir une expérience de lecture agréable, clé en main.
-
-image::{image-uri-screenshot}[Prévisualisation d'une source AsciiDoc et le rendu HTML correspondant]
-
-== Le traitement d'AsciiDoc
-
-Asciidoctor lit et analyse la syntaxe du texte écrit en AsciiDoc afin de créer une représentation, sous forme d'arbre, à partir de laquelle des templates sont appliqués pour produire de l'HTML5, du DocBook 5 (ou 4.5).
-
-Vous avez la possibilité d'écrire votre propre convertisseur ou de fournir des templates supportant {uri-tilt}[Tilt] pour personnaliser le résultat généré ou pour produire des formats alternatifs.
-
-NOTE: Asciidoctor est un remplaçant du processeur AsciiDoc original écrit en Python (`asciidoc.py`).
-La suite de tests Asciidoctor possède {uri-tests}[> 1,600 tests] pour garantir la compatibilité avec la syntaxe AsciiDoc.
-
-En plus de la syntaxe AsciiDoc standard, Asciidoctor reconnaît des balises additionnelles ainsi que des options de formatage, comme les polices d'icônes (par exemple `+icon:fire[]+`) et des éléments d'interface (par exemple `+button:[Enregistrer]+`).
-Asciidoctor offre aussi un thème moderne et « responsive » basé sur {uri-foundation}[Foundation] pour styliser le document HTML5 généré.
-
-== Prérequis
-
-Asciidoctor fonctionne sur Linux, OS X (Mac), Windows et requiert une des implémentations suivantes :
-
-* MRI (Ruby 1.8.7, 1.9.3, 2.0, 2.1, 2.2 & 2.3)
-* JRuby (1.7 dans les modes Ruby 1.8 et 1.9, 9000)
-* Rubinius 2.2.x
-* Opal (JavaScript)
-
-Votre aide est appréciée pour tester Asciidoctor sur l'une de ces plateformes.
-Référez-vous au paragraphe <<Contributions>> si vous souhaitez vous impliquer dans ce projet.
-
-[CAUTION]
-====
-Si vous utilisez un environnement Windows dans une autre langue que l'anglais, vous pourriez tomber sur l'erreur `Encoding::UndefinedConversionError` lors du lancement d'Asciidoctor.
-Pour corriger ce problème, nous recommandons de changer la page de code en UTF-8 dans votre console :
-
- chcp 65001
-
-Après ce changement, tous les maux de tête liés à l'Unicode seront derrière vous.
-Si vous utilisez un environnement de développement comme Eclipse, assurez-vous de définir l'encodage en UTF-8.
-Asciidoctor fonctionne mieux lorsque vous utilisez UTF-8 partout.
-====
-
-== Installation
-
-Asciidoctor peut être installé en utilisant la commande (a) `gem install`, (b) Bundler ou (c) les gestionnaires de paquets pour les distributions Linux populaires.
-
-TIP: L'avantage d'utiliser le gestionnaire de paquets pour installer la gemme est que l'installation englobe celle des librairies Ruby et RubyGems si elles ne sont pas déjà installés.
-L'inconvénient est que le paquet n'est pas forcément mis à jour immédiatement après la mise à disposition de la gemme.
-Si vous avez besoin de la dernière version, vous devez passer par la commande `gem`.
-
-=== (a) Installation de la gemme
-
-Ouvrir un terminal et taper (en excluant le `$`) :
-
- $ gem install asciidoctor
-
-Si vous souhaitez installer une version pre-release (c'est-à-dire, une « release candidate »), utilisez :
-
- $ gem install asciidoctor --pre
-
-.Mettre à jour votre installation
-[TIP]
-====
-Si vous avez une précédente version d'Asciidoctor installée, vous pouvez la mettre à jour en utilisant :
-
- $ gem update asciidoctor
-
-Si vous installez une nouvelle version de la gemme en utilisant `gem install` au lieu de `gem update`, vous aurez plusieurs versions d'installées.
-Si c'est le cas, utilisez la commande gem suivante pour supprimer la vieille version :
-
- $ gem cleanup asciidoctor
-====
-
-=== (b) Bundler
-
-. Créez un fichier Gemfile à la racine de votre projet (ou du répertoire courant)
-. Ajoutez la gemme `asciidoctor` dans votre fichier Gemfile comme ci-dessous :
-+
-[source,subs=attributes+]
-----
-source 'https://rubygems.org'
-gem 'asciidoctor'
-# ou spécifier la version explicitement
-# gem 'asciidoctor', '{release-version}'
-----
-
-. Sauvegardez le fichier Gemfile
-. Ouvrez un terminal et installez la gemme en utilisant :
-
- $ bundle
-
-Pour mettre à jour la gemme, spécifiez la nouvelle version dans le fichier Gemfile et exécutez `bundle` à nouveau.
-Utiliser `bundle update` *n*'est *pas* recommandé car les autres gemmes seront également mises à jour, ce qui n'est pas forcément le résultat voulu.
-
-=== (c) Gestionnaire de paquets Linux
-
-==== DNF (Fedora 21 ou supérieure)
-
-Pour installer la gemme sur Fedora 21 ou supérieure en utilisant dnf, ouvrez un terminal et tapez :
-
- $ sudo dnf install -y asciidoctor
-
-Pour mettre à jour la gemme, utilisez :
-
- $ sudo dnf update -y asciidoctor
-
-TIP: Votre système peut être configuré pour mettre à jour automatiquement les paquets rpm, auquel cas aucune action de votre part ne sera nécessaire pour mettre à jour la gemme.
-
-==== apt-get (Debian, Ubuntu, Mint)
-
-Pour installer la gemme sur Debian, Ubuntu ou Mint, ouvrez un terminal et tapez :
-
- $ sudo apt-get install -y asciidoctor
-
-Pour mettre à jour la gemme, utilisez :
-
- $ sudo apt-get upgrade -y asciidoctor
-
-TIP: Votre système peut être configuré pour mettre à jour automatiquement les paquets deb, auquel cas aucune action de votre part ne sera nécessaire pour mettre à jour la gemme.
-
-La version d'Asciidoctor installé par le gestionnaire de paquets (apt-get) peut ne pas correspondre à la dernière version d'Asciidoctor.
-Consultez le dépôt de paquets de votre distribution pour trouver quelle version est disponible par version de distribution.
-
-* https://packages.debian.org/search?keywords=asciidoctor&searchon=names&exact=1&suite=all&section=all[Paquet asciidoctor par version de Debian]
-* http://packages.ubuntu.com/search?keywords=asciidoctor&searchon=names&exact=1&suite=all&section=all[Paquet asciidoctor par version d'Ubuntu]
-* https://community.linuxmint.com/software/view/asciidoctor[Paquet asciidoctor par version de Mint]
-
-[CAUTION]
-====
-Il est déconseillé d'utiliser la commande `gem update` pour mettre à jour la gemme gérée par le gestionnaire de paquets.
-Le faire mettrait la système dans un état incohérent car le gestionnaire de paquets ne pourrait plus gérer les fichiers (qui sont installés dans /usr/local).
-En résumé, les gemmes du système doivent être gérées seulement par le gestionnaire de paquets.
-
-Si vous souhaitez utiliser une version d'Asciidoctor qui est plus récente que celle installée par votre gestionnaire de paquets, vous devriez utiliser http://rvm.io[RVM] pour installer Ruby dans votre répertoire personnel (dans votre espace utilisateur).
-Vous pouvez alors utiliser la commande `gem` pour installer ou mettre à jour la gemme Asciidoctor.
-En utilisant RVM, les gemmes sont installées dans un emplacement isolé du système.
-====
-
-==== apk (Alpine Linux)
-
-Pour installer la gemme sur Alpine Linux, ouvrez un terminal et tapez :
-
- $ sudo apk add asciidoctor
-
-Pour mettre à jour la gemme, utilisez :
-
- $ sudo apk add -u asciidoctor
-
-TIP: Votre système peut être configuré pour mettre à jour automatiquement les paquets apk, auquel cas aucune action de votre part ne sera nécessaire pour mettre à jour la gemme.
-
-=== Autres options d'installation
-
-* {uri-install-docker}[Installation d'Asciidoctor avec Docker]
-* {uri-install-osx-doc}[Installation d'Asciidoctor sur Mac OS X]
-// pour l'instant, l'entrée suivante est juste une répétition de l'information dans ce README
-//* {uri-install-doc}[Installation de l'outillage Asciidoctor]
-
-== Utilisation
-
-Si la gemme Asciidoctor s'est installée correctement, la ligne de commande (CLI) `asciidoctor` sera disponible dans votre PATH.
-Pour vérifier sa disponibilité, exécutez la commande suivante dans votre terminal :
-
- $ asciidoctor --version
-
-Vous devriez voir les informations concernant la version d'Asciidoctor et celle de votre environnement Ruby s'afficher dans le terminal.
-
-[.output,subs=attributes+]
-....
-Asciidoctor {release-version} [http://asciidoctor.org]
-Runtime Environment (ruby 2.4.1p111 [x86_64-linux]) (lc:UTF-8 fs:UTF-8 in:- ex:UTF-8)
-....
-
-Asciidoctor fournit aussi une API.
-Cette API permet une intégration avec d'autres logiciels Ruby, comme Rails, Sinatra et GitHub, ainsi que d'autres langages comme Java (via {uri-asciidoctorj}[AsciidoctorJ]) ou JavaScript (via {uri-asciidoctorjs}[Asciidoctor.js]).
-
-=== Interface de Ligne de Commande (CLI)
-
-La commande `asciidoctor` vous permet d'invoquer Asciidoctor à partir de la ligne de commande (c'est-à-dire, un terminal).
-
-La commande suivante convertit le fichier README.adoc en HTML et sauvegarde le résultat dans le fichier README.html dans le même répertoire.
-Le nom du fichier HTML généré est tiré de celui du fichier source, l'extension a été changée pour `.html`.
-
- $ asciidoctor README.adoc
-
-Vous pouvez contrôler le processeur Asciidoctor en ajoutant plusieurs paramètres, vous pouvez en apprendre plus sur ces derniers en utilisant la commande :
-
- $ asciidoctor --help
-
-Par exemple, pour écrire le fichier dans un répertoire différent, utilisez :
-
- $ asciidoctor -D output README.adoc
-
-La {uri-manpage}[page man] `asciidoctor` fournit une référence complète sur l'interface de ligne de commande.
-
-Référez-vous aux ressources suivantes pour en apprendre davantage sur la façon d'utiliser la commande `asciidoctor`.
-
-* {uri-render-doc}[Comment convertir un document ?]
-* {uri-themes-doc}[Comment utiliser la fabrique de feuilles de style Asciidoctor pour produire des thèmes personnalisés ?]
-
-=== API Ruby
-
-Pour utiliser Asciidoctor dans votre application, vous avez tout d'abord besoin de faire un « require » sur la gemme :
-
-[source]
-require 'asciidoctor'
-
-Vous pouvez ensuite convertir un fichier AsciiDoc en fichier HTML en utilisant :
-
-[source]
-Asciidoctor.convert_file 'README.adoc', to_file: true, safe: :safe
-
-WARNING: Quand vous utilisez Asciidoctor via l'API, le mode de sûreté par défaut est `:secure`.
-Dans le mode « secure », plusieurs fonctionnalités centrales sont désactivées, comme la directive `include`.
-Si vous souhaitez activer ces fonctionnalités, vous aurez besoin de définir explicitement le mode de sûreté avec une la valeur `:server` (recommandée) ou `:safe`.
-
-Vous pouvez aussi convertir une chaîne de texte en fragment HTML (pour une insertion dans une page HTML) en utilisant :
-
-[source]
-----
-content = '_Zen_ in the art of writing http://asciidoctor.org[AsciiDoc].'
-Asciidoctor.convert content, safe: :safe
-----
-
-Si vous voulez le document HTML complet, activez l'option `header_footer` comme ci-dessous :
-
-[source]
-----
-content = '_Zen_ in the art of writing http://asciidoctor.org[AsciiDoc].'
-html = Asciidoctor.convert content, header_footer: true, safe: :safe
-----
-
-Si vous avez besoin d'accéder au document analysé, vous pouvez séparer la conversion en deux étapes distinctes :
-
-[source]
-----
-content = '_Zen_ in the art of writing http://asciidoctor.org[AsciiDoc].'
-document = Asciidoctor.load content, header_footer: true, safe: :safe
-puts document.doctitle
-html = document.convert
-----
-
-Gardez en tête que si vous n'aimez pas le contenu généré par Asciidoctor, _vous pouvez le changer !_
-Asciidoctor supporte des convertisseurs personnalisés qui peuvent prendre en charge la conversion depuis le document analysé jusqu'au contenu généré.
-
-Une façon simple de personnaliser les morceaux de contenu générés est d'utiliser le convertisseur de template.
-Le convertisseur de template vous permet, en utilisant un template supporté par {uri-tilt}[Tilt], de prendre en charge la conversion de n'importe quel élément dans le document.
-
-Vous l'aurez compris, vous _pouvez_ complètement prendre le contrôle sur le contenu généré.
-Pour plus d'informations sur comment utiliser l'API ou personnaliser le contenu généré, référez-vous au {uri-user-manual}[manuel utilisateur].
-
-== Contributions
-
-Dans l'esprit du {uri-freesoftware}[logiciel libre], _tout le monde_ est encouragé à aider en vue d'améliorer le projet.
-Si vous découvrez des erreurs ou des oublis dans le code source, la documentation, ou le contenu du site web, s'il vous plaît n'hésitez pas à ouvrir un ticket ou une « pull request » avec un correctif.
-Les contributeurs et contributrices sont toujours les bienvenus !
-
-Voici quelques façons de contribuer :
-
-* en utilisant les versions prerelease (alpha, beta ou preview),
-* en rapportant des anomalies,
-* en suggérant de nouvelles fonctionnalités,
-* en écrivant ou éditant la documentation,
-* en écrivant des spécifications,
-* en écrivant du code -- _Aucun patch n'est trop petit_
-** corriger une coquille,
-** ajouter des commentaires,
-** nettoyer des espaces inutiles,
-** écrire des tests !
-* en refactorant le code,
-* en corrigeant des {uri-issues}[anomalies],
-* en effectuant des relectures des patches.
-
-Le guide du {uri-contribute}[parfait Contributeur] fournit des informations sur comment créer, styliser et soumettre des tickets, des demandes de fonctionnalités, du code et de la documentation pour le projet Asciidoctor.
-
-== Être aidé
-
-Le projet Asciidoctor est développé pour vous aider à écrire et publier du contenu.
-Mais nous ne pouvons pas le faire sans avoir vos avis !
-Nous vous encourageons à poser vos questions et discuter de n'importe quels aspects du projet sur la liste de discussion, Twitter ou dans le salon de discussion.
-
-Mailing list:: {uri-discuss}
-Twitter (Chat):: hashtag #asciidoctor ou la mention @asciidoctor
-Gitter (Chat):: image:https://badges.gitter.im/Join%20In.svg[Gitter, link=https://gitter.im/asciidoctor/asciidoctor]
-////
-IRC (Chat):: {uri-irc}[#asciidoctor] sur FreeNode IRC
-////
-
-ifdef::env-github[]
-De plus amples informations et documentations sur Asciidoctor peuvent être trouvées sur le site web du projet.
-
-{uri-project}/[Home] | {uri-news}[News] | {uri-docs}[Docs]
-endif::[]
-
-L'organisation Asciidoctor sur GitHub héberge le code source du projet, le gestionnaire de tickets ainsi que des sous-projets.
-
-Dépôt des sources (git):: {uri-repo}
-Gestionnaire de tickets:: {uri-issues}
-L'organisation Asciidoctor sur GitHub:: {uri-org}
-
-== Copyright et licence
-
-Copyright (C) 2012-2017 Dan Allen, Ryan Waldron et le projet Asciidoctor.
-Une utilisation libre de ce logiciel est autorisée sous les termes de la licence MIT.
-
-Consultez le fichier {uri-license}[LICENSE] pour plus de détails.
-
-== Auteurs
-
-*Asciidoctor* est mené par https://github.com/mojavelinux[Dan Allen] et https://github.com/graphitefriction[Sarah White] et reçoit de nombreuses contributions de la part de la {uri-contributors}[géniale communauté] Asciidoctor.
-Le projet a été initié en 2012 par https://github.com/erebor[Ryan Waldron] et est basé sur {uri-prototype}[un prototype] écrit par https://github.com/nickh[Nick Hengeveld].
-
-*AsciiDoc* a été démarré par Stuart Rackham et a reçu de nombreuses contributions de la part de la communauté AsciiDoc.
-
-== Changelog
-
-ifeval::[{safe-mode-level} < 20]
-include::CHANGELOG.adoc[tag=compact,leveloffset=+1]
-endif::[]
-
-Référez-vous au fichier {uri-changelog}[CHANGELOG] pour une liste complète des changements des versions précédentes.