logo

org filter

← Back to Filter List

org


Convert .org files to other formats.

Aliases for this filter

  • org

Converts from file formats:

  • .org
  • .txt

To file formats:

  • .txt
  • .html
  • .tex
  • .pdf
  • .odt

Available settings:

SettingDescriptionDefault
add-new-filesBoolean or list of extensions/patterns to match.False
added-in-versionDexy version when this filter was first available.
additional-doc-filtersFilters to apply to additional documents created as side effects.{}
additional-doc-settingsSettings to apply to additional documents created as side effects.{}
argsArguments to be passed to the executable.
check-return-codeWhether to look for nonzero return code.True
clargsArguments to be passed to the executable (same as 'args').
command-stringThe full command string.%(prog)s --batch %(args)s --eval "(progn \ (find-file \"%(script_file)s\") \ (%(export_command)s 1) \ (kill-buffer) \ )"
data-typeAlias of custom data class to use to store filter output.generic
envDictionary of key-value pairs to be added to environment for runs.{}
examplesTemplates which should be used as examples for this filter.[]
exclude-add-new-filesList of patterns to skip even if they match add-new-files.[]
exclude-new-files-from-dirList of directories to skip when adding new files.[]
executableThe executable to be runemacs
extFile extension to output.None
extension-mapDictionary mapping input extensions to default output extensions.None
helpHelpstring for plugin.Convert .org files to other formats.
initial-timeout10
input-extensionsList of extensions which this filter can accept as input.['.org', '.txt']
keep-originalsWhether, if additional-doc-filters are specified, the original unmodified docs should also be added.False
make-dummy-outputWhether to make a dummy output file when one is not generated and add-new-files is True.False
mkdirA directory which should be created in working dir.None
mkdirsA list of directories which should be created in working dir.[]
nodocWhether filter should be excluded from documentation.False
outputWhether to output results of this filter by default by reporters such as 'output' or 'website'.True
output-extensionsList of extensions which this filter can produce as output.['.txt', '.html', '.tex', '.pdf', '.odt']
override-workspace-exclude-filtersIf True, document will be populated to other workspaces ignoring workspace-exclude-filters.False
path-extensionsstrings to extend path with[]
preserve-prior-data-classWhether output data class should be set to match the input data class.False
record-varsWhether to add code that will automatically record values of variables.False
require-outputShould dexy raise an exception if no output is produced by this filter?True
scriptargsArguments to be passed to the executable.
tagsTags which describe the filter.[]
timeout10
use-wdWhether to use a custom working directory when running filter.True
variablesA dictionary of variable names and values to make available to this filter.{}
varsA dictionary of variable names and values to make available to this filter.{}
version-commandCommand to call to return version of installed software.None
windows-version-commandCommand to call on windows to return version of installed software.None
workspace-exclude-filtersFilters whose output should be excluded from workspace.['pyg']
workspace-includesIf set to a list of filenames or extensions, only these will be populated to working dir.None
write-stderr-to-stdoutShould stderr be piped to stdout?True
Filter Source Code
class OrgModeFilter(SubprocessFilter):
    """
    Convert .org files to other formats.
    """
    aliases = ['org']
    _settings = {
            'executable' : 'emacs',
            'output' : True,
            'input-extensions' : ['.org', '.txt'],
            'output-extensions' : ['.txt', '.html', '.tex', '.pdf', '.odt'],
            'command-string' : """%(prog)s --batch %(args)s --eval "(progn \\
(find-file \\"%(script_file)s\\") \\
(%(export_command)s 1) \\
(kill-buffer) \\
)"
"""
            }

    def command_string_args(self):
        if self.ext == '.txt':
            export_command = "org-export-as-ascii"
        elif self.ext == '.html':
            export_command = "org-export-as-html"
        elif self.ext == '.tex':
            export_command = "org-export-as-latex"
        elif self.ext == '.pdf':
            export_command = "org-export-as-pdf"
        elif self.ext == '.odt':
            export_command = "org-export-as-odt"
        else:
            msg = "unsupported extension %s"
            msgargs = (self.ext)
            raise dexy.exceptions.InternalDexyProblem(msg % msgargs)

        args = self.default_command_string_args()
        args['export_command'] = export_command
        return args

Content © 2020 Dr. Ana Nelson | Site Design © Copyright 2011 Andre Gagnon | All Rights Reserved.