diff --git a/build.gradle b/build.gradle index 2dde3631d..5feee26e7 100644 --- a/build.gradle +++ b/build.gradle @@ -9,7 +9,7 @@ buildscript { classpath 'me.champeau.gradle:gradle-javadoc-hotfix-plugin:0.1' classpath 'io.spring.gradle:docbook-reference-plugin:0.3.0' classpath 'org.asciidoctor:asciidoctor-gradle-plugin:1.5.0' - classpath('org.asciidoctor:asciidoctor-java-integration:0.1.4.preview.1') + classpath('org.asciidoctor:asciidoctorj:1.5.0') } } @@ -169,7 +169,7 @@ task javadocJar(type: Jar) { } task docsZip(type: Zip, dependsOn:['docbook', 'generateHTML']) { - + group = 'Distribution' classifier = 'docs' description = "Builds -${classifier} archive containing api and reference for deployment" @@ -187,7 +187,7 @@ task docsZip(type: Zip, dependsOn:['docbook', 'generateHTML']) { include "spring.css" into 'reference/htmlsingle' } - + from ("$buildDir/reference/pdf") { into 'reference/pdf' } @@ -254,7 +254,7 @@ tasks.withType(Test) { testLogging { exceptionFormat = 'full' - + afterSuite { desc, result -> if (!desc.parent) { // will match the outermost suite println "Test Summary: ${result.resultType} (${result.testCount} tests, ${result.successfulTestCount} successes, ${result.failedTestCount} failures, ${result.skippedTestCount} skipped)" @@ -277,39 +277,35 @@ task wrapper(type: Wrapper) { gradleVersion = '1.11' } -tasks.withType(org.asciidoctor.gradle.AsciidoctorTask) { docTask -> - options = [ - logDocuments: true, - attributes: [ +tasks.withType(org.asciidoctor.gradle.AsciidoctorTask) { docTask -> + options = [ + logDocuments: true, + doctype: 'book', + attributes: [ linkcss: 'true', copycss : 'spring.css', stylesheet: "spring.css", icons : 'font', 'source-highlighter': 'prettify', - sectanchors : '', - toc: '', toclevels: '4', idprefix: '', idseparator: '-', - doctype: 'book', - numbered: '', version: project.version, baseDir: "$sourceDir", resourcesDir: "$rootDir/src/main/resources", referenceDir: "$sourceDir/reference" - ] - ] + ] + ] } -task generateHTML (type: org.asciidoctor.gradle.AsciidoctorTask, description: 'Generates single and multiple HTML documentation.', group: 'Documentation') { - backend = 'html5' +task generateHTML (type: org.asciidoctor.gradle.AsciidoctorTask, description: 'Generates single and multiple HTML documentation.', group: 'Documentation') { + backends = [ 'html5' ] outputDir = new File("$buildDir/reference/htmlsingle") - options.attributes.doctype = 'book' - options.attributes.copycss = 'spring.css' + options.attributes.copycss = 'spring.css' } -task generateDocbook (type: org.asciidoctor.gradle.AsciidoctorTask, description: 'Generates DOCBOOK documentation.', group: 'Documentation', dependsOn : ['createEmptyDocbookSourceDirToCheatThePlugin']) { - backend = 'docbook' +task generateDocbook (type: org.asciidoctor.gradle.AsciidoctorTask, description: 'Generates DOCBOOK documentation.', group: 'Documentation', dependsOn : ['createEmptyDocbookSourceDirToCheatThePlugin']) { + backends = [ 'docbook' ] outputDir = new File("$buildDir/reference-work") options.attributes.chunkedOutput = 'true' options.attributes.stylesheet = 'chunked' diff --git a/src/asciidoc/appendix/appendix-command-reference.adoc b/src/asciidoc/appendix/appendix-command-reference.adoc index f864d6325..fa116ae84 100644 --- a/src/asciidoc/appendix/appendix-command-reference.adoc +++ b/src/asciidoc/appendix/appendix-command-reference.adoc @@ -1,169 +1,171 @@ [[appendix:command-reference]] +[appendix] = Command Reference +== Supported commands .Redis commands supported by RedisTemplate. [width="50%",cols="<2,^1",options="header"] |========================================================= |Command |Template Support -|APPEND |X -|AUTH |X -|BGREWRITEAOF |X -|BGSAVE |X -|BITCOUNT |X -|BITOP |X -|BLPOP |X -|BRPOP |X -|BRPOPLPUSH |X -|CLIENT KILL |X -|CLIENT GETNAME |X -|CLIENT LIST |X -|CLIENT SETNAME |X -|CONFIG GET |X -|CONFIG RESETSTAT |X -|CONFIG REWRITE |- -|CONFIG SET |X -|DBSIZE |X -|DEBUG OBJECT |- -|DEBUG SEGFAULT |- -|DECR |X -|DECRBY |X -|DEL |X -|DISCARD |X -|DUMP |X -|ECHO |X -|EVAL |X -|EVALSHA |X -|EXEC |X -|EXISTS |X -|EXPIRE |X -|EXPIREAT |X -|FLUSHALL |X -|FLUSHDB |X -|GET |X -|GETBIT |X -|GETRANGE |X -|GETSET |X -|HDEL |X -|HEXISTS |X -|HGET |X -|HGETALL |X -|HINCRBY |X -|HINCRBYFLOAT |X -|HKEYS |X -|HLEN |X -|HMGET |X -|HMSET |X -|HSCAN |X -|HSET |X -|HSETNX |X -|HVALS |X -|INCR |X -|INCRBY |X -|INCRBYFLOAT |X -|INFO |X -|KEYS |X -|LASTSAVE |X -|LINDEX |X -|LINSERT |X -|LLEN |X -|LPOP |X -|LPUSH |X -|LPUSHX |X -|LRANGE |X -|LREM |X -|LSET |X -|LTRIM |X -|MGET |X -|MIGRATE |- -|MONITOR |- -|MOVE |X -|MSET |X -|MSETNX |X -|MULTI |X -|OBJECT |- -|PERSIST |X -|PEXIPRE |X -|PEXPIREAT |X -|PING |X -|PSETEX |X -|PSUBSCRIBE |X -|PTTL |X -|PUBLISH |X -|PUBSUB |- -|PUBSUBSCRIBE |- -|QUIT |X -|RANDOMKEY |X -|RENAME |X -|RENAMENX |X -|RESTORE |X -|RPOP |X -|RPOPLPUSH |X -|RPUSH |X -|RPUSHX |X -|SADD |X -|SAVE |X -|SCAN |X -|SCARD |X -|SCRIPT EXITS |X -|SCRIPT FLUSH |X -|SCRIPT KILL |X -|SCRIPT LOAD |X -|SDIFF |X -|SDIFFSTORE |X -|SELECT |X -|SENTINEL FAILOVER |- -|SENTINEL GET-MASTER-ADD-BY-NAME |- -|SENTINEL MASTER |- -|SENTINEL MASTERS |- -|SENTINEL MONITOR |- -|SENTINEL REMOVE |- -|SENTINEL RESET |- -|SENTINEL SET |- -|SENTINEL SLAVES |- -|SET |X -|SETBIT |X -|SETEX |X -|SETNX |X -|SETRANGE |X -|SHUTDOWN |X -|SINTER |X -|SINTERSTORE |X -|SISMEMBER |X -|SLAVEOF |X -|SLOWLOG |- -|SMEMBERS |X -|SMOVE |X -|SORT |X -|SPOP |X -|SRANDMEMBER |X -|SREM |X -|SSCAN |X -|STRLEN |X -|SUBSCRIBE |X -|SUNION |X -|SUNIONSTORE |X -|SYNC |- -|TIME |X -|TTL |X -|TYPE |X -|UNSUBSCRIBE |X -|UNWATCH |X -|WATCH |X -|ZADD |X -|ZCARD |X -|ZCOUNT |X -|ZINCRBY |X -|ZINTERSTORE |X -|ZRANGE |X -|ZRANGEBYSCORE |X -|ZRANK |X -|ZREM |X -|ZREMRANGEBYRANK |X -|ZREVRANGE |X -|ZREVRANGEBYSCORE |X -|ZREVRANK |X -|ZSCAN |X -|ZSCORE |X -|ZUNINONSTORE |X +|APPEND |X +|AUTH |X +|BGREWRITEAOF |X +|BGSAVE |X +|BITCOUNT |X +|BITOP |X +|BLPOP |X +|BRPOP |X +|BRPOPLPUSH |X +|CLIENT KILL |X +|CLIENT GETNAME |X +|CLIENT LIST |X +|CLIENT SETNAME |X +|CONFIG GET |X +|CONFIG RESETSTAT |X +|CONFIG REWRITE |- +|CONFIG SET |X +|DBSIZE |X +|DEBUG OBJECT |- +|DEBUG SEGFAULT |- +|DECR |X +|DECRBY |X +|DEL |X +|DISCARD |X +|DUMP |X +|ECHO |X +|EVAL |X +|EVALSHA |X +|EXEC |X +|EXISTS |X +|EXPIRE |X +|EXPIREAT |X +|FLUSHALL |X +|FLUSHDB |X +|GET |X +|GETBIT |X +|GETRANGE |X +|GETSET |X +|HDEL |X +|HEXISTS |X +|HGET |X +|HGETALL |X +|HINCRBY |X +|HINCRBYFLOAT |X +|HKEYS |X +|HLEN |X +|HMGET |X +|HMSET |X +|HSCAN |X +|HSET |X +|HSETNX |X +|HVALS |X +|INCR |X +|INCRBY |X +|INCRBYFLOAT |X +|INFO |X +|KEYS |X +|LASTSAVE |X +|LINDEX |X +|LINSERT |X +|LLEN |X +|LPOP |X +|LPUSH |X +|LPUSHX |X +|LRANGE |X +|LREM |X +|LSET |X +|LTRIM |X +|MGET |X +|MIGRATE |- +|MONITOR |- +|MOVE |X +|MSET |X +|MSETNX |X +|MULTI |X +|OBJECT |- +|PERSIST |X +|PEXIPRE |X +|PEXPIREAT |X +|PING |X +|PSETEX |X +|PSUBSCRIBE |X +|PTTL |X +|PUBLISH |X +|PUBSUB |- +|PUBSUBSCRIBE |- +|QUIT |X +|RANDOMKEY |X +|RENAME |X +|RENAMENX |X +|RESTORE |X +|RPOP |X +|RPOPLPUSH |X +|RPUSH |X +|RPUSHX |X +|SADD |X +|SAVE |X +|SCAN |X +|SCARD |X +|SCRIPT EXITS |X +|SCRIPT FLUSH |X +|SCRIPT KILL |X +|SCRIPT LOAD |X +|SDIFF |X +|SDIFFSTORE |X +|SELECT |X +|SENTINEL FAILOVER |- +|SENTINEL GET-MASTER-ADD-BY-NAME |- +|SENTINEL MASTER |- +|SENTINEL MASTERS |- +|SENTINEL MONITOR |- +|SENTINEL REMOVE |- +|SENTINEL RESET |- +|SENTINEL SET |- +|SENTINEL SLAVES |- +|SET |X +|SETBIT |X +|SETEX |X +|SETNX |X +|SETRANGE |X +|SHUTDOWN |X +|SINTER |X +|SINTERSTORE |X +|SISMEMBER |X +|SLAVEOF |X +|SLOWLOG |- +|SMEMBERS |X +|SMOVE |X +|SORT |X +|SPOP |X +|SRANDMEMBER |X +|SREM |X +|SSCAN |X +|STRLEN |X +|SUBSCRIBE |X +|SUNION |X +|SUNIONSTORE |X +|SYNC |- +|TIME |X +|TTL |X +|TYPE |X +|UNSUBSCRIBE |X +|UNWATCH |X +|WATCH |X +|ZADD |X +|ZCARD |X +|ZCOUNT |X +|ZINCRBY |X +|ZINTERSTORE |X +|ZRANGE |X +|ZRANGEBYSCORE |X +|ZRANK |X +|ZREM |X +|ZREMRANGEBYRANK |X +|ZREVRANGE |X +|ZREVRANGEBYSCORE |X +|ZREVRANK |X +|ZSCAN |X +|ZSCORE |X +|ZUNINONSTORE |X |========================================================= \ No newline at end of file diff --git a/src/asciidoc/appendix/appendix-schema.adoc b/src/asciidoc/appendix/appendix-schema.adoc index fc83056fa..ced57d0c4 100644 --- a/src/asciidoc/appendix/appendix-schema.adoc +++ b/src/asciidoc/appendix/appendix-schema.adoc @@ -1,8 +1,9 @@ [[appendix:schema]] +[appendix] = Schema :resourcesDir: ../../main/resources -Core schema +== Core schema [source,xml] ------------------------------------------- diff --git a/src/asciidoc/index.adoc b/src/asciidoc/index.adoc index 253c03ae2..f36e972e1 100644 --- a/src/asciidoc/index.adoc +++ b/src/asciidoc/index.adoc @@ -1,48 +1,43 @@ [[spring-data-keyvalue-reference]] = Spring Data Redis Costin Leau, Jennifer Hickey, Christoph Strobl, Thomas Darimont -:baseDir: . +:revnumber: {version} +:revdate: {localdate} :toc: +:toc-placement!: :spring-data-commons-docs: https://raw.githubusercontent.com/spring-projects/spring-data-commons/master/src/main/asciidoc -{version} +(C) 2011-2014 The original authors. -(C) 2011-2014 The original authors +NOTE: Copies of this document may be made for your own use and for distribution to others, provided that you do not charge any fee for such copies and further provided that each copy contains this Copyright Notice, whether distributed in print or electronically. -NOTE: _Copies of this document may be made for your own use and for distribution to others, provided that you do not charge any fee for such copies and further provided that each copy contains this Copyright Notice, whether distributed in print or electronically._ +toc::[] include::{baseDir}/preface.adoc[] -:numbered: -:leveloffset: 0 [[introduction]] = Introduction -:leveloffset: 2 +:leveloffset: +1 include::{baseDir}/introduction/introduction.adoc[] include::{baseDir}/introduction/why-sdr.adoc[] include::{baseDir}/introduction/requirements.adoc[] include::{baseDir}/introduction/getting-started.adoc[] +:leveloffset: -1 -:leveloffset: 0 [[reference]] = Reference Documentation -:leveloffset: 1 +:leveloffset: +1 include::{baseDir}/reference/introduction.adoc[] include::{baseDir}/reference/redis.adoc[] +:leveloffset: -1 -:leveloffset: 0 [[appendixes]] = Appendixes :numbered!: -:leveloffset: 1 - +:leveloffset: +1 include::{baseDir}/appendix/introduction.adoc[] - -[appendix] include::{baseDir}/appendix/appendix-schema.adoc[] - -[appendix] include::{baseDir}/appendix/appendix-command-reference.adoc[] diff --git a/src/asciidoc/preface.adoc b/src/asciidoc/preface.adoc index f2adc26a8..23eb152e2 100644 --- a/src/asciidoc/preface.adoc +++ b/src/asciidoc/preface.adoc @@ -1,4 +1,3 @@ -[preface] = Preface The Spring Data Redis project applies core Spring concepts to the development of solutions using a key-value style data store. We provide a "template" as a high-level abstraction for sending and receiving messages. You will notice similarities to the JDBC support in the Spring Framework.