class Object

Public Instance Methods

customized_wiki() click to toggle source

Note, if you want to activate this, you need to uncomment the line below.

# File lib/caramelize/caramel.rb, line 10
def customized_wiki

  # This example is a reimplementation of the WikkaWiki-Connector.
  # To connect to WikkaWiki, I suggest to use the predefined Connector below.
  options = { host: "localhost",
              username: "user",
              database: "database_name",
              password: 'Picard-Delta-5',
              markup: :wikka}
  wiki = Caramelize::InputWiki::Wiki.new(options)
  wiki.instance_eval do
    def read_pages
      sql = "SELECT id, tag, body, time, latest, user, note FROM wikka_pages ORDER BY time;"
      results = database.query(sql)
      results.each do |row|
        titles << row["tag"]
        author = @authors[row["user"]]
        properties = { id: row["id"],
                    title: row["tag"],
                    body: row["body"],
                    markup: 'wikka',
                    latest: row["latest"] == "Y",
                    time: row["time"],
                    message: row["note"],
                    author: author,
                    author_name: row["user"]}
        page = Page.new(properties)
        revisions << page
      end
      titles.uniq!
      revisions
    end
  end

  wiki
end
input_wiki() click to toggle source
# File lib/caramelize/caramel.rb, line 71
def input_wiki
  # comment and uncomment to easily switch between predefined and
  # costumized Wiki-connectors.

  #return customized_wiki

  return predefined_wiki
end
predefined_wiki() click to toggle source

if you want to use one of the preset Wiki-Connectors uncomment the connector and edit the database logins accordingly.

# File lib/caramelize/caramel.rb, line 50
def predefined_wiki

  # For connection to a WikkaWiki-Database use this Connector
  #options = { host: "localhost",
  #      username: "root",
  #      password: "root",
  #      database: "wikka" }
  #return Caramelize::InputWiki::WikkaWiki.new(options)


  # For connection to a Redmine-Database use this Connector
  # Additional options:
  # :create_namespace_overview => true/false (Default: true)  -  Creates a new wikipage at /home as root page for Gollum wiki
  options = { host: "localhost",
              username: "root",
              password: "root",
              database: "redmine_development" }
  return Caramelize::InputWiki::RedmineWiki.new(options)
end
read_pages() click to toggle source
# File lib/caramelize/caramel.rb, line 21
def read_pages
  sql = "SELECT id, tag, body, time, latest, user, note FROM wikka_pages ORDER BY time;"
  results = database.query(sql)
  results.each do |row|
    titles << row["tag"]
    author = @authors[row["user"]]
    properties = { id: row["id"],
                title: row["tag"],
                body: row["body"],
                markup: 'wikka',
                latest: row["latest"] == "Y",
                time: row["time"],
                message: row["note"],
                author: author,
                author_name: row["user"]}
    page = Page.new(properties)
    revisions << page
  end
  titles.uniq!
  revisions
end