1.1.1.2. nikola.plugins package¶
Plugins for Nikola.
1.1.1.2.1. Subpackages¶
- 1.1.1.2.1.1. nikola.plugins.command package
- 1.1.1.2.1.1.1. Subpackages
- 1.1.1.2.1.1.2. Submodules
- 1.1.1.2.1.1.3. nikola.plugins.command.check module
- 1.1.1.2.1.1.4. nikola.plugins.command.console module
- 1.1.1.2.1.1.5. nikola.plugins.command.default_config module
- 1.1.1.2.1.1.6. nikola.plugins.command.deploy module
- 1.1.1.2.1.1.7. nikola.plugins.command.github_deploy module
- 1.1.1.2.1.1.8. nikola.plugins.command.import_wordpress module
CommandImportWordpressCommandImportWordpress.all_tagsCommandImportWordpress.cmd_optionsCommandImportWordpress.code_re1CommandImportWordpress.code_re2CommandImportWordpress.code_re3CommandImportWordpress.code_re4CommandImportWordpress.doc_purposeCommandImportWordpress.doc_usageCommandImportWordpress.download_url_content_to_file()CommandImportWordpress.get_channel_from_file()CommandImportWordpress.import_attachment()CommandImportWordpress.import_postpage_item()CommandImportWordpress.import_posts()CommandImportWordpress.nameCommandImportWordpress.needs_configCommandImportWordpress.populate_context()CommandImportWordpress.process_item_if_attachment()CommandImportWordpress.process_item_if_post_or_page()CommandImportWordpress.read_xml_file()CommandImportWordpress.transform_caption()CommandImportWordpress.transform_code()CommandImportWordpress.transform_content()CommandImportWordpress.transform_multiple_newlines()CommandImportWordpress.write_attachments_info()
get_text_tag()install_plugin()modernize_qtranslate_tags()separate_qtranslate_tagged_langs()
- 1.1.1.2.1.1.9. nikola.plugins.command.init module
- 1.1.1.2.1.1.10. nikola.plugins.command.new_page module
- 1.1.1.2.1.1.11. nikola.plugins.command.new_post module
- 1.1.1.2.1.1.12. nikola.plugins.command.orphans module
- 1.1.1.2.1.1.13. nikola.plugins.command.plugin module
CommandPluginCommandPlugin.cmd_optionsCommandPlugin.do_install()CommandPlugin.do_uninstall()CommandPlugin.do_upgrade()CommandPlugin.doc_purposeCommandPlugin.doc_usageCommandPlugin.get_json()CommandPlugin.jsonCommandPlugin.list_available()CommandPlugin.list_installed()CommandPlugin.nameCommandPlugin.needs_configCommandPlugin.output_dir
- 1.1.1.2.1.1.14. nikola.plugins.command.serve module
- 1.1.1.2.1.1.15. nikola.plugins.command.status module
- 1.1.1.2.1.1.16. nikola.plugins.command.subtheme module
- 1.1.1.2.1.1.17. nikola.plugins.command.theme module
CommandThemeCommandTheme.cmd_optionsCommandTheme.copy_template()CommandTheme.do_install()CommandTheme.do_install_deps()CommandTheme.do_uninstall()CommandTheme.doc_purposeCommandTheme.doc_usageCommandTheme.get_json()CommandTheme.get_path()CommandTheme.jsonCommandTheme.list_available()CommandTheme.list_installed()CommandTheme.nameCommandTheme.new_theme()CommandTheme.output_dir
- 1.1.1.2.1.1.18. nikola.plugins.command.version module
- 1.1.1.2.1.2. nikola.plugins.compile package
- 1.1.1.2.1.2.1. Subpackages
- 1.1.1.2.1.2.1.1. nikola.plugins.compile.markdown package
- 1.1.1.2.1.2.1.2. nikola.plugins.compile.rest package
CompileRestNikolaReaderRemoveDocinfoadd_node()get_observer()rst2html()shortcode_role()visit_literal()- 1.1.1.2.1.2.1.2.1. Submodules
- 1.1.1.2.1.2.1.2.2. nikola.plugins.compile.rest.chart module
- 1.1.1.2.1.2.1.2.3. nikola.plugins.compile.rest.doc module
- 1.1.1.2.1.2.1.2.4. nikola.plugins.compile.rest.gist module
- 1.1.1.2.1.2.1.2.5. nikola.plugins.compile.rest.listing module
- 1.1.1.2.1.2.1.2.6. nikola.plugins.compile.rest.media module
- 1.1.1.2.1.2.1.2.7. nikola.plugins.compile.rest.post_list module
- 1.1.1.2.1.2.1.2.8. nikola.plugins.compile.rest.soundcloud module
- 1.1.1.2.1.2.1.2.9. nikola.plugins.compile.rest.thumbnail module
- 1.1.1.2.1.2.1.2.10. nikola.plugins.compile.rest.vimeo module
- 1.1.1.2.1.2.1.2.11. nikola.plugins.compile.rest.youtube module
- 1.1.1.2.1.2.2. Submodules
- 1.1.1.2.1.2.3. nikola.plugins.compile.html module
- 1.1.1.2.1.2.4. nikola.plugins.compile.ipynb module
- 1.1.1.2.1.2.5. nikola.plugins.compile.pandoc module
- 1.1.1.2.1.2.6. nikola.plugins.compile.php module
- 1.1.1.2.1.2.1. Subpackages
- 1.1.1.2.1.3. nikola.plugins.misc package
- 1.1.1.2.1.4. nikola.plugins.task package
- 1.1.1.2.1.4.1. Submodules
- 1.1.1.2.1.4.2. nikola.plugins.task.archive module
ArchiveArchive.add_other_languages_variableArchive.always_disable_atomArchive.always_disable_rssArchive.apply_to_pagesArchive.apply_to_postsArchive.classification_nameArchive.classify()Archive.extract_hierarchy()Archive.get_classification_friendly_name()Archive.get_implicit_classifications()Archive.get_other_language_variants()Archive.get_path()Archive.has_hierarchyArchive.include_posts_from_subhierarchiesArchive.include_posts_into_hierarchy_rootArchive.minimum_post_count_per_classification_in_overviewArchive.more_than_one_classifications_per_postArchive.nameArchive.omit_empty_classificationsArchive.overview_page_variable_nameArchive.path_handler_docstringsArchive.postprocess_posts_per_classification()Archive.provide_context_and_uptodate()Archive.recombine_classification_from_hierarchy()Archive.set_site()Archive.should_generate_classification_page()Archive.sort_classifications()Archive.subcategories_list_templateArchive.template_for_classification_overview
- 1.1.1.2.1.4.3. nikola.plugins.task.authors module
ClassifyAuthorsClassifyAuthors.add_other_languages_variableClassifyAuthors.apply_to_pagesClassifyAuthors.apply_to_postsClassifyAuthors.classification_nameClassifyAuthors.classify()ClassifyAuthors.get_classification_friendly_name()ClassifyAuthors.get_other_language_variants()ClassifyAuthors.get_overview_path()ClassifyAuthors.get_path()ClassifyAuthors.has_hierarchyClassifyAuthors.is_enabled()ClassifyAuthors.minimum_post_count_per_classification_in_overviewClassifyAuthors.more_than_one_classifications_per_postClassifyAuthors.nameClassifyAuthors.omit_empty_classificationsClassifyAuthors.overview_page_variable_nameClassifyAuthors.path_handler_docstringsClassifyAuthors.postprocess_posts_per_classification()ClassifyAuthors.provide_context_and_uptodate()ClassifyAuthors.provide_overview_context_and_uptodate()ClassifyAuthors.set_site()ClassifyAuthors.template_for_classification_overview
- 1.1.1.2.1.4.4. nikola.plugins.task.bundles module
- 1.1.1.2.1.4.5. nikola.plugins.task.categories module
ClassifyCategoriesClassifyCategories.add_other_languages_variableClassifyCategories.always_disable_atomClassifyCategories.always_disable_rssClassifyCategories.apply_to_pagesClassifyCategories.apply_to_postsClassifyCategories.classification_nameClassifyCategories.classify()ClassifyCategories.extract_hierarchy()ClassifyCategories.get_classification_friendly_name()ClassifyCategories.get_other_language_variants()ClassifyCategories.get_overview_path()ClassifyCategories.get_path()ClassifyCategories.has_hierarchyClassifyCategories.include_posts_from_subhierarchiesClassifyCategories.include_posts_into_hierarchy_rootClassifyCategories.is_enabled()ClassifyCategories.minimum_post_count_per_classification_in_overviewClassifyCategories.more_than_one_classifications_per_postClassifyCategories.nameClassifyCategories.omit_empty_classificationsClassifyCategories.overview_page_hierarchy_variable_nameClassifyCategories.overview_page_items_variable_nameClassifyCategories.overview_page_variable_nameClassifyCategories.path_handler_docstringsClassifyCategories.postprocess_posts_per_classification()ClassifyCategories.provide_context_and_uptodate()ClassifyCategories.provide_overview_context_and_uptodate()ClassifyCategories.recombine_classification_from_hierarchy()ClassifyCategories.set_site()ClassifyCategories.should_generate_atom_for_classification_page()ClassifyCategories.should_generate_classification_page()ClassifyCategories.should_generate_rss_for_classification_page()ClassifyCategories.show_list_as_subcategories_listClassifyCategories.slugify_category_name()ClassifyCategories.slugify_tag_name()ClassifyCategories.template_for_classification_overview
- 1.1.1.2.1.4.6. nikola.plugins.task.copy_assets module
- 1.1.1.2.1.4.7. nikola.plugins.task.copy_files module
- 1.1.1.2.1.4.8. nikola.plugins.task.galleries module
GalleriesGalleries.create_galleries()Galleries.create_galleries_paths()Galleries.create_target_images()Galleries.datesGalleries.find_galleries()Galleries.find_metadata()Galleries.gallery_global_path()Galleries.gallery_path()Galleries.gallery_rss()Galleries.gallery_rss_path()Galleries.gen_tasks()Galleries.get_excluded_images()Galleries.get_image_list()Galleries.nameGalleries.parse_index()Galleries.remove_excluded_image()Galleries.render_gallery_index()Galleries.set_site()
- 1.1.1.2.1.4.9. nikola.plugins.task.gzip module
- 1.1.1.2.1.4.10. nikola.plugins.task.indexes module
IndexesIndexes.apply_to_pagesIndexes.apply_to_postsIndexes.classification_nameIndexes.classify()Indexes.get_classification_friendly_name()Indexes.get_implicit_classifications()Indexes.get_path()Indexes.has_hierarchyIndexes.more_than_one_classifications_per_postIndexes.nameIndexes.omit_empty_classificationsIndexes.overview_page_variable_nameIndexes.path_handler_docstringsIndexes.provide_context_and_uptodate()Indexes.set_site()Indexes.should_generate_atom_for_classification_page()Indexes.should_generate_classification_page()Indexes.should_generate_rss_for_classification_page()Indexes.show_list_as_indexIndexes.template_for_classification_overviewIndexes.template_for_single_list
- 1.1.1.2.1.4.11. nikola.plugins.task.listings module
- 1.1.1.2.1.4.12. nikola.plugins.task.page_index module
PageIndexPageIndex.always_disable_atomPageIndex.always_disable_rssPageIndex.apply_to_pagesPageIndex.apply_to_postsPageIndex.classification_namePageIndex.classify()PageIndex.extract_hierarchy()PageIndex.get_classification_friendly_name()PageIndex.get_path()PageIndex.has_hierarchyPageIndex.include_posts_from_subhierarchiesPageIndex.is_enabled()PageIndex.more_than_one_classifications_per_postPageIndex.namePageIndex.omit_empty_classificationsPageIndex.overview_page_variable_namePageIndex.path_handler_docstringsPageIndex.provide_context_and_uptodate()PageIndex.recombine_classification_from_hierarchy()PageIndex.should_generate_classification_page()PageIndex.show_list_as_indexPageIndex.template_for_classification_overviewPageIndex.template_for_single_list
- 1.1.1.2.1.4.13. nikola.plugins.task.pages module
- 1.1.1.2.1.4.14. nikola.plugins.task.posts module
- 1.1.1.2.1.4.15. nikola.plugins.task.redirect module
- 1.1.1.2.1.4.16. nikola.plugins.task.robots module
- 1.1.1.2.1.4.17. nikola.plugins.task.scale_images module
- 1.1.1.2.1.4.18. nikola.plugins.task.sitemap module
- 1.1.1.2.1.4.19. nikola.plugins.task.sources module
- 1.1.1.2.1.4.20. nikola.plugins.task.tags module
ClassifyTagsClassifyTags.add_other_languages_variableClassifyTags.always_disable_atomClassifyTags.always_disable_rssClassifyTags.apply_to_pagesClassifyTags.apply_to_postsClassifyTags.classification_nameClassifyTags.classify()ClassifyTags.get_classification_friendly_name()ClassifyTags.get_other_language_variants()ClassifyTags.get_overview_path()ClassifyTags.get_path()ClassifyTags.has_hierarchyClassifyTags.is_enabled()ClassifyTags.more_than_one_classifications_per_postClassifyTags.nameClassifyTags.omit_empty_classificationsClassifyTags.overview_page_items_variable_nameClassifyTags.overview_page_variable_nameClassifyTags.path_handler_docstringsClassifyTags.postprocess_posts_per_classification()ClassifyTags.provide_context_and_uptodate()ClassifyTags.provide_overview_context_and_uptodate()ClassifyTags.set_site()ClassifyTags.show_list_as_subcategories_listClassifyTags.slugify_tag_name()ClassifyTags.template_for_classification_overview
- 1.1.1.2.1.4.21. nikola.plugins.task.taxonomies module
- 1.1.1.2.1.5. nikola.plugins.template package
- 1.1.1.2.1.5.1. Submodules
- 1.1.1.2.1.5.2. nikola.plugins.template.jinja module
JinjaTemplatesJinjaTemplates.create_lookup()JinjaTemplates.dependency_cacheJinjaTemplates.get_deps()JinjaTemplates.get_string_deps()JinjaTemplates.get_template_path()JinjaTemplates.inject_directory()JinjaTemplates.lookupJinjaTemplates.nameJinjaTemplates.per_file_cacheJinjaTemplates.render_template()JinjaTemplates.render_template_to_string()JinjaTemplates.set_directories()JinjaTemplates.set_site()JinjaTemplates.template_deps()
- 1.1.1.2.1.5.3. nikola.plugins.template.mako module
MakoTemplatesMakoTemplates.cacheMakoTemplates.cache_dirMakoTemplates.create_lookup()MakoTemplates.directoriesMakoTemplates.filtersMakoTemplates.get_deps()MakoTemplates.get_string_deps()MakoTemplates.get_template_path()MakoTemplates.inject_directory()MakoTemplates.lookupMakoTemplates.nameMakoTemplates.render_template()MakoTemplates.render_template_to_string()MakoTemplates.set_directories()MakoTemplates.set_site()MakoTemplates.template_deps()
striphtml()
1.1.1.2.2. Submodules¶
1.1.1.2.3. nikola.plugins.basic_import module¶
Mixin for importer plugins.
- class nikola.plugins.basic_import.ImportMixin¶
Bases:
objectMixin with common used methods.
- cmd_options = [{'name': 'output_folder', 'long': 'output-folder', 'short': 'o', 'default': 'new_site', 'help': 'Location to write imported content.'}]¶
- static configure_redirections(url_map, base_dir='')¶
Configure redirections from an url_map.
- doc_purpose = 'import a dump from a different engine.'¶
- doc_usage = '[options] export_file'¶
- generate_base_site()¶
Generate a base Nikola site.
- classmethod get_channel_from_file(filename)¶
Get channel from XML file.
- get_configuration_output_path()¶
Get path for the output configuration file.
- name = 'import_mixin'¶
- needs_config = False¶
- static populate_context(channel)¶
Populate context with settings.
- classmethod transform_content(content)¶
Transform content to a Nikola-friendly format.
- static write_configuration(filename, rendered_template)¶
Write the configuration file.
- classmethod write_content(filename, content, rewrite_html=True)¶
Write content to file.
- write_metadata(filename, title, slug, post_date, description, tags, **kwargs)¶
Write metadata to meta file.
- classmethod write_post(filename, content, headers, compiler, rewrite_html=True)¶
Ask the specified compiler to write the post to disk.
- static write_urlmap_csv(output_file, url_map)¶
Write urlmap to csv file.
- nikola.plugins.basic_import.replacer(dst)¶
Replace links.