{
    "id": "ruby_webcomics_cheat_sheet",
    "name": "Ruby Webcomics",
    "description": "Reference documentation for the Ruby Webcomics library.",
    "columns": 2,

    "metadata": {
        "sourceName": "imaginegen.github.io",
        "sourceUrl" : "http://imaginegen.github.io/main/2016/02/22/webcomics-reference.html"
    },

    "aliases": [
        "webcomics spec", "webcomics documentation", "webcomics docs"
    ],

    "template_type": "reference",

    "section_order": [
        "Comics Directory",
        "Comics DB",
        "Comics Canvas",
        "Comics Directory Helper",
        "Comics Engine"
    ],

    "sections": {
        "Comics Directory": [
            {
                "key": "return_an_array_of_comics_entries(directory)",
                "val": "Returns an array of entries from a directory without previous and current directories"
            },
            {
                "key": "return_comics_entries_without_file_extentions(array)",
                "val": "Returns an array of entries without file extentions"
            },
            {
                "key": "is_this_series_path_a_directory?(series_path)",
                "val": "Returns true if the series path is a directory. Return false otherwise"
            },
            {
                "key": "is_this_series_path_a_chapter?(series_path)",
                "val": "Returns true if the series path is a directory. Return false otherwise"
            },
            {
                "key": "return_an_array_of_chapters(series_path)",
                "val": "Returns an array of all the directories within this series path"
            },
            {
                "key": "is_this_series_path_a_page?(series_path)",
                "val": "Returns true if the series path is a file. Return false otherwise"
            },
            {
                "key": "return_an_array_of_comics_pages(series_path)",
                "val": "Returns an array of all the files within this series path"
            },
            {
                "key": "return_an_array_of_alpha_chapters(series_path)",
                "val": "Returns an array of all the directories within this series path that only consist of letters"
            },
            {
                "key": "return_an_array_of_numeric_chapters(series_path)",
                "val": "Returns an array of all the directories within this series path that only consist of numbers"
            }
        ],
        "Comics DB": [
            {
                "key": "is_there_a_db_field_value_that_matches_an_asset?",
                "val": "Returns true if a folder matching the folder name to the database field value. Returns false otherwise"
            },
            {
                "key": "is_there_a_db_field_value_that_matches_a_series?",
                "val": "Returns true if a folder matching the folder name to the database field value. Returns false otherwise"
            }
        ],
        "Comics Canvas": [
            {
                "key": "length_of_the_comic(series_path)",
                "val": "Returns the amount of pages in the series"
            },
            {
                "key": "page_equalizer(page, series_path)",
                "val": "Returns the number of pages in the series path if the page number is less than zero. Returns zero if the number of pages is greater than or equal to the number of pages in the series path"
            }
        ],
        "Comics Directory Helper": [
            {
                "key": "return_page(series_path, page = 0)",
                "val": "Returns a specified page. It takes two arguments; series_path should be the path to the series folder, and the page should be the index to the page you want to be returned from the array. By default, it returns the first page"
            },
            {
                "key": "does_this_series_have_chapters?(series_path)",
                "val": "Returns true if the comic book series has chapters. Returns false otherwise"
            }
        ],
        "Comics Directory Helper": [
            {
                "key": "return_page(series_path, page = 0)",
                "val": "Returns a specified page. It takes two arguments; series_path should be the path to the series folder, and the page should be the index to the page you want to be returned from the array. By default, it returns the first page"
            },
            {
                "key": "does_this_series_have_chapters?(series_path)",
                "val": "Returns true if the comic book series has chapters. Returns false otherwise."
            }
        ],
        "Comics Engine": [
            {
                "key": "return_an_array_of_entries_without_image_files(array)",
                "val": "Returns an array of entries without image files and hash files."
            },
            {
                "key": "return_series_assets_directories(series_path)",
                "val": "Returns an array of entries with only assets. Assets are directories that are relevant to a “Comics Engine”. Those relevant directories are folders, and .cbz/.zip files"
            },
            {
                "key": "return_an_array_of_pages(series_path = “”, path_to_cbz = “”)",
                "val": "Returns an array of entries from either a folder or a .cbz/.zip"
            }
        ]
    }
}
