floorplan v0.0.1 Floorplan

Primary interface for generating a sitemap

Summary

Functions

takes the target location for the sitemap index and a collection of link_sources. link_sources can be either a stream or enum

Notify the queue the stream is finished and should be dumped to file before max queue size has been reached

Functions

completed?()
config()
ensure_writeable_destination!(index_name)
generate(index_name, link_sources)

takes the target location for the sitemap index and a collection of link_sources. link_sources can be either a stream or enum.

Examples

iex> link_source = [ %Floorplan.UrlLink{} ] …>Floorplan.generate(“/tmp/sitemap.xml”, link_source)

Generated sitemap to destination: '/tmp'
✓ tmp/sitemap.xml.gz  -- 1 urls
✓ tmp/sitemap1.xml.gz  -- 1 urls
Elapsed time: 10.533 milliseconds

{:ok, [{"/tmp/sitemap.xml.gz", :completed}, {"/tmp/sitemap1.xml.gz", :completed}]}

notify_stream_finished()

Notify the queue the stream is finished and should be dumped to file before max queue size has been reached.