Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions source/_includes/code_example.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{% assign _title = include.title | default: 'Full JSON example' %}
{% assign _target = include.target | default: "_blank" %}

<div class="code-example">
<div class="code-example__header">
<a href="example/{{ include.src }}" target="{{ _target }}">{{ _title }}</a></div>
{% highlight json %}
{% include_lines presentation/4.0/example/{{ include.src }} from:{{ include.from }} to:{{ include.to }} %}
{% endhighlight %}
</div>
89 changes: 89 additions & 0 deletions source/_includes/links.md
Original file line number Diff line number Diff line change
Expand Up @@ -306,3 +306,92 @@
[recipe-segment-image-part]: {{ site.api_url | absolute_url }}/cookbook/segment-image-part/ "Annotating part of an image to a canvas"
[slack]: http://bit.ly/iiif-slack
[web-arch]: http://www.w3.org/TR/webarch/ "Architecture of the World Wide Web"


<!-- Link definitions for Presentation API 4.0 model references -->
<!-- Generated by scripts/link_code_references.py -->

[prezi-40-model-Agent]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#Agent
[prezi-40-model-AmbientAudio]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#AmbientAudio
[prezi-40-model-AnimationSelector]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#AnimationSelector
[prezi-40-model-Annotation]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#Annotation
[prezi-40-model-AnnotationCollection]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#AnnotationCollection
[prezi-40-model-AnnotationPage]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#AnnotationPage
[prezi-40-model-Canvas]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#Canvas
[prezi-40-model-Choice]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#Choice
[prezi-40-model-Collection]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#Collection
[prezi-40-model-FragmentSelector]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#FragmentSelector
[prezi-40-model-Manifest]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#Manifest
[prezi-40-model-OrthographicCamera]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#OrthographicCamera
[prezi-40-model-PerspectiveCamera]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#PerspectiveCamera
[prezi-40-model-PointAudio]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#PointAudio
[prezi-40-model-PointSelector]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#PointSelector
[prezi-40-model-Range]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#Range
[prezi-40-model-RotateTransform]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#RotateTransform
[prezi-40-model-ScaleTransform]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#ScaleTransform
[prezi-40-model-Scene]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#Scene
[prezi-40-model-Service]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#Service
[prezi-40-model-SpecificResource]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#SpecificResource
[prezi-40-model-SpotAudio]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#SpotAudio
[prezi-40-model-SpotLight]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#SpotLight
[prezi-40-model-SvgSelector]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#SvgSelector
[prezi-40-model-TextualBody]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#TextualBody
[prezi-40-model-Timeline]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#Timeline
[prezi-40-model-TranslateTransform]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#TranslateTransform
[prezi-40-model-WktSelector]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#WktSelector
[prezi-40-model-accompanyingContainer]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#accompanyingContainer
[prezi-40-model-action]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#action
[prezi-40-model-angle]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#angle
[prezi-40-model-annotations]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#annotations
[prezi-40-model-backgroundColor]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#backgroundColor
[prezi-40-model-behavior]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#behavior
[prezi-40-model-body]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#body
[prezi-40-model-color]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#color
[prezi-40-model-duration]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#duration
[prezi-40-model-exclude]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#exclude
[prezi-40-model-far]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#far
[prezi-40-model-fieldOfView]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#fieldOfView
[prezi-40-model-format]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#format
[prezi-40-model-height]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#height
[prezi-40-model-homepage]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#homepage
[prezi-40-model-id]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#id
[prezi-40-model-instant]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#instant
[prezi-40-model-intensity]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#intensity
[prezi-40-model-interactionMode]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#interactionMode
[prezi-40-model-items]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#items
[prezi-40-model-label]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#label
[prezi-40-model-language]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#language
[prezi-40-model-lookAt]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#lookAt
[prezi-40-model-metadata]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#metadata
[prezi-40-model-motivation]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#motivation
[prezi-40-model-navDate]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#navDate
[prezi-40-model-navPlace]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#navPlace
[prezi-40-model-near]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#near
[prezi-40-model-placeholderContainer]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#placeholderContainer
[prezi-40-model-position]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#position
[prezi-40-model-profile]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#profile
[prezi-40-model-provider]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#provider
[prezi-40-model-provides]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#provides
[prezi-40-model-refinedBy]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#refinedBy
[prezi-40-model-rendering]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#rendering
[prezi-40-model-requiredStatement]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#requiredStatement
[prezi-40-model-rights]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#rights
[prezi-40-model-service]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#service
[prezi-40-model-source]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#source
[prezi-40-model-spatialScale]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#spatialScale
[prezi-40-model-start]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#start
[prezi-40-model-structures]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#structures
[prezi-40-model-summary]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#summary
[prezi-40-model-supplementary]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#supplementary
[prezi-40-model-target]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#target
[prezi-40-model-temporalScale]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#temporalScale
[prezi-40-model-thumbnail]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#thumbnail
[prezi-40-model-timeMode]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#timeMode
[prezi-40-model-transform]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#transform
[prezi-40-model-type]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#type
[prezi-40-model-viewingDirection]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#viewingDirection
[prezi-40-model-volume]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#volume
[prezi-40-model-width]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#width
[prezi-40-model-x]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#x
[prezi-40-model-y]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#y
[prezi-40-model-z]: {{ site.api_url | absolute_url }}/presentation/4.0/model/#z
140 changes: 140 additions & 0 deletions source/_plugins/include_lines.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,140 @@
require 'liquid'

module Jekyll
class IncludeLinesTag < Liquid::Tag
def initialize(tag_name, markup, tokens)
super
@markup = markup.to_s.strip
end

def render(context)
site = context.registers[:site]
source = site.source

rendered_markup = Liquid::Template.parse(@markup).render(context)
path, options = parse_markup(rendered_markup)
raise ArgumentError, "include_lines: missing file path" if path.nil? || path.empty?

from = integer_option(options, 'from')
to = integer_option(options, 'to')
start = integer_option(options, 'start')
finish = integer_option(options, 'end')

from ||= start
to ||= finish

format = true
if options.key?('format')
format = boolean_option(options, 'format')
end
indent = integer_option(options, 'indent')

unless from && to
raise ArgumentError, "include_lines: must specify from/to (1-indexed), e.g. {% include_lines path from:11 to:35 %}"
end

if from < 1 || to < 1
raise ArgumentError, "include_lines: from/to must be >= 1 (got from:#{from} to:#{to})"
end

if to < from
raise ArgumentError, "include_lines: to must be >= from (got from:#{from} to:#{to})"
end

absolute_path = File.expand_path(path, source)
unless absolute_path.start_with?(File.expand_path(source) + File::SEPARATOR)
raise ArgumentError, "include_lines: path must be within the site source directory"
end

unless File.file?(absolute_path)
raise ArgumentError, "include_lines: file not found: #{path}"
end

lines = File.read(absolute_path, encoding: 'UTF-8').split("\n", -1)
max_line = lines.length

if from > max_line
raise ArgumentError, "include_lines: from (#{from}) is beyond end of file (#{max_line} lines): #{path}"
end

to = [to, max_line].min

selected = lines[(from - 1)..(to - 1)]

if format
selected = dedent_lines(selected)
end

if indent && indent > 0
prefix = ' ' * indent
selected = selected.map { |l| l.strip.empty? ? l : (prefix + l) }
end

selected.join("\n")
rescue StandardError => e
if defined?(Jekyll) && Jekyll.respond_to?(:logger) && Jekyll.logger
Jekyll.logger.error("include_lines:", e.message)
end
raise
end

private

def parse_markup(markup)
tokens = markup.scan(/\"[^\"]+\"|\'[^\']+\'|\S+/)
return [nil, {}] if tokens.empty?

path_token = tokens.shift
path = unquote(path_token)

options = {}
tokens.each do |t|
key, value = t.split(':', 2)
next if value.nil?
options[key] = unquote(value)
end

[path, options]
end

def unquote(value)
v = value.to_s
if (v.start_with?('"') && v.end_with?('"')) || (v.start_with?("'") && v.end_with?("'"))
v[1..-2]
else
v
end
end

def integer_option(options, key)
return nil unless options.key?(key)
Integer(options[key])
rescue ArgumentError
raise ArgumentError, "include_lines: #{key} must be an integer (got #{options[key].inspect})"
end

def boolean_option(options, key)
return nil unless options.key?(key)

v = options[key].to_s.strip.downcase
return true if %w[1 true yes y on].include?(v)
return false if %w[0 false no n off].include?(v)

raise ArgumentError, "include_lines: #{key} must be a boolean (got #{options[key].inspect})"
end

def dedent_lines(lines)
non_empty = lines.reject { |l| l.strip.empty? }
return lines if non_empty.empty?

min_indent = non_empty.map { |l| l[/\A[ \t]*/].length }.min
return lines if min_indent.nil? || min_indent.zero?

lines.map do |l|
l.strip.empty? ? l : l[min_indent..]
end
end
end
end

Liquid::Template.register_tag('include_lines', Jekyll::IncludeLinesTag)
37 changes: 37 additions & 0 deletions source/presentation/4.0/example/02_timeline.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
{
"@context": "http://iiif.io/api/presentation/4/context.json",
"id": "https://iiif.io/api/presentation/4.0/example/02_timeline.json",
"type": "Manifest",
"label": {
"en": [
"Simplest Audio Example (IIIF Presentation v4)"
]
},
"items": [
{
"id": "https://iiif.io/api/presentation/4.0/example/02",
"type": "Timeline",
"duration": 1985.024,
"items": [
{
"id": "https://iiif.io/api/presentation/4.0/example/02/page",
"type": "AnnotationPage",
"items": [
{
"id": "https://iiif.io/api/presentation/4.0/example/02/page/anno",
"type": "Annotation",
"motivation": "painting",
"body": {
"id": "https://fixtures.iiif.io/audio/indiana/mahler-symphony-3/CD1/medium/128Kbps.mp4",
"type": "Sound",
"format": "audio/mp4",
"duration": 1985.024
},
"target": "https://iiif.io/api/presentation/4.0/example/02"
}
]
}
]
}
]
}
Loading
Loading