Maven Central:

From Digimead Ivy: jar

From Digimead Maven: jar

SBT
Maven
Ivy
Grape
Gradle
Buildr

libraryDependencies += "###ORG###" % "###ARTIFACT###" % "###VERSION###"

<dependency>
  <groupId>###ORG###</groupId>
  <artifactId>###ARTIFACT###</artifactId>
  <version>###VERSION###</version>
</dependency>

<dependency org="###ORG###" name="###ARTIFACT###" rev="###VERSION###" />

@Grapes(
    @Grab(group='###ORG###', module='###ARTIFACT###', version='###VERSION###')
)

'###ORG###:###ARTIFACT###:###VERSION###'

'###ORG###:###ARTIFACT###:jar:###VERSION###'

You may add Maven repository:

resolvers += "digimead-maven" at "http://storage.googleapis.com/maven.repository.digimorg/"

Or you may add Ivy repository:

resolvers += Resolver.url("digimead-ivy", url("http://storage.googleapis.com/ivy.repository.digimead.org/"))(Resolver.defaultIvyPatterns)

And then

addSbtPlugin("###ORG###" % "###ARTIFACT###" % "###VERSION###")

Or you may create a

project/project/Build.scala

file that looks like the following:

import sbt._
object PluginDef extends Build {
  override def projects = Seq(root)
  lazy val root = Project("plugins", file(".")) dependsOn(plugin)
  lazy val plugin = uri("git://github.com/###ORG###/###ARTIFACT###.git#TagOrCommit")
}

You may find more information about Build.scala in SBT documentation

Mr. Alexey Aksenov aka ЁЖ

Primary email
Secondary email
Skype
ICQ
Russian phone
United Kindom phone
WorldWide SIP

Repositories:

Digimead Ivy located at http://storage.googleapis.com/ivy.repository.digimead.org/

Digimead Maven located at http://storage.googleapis.com/maven.repository.digimead.org/

Booklet - Usage

Booklet ⇦ Previous Page

Next Page ⇨ Options

Usage

Components

Booklet itself consists of 3 parts:

booklet-library - Core part that provides storage, options, Scalate publishing logic;
booklet-knockoff - Knockoff integration part that enhance standard Knockoff parsers;
booklet-app - application, that compatible with SBT launcher.

Use as the standalone application

You may start it in *NIX environment with command line like this:

java \
  -Dsbt.boot.properties=/home/user/booklet/booklet-app.configuration \
  -jar /home/user/booklet/sbt-launch.jar -- @mybooklet.properties

where

sbt.boot.properties - location of the application configuration
sbt-launch.jar - the latest ;-) launcher from SBT
mybooklet.properties - argument with user options, for example. Use '-h' for help

Application configuration

The typical application configuration is provided bellow. You may copy'n'paste it or download sample one and modify. Change 1.2.3.4-SNAPSHOT version to the latest available.

[scala]
  version: 2.10.3
[app]
  org: org.digimead
  name: booklet-app
  version: 1.2.3.4-SNAPSHOT
  class: org.digimead.booklet.Application
  cross-versioned: binary
[repositories]
  local
  maven-central
  digimead-maven: http://storage.googleapis.com/maven.repository.digimead.org/
[boot]
  directory: \${user.home}/.sbt/booklet-boot

SBT launcher

You may use any available SBT launcher. I recommend the latest one.

User options

File with user options may be specified in @file format. For example I used bellow options file while designing Booklet:

resources: /my/path/to/template-dev
user: digimead-specific
project: Booklet
artifacts: booklet-app, booklet-knockoff, booklet-library
logo: http://commondatastorage.googleapis.com/digimead/booklet.png
disqus: Booklet

Of course, for publishing I provided different options. I specified path to production template with compressed resources and adjusted other parameters.

Running

docs directory with markdown files must be exists. After start you will see something like:

[main] INFO org.digimead.booklet.template.Preview\$ - Warm up Scalate engine.
[main] INFO org.eclipse.jetty.server.Server - jetty-7.6.9.v20130131
[main] INFO org.eclipse.jetty.server.handler.ContextHandler - started o.e.j.s.ServletContextHandler{/,null}
[main] INFO org.eclipse.jetty.server.AbstractConnector - Started SocketConnector@127.0.0.1:50059

Previewing `docs`. Press CTRL+C to stop.

The Booklet is ready to process HTTP requests on 127.0.0.1:50059.

Use as a library

Add Booklet to you application and invoke

Produce(BookletStorage(input, bookletProperties).globalized, output)

where

input - directory with markdown files
output - directory with transformation result
bookletProperties - user options

Booklet

Current state

I Like It

Versions

Correctness

Select spelling error with your mouse and press Ctrl+Enter

This information is provided in the hope that it will be useful and help people with their first steps, even if it is written in broken English... Would you have preferred well written Russian? :-) Please, correct it, if you find something inappropriate.

Digimead Artifacts