Input

book: Create a structured PDF document with headings, chapters, etc.
webpage: Specifies that the HTML sources are unstructured (plain web pages.) A page break is inserted between each file or URL in the output.
continuous: Specifies that the HTML sources are unstructured (plain web pages.) No page breaks are inserted between each file or URL in the output.
Title of the document for the front page.
Extract the first heading of the document and use it as title. If checked the title field has no effect.
The title image or HTML page. These file has to be an attachments!
Specify document version to be displayed on the title page.
Intellectual property owner of this document.
Copyright notice for this document.
Information about who and when modified the document are applied at the end.

Output

Specifies the output format.
Grayscale document  Title page
Compression :   JPEG big images 

Pagina

 
User defined page size 
Choose one of the predefined standard sizes or select user defined.
Specifies the page size using a standard name or in points (no suffix or ##x##pt), inches (##x##in), centimeters (##x##cm), or millimeters (##x##mm).
Set the target browser width in pixels (400-1200). This determines the page scaling of images.
   2-Sided   Landscape
   
   
   
Specifies the margin size using points (no suffix or ##x##pt), inches (##x##in), centimeters (##x##cm), or millimeters (##x##mm). Keep empty for default value.
Left
Middle
Right
Sets the page header to use on body pages.
Left
Middle
Right
Sets the page footer to use on body pages.

Indice

Sets the number of levels in the table-of-contents. Empty for unlimited levels.
   Numbered headings Check to number all of the headings in the document.
Sets the title for the table-of-contents. Empty for default title.
Left
Middle
Right
Sets the page header to use on table-of-contents pages.
Left
Middle
Right
Sets the page footer to use on table-of-contents pages.

Colors

Enter the HTML color for the body (background).
Enter the image file for the body (background). These file has to be an attachments!
Enter the HTML color for the text.
Sets the color of links.
Enables generation of links in PDF files.

Fonts

Set the default size of text.
Set the spacing between lines of text.
Choose the default typeface (font) of text.
Choose the default typeface (font) of headings.
Set the size of header and footer text.
Choose the font for header and footer text.
Change the encoding of the text in document.
Check to embed font in the output file.

PDF

Controls the initial viewing mode for the document.
Document: Displays only the docuemnt pages.
Outline: Display the table-of-contents outline as well as the document pages.
Full-screen: Displays pages on the whole screen; this mode is used primarily for presentations.
Controls the initial layout of document pages on the screen.
Single: Displays a single page at a time.
One column: Displays a single column of pages at a time.
Two column left/right: Display two columns of pages at a time; the first page is displayed in the left or right column as selected.
Choose the initial page that will be shown.

Security

Check to number all of the headings in the document.
 Versione stampabile   Modify
 Copy   Annotate
Specifies the document permissions.
Specifies the user password to restrict viewing permissions on this PDF document. Empty for no encryption.
Specifies the owner password to control who can change document permissions etc. If this field is left blank, a random 32-character password is generated so that no one can change the document.

Expert

Specify language to use for date and time format.
Shrink code blocks on page.
Show line numbers for code blocks.
Make spaces visable by dots (·) instead of white spaces.
Make line breaks visable by a extra character (¶) at the end.
Enable this feature if you searching for problems or intent to report a bug report

About

Version 2.4.2 (MoinMoin 1.9.7)


MoinMoin - Generate PDF document using HTMLDOC

This action script generate PDF documents from a Wiki site using
the HTMLDOC (http://www.htmldoc.org) software packages which has
to be preinstalled first.

Copy this script in your's MoinMoin action script plugin directory.

Thanks goes to Pascal Bauermeister who initiated the implementaion.
Lot of things changes since then but the idear using HTMLDOC is the
main concept of this implementation.

Please visit the homepage for further informations:
http://moinmo.in/ActionMarket/PdfAction

@copyright: (C) 2006 Pascal Bauermeister
@copyright: (C) 2006-2010 Raphael Bossek <raphael.bossek@solutions4linux.de>
@license: GNU GPL, see COPYING for details

       

Italiano English
Locked History Actions

HelpOnMacros



Macros

Macros allow the insertion of system features into normal wiki pages; the only thing that makes those pages special is that they contain macros. If you edit pages like RecentChanges or SystemInfo, you'll see what that means.

For more information on the possible markup, see HelpOnEditing.

Search macros

MoinMoin now uses a new search engine, that lets your make sophisticated searches using both the interactive search box or any of the search macros. For more help, see HelpOnSearching.

Macro


Description

Example

<<AdvancedSearch>>


create an advanced search dialogue on the page

See FindPage

<<TitleSearch>>


create a search box on the page, which search the page titles

See FindPage

<<FullSearch>>


create a search box on the page, which search the page contents

See FindPage

<<FullSearch()>>


print a list of pages whose content matches the current page title (like clicking on the page title)

See the CategoryCategory page

<<FullSearch(text)>>


print a list of pages whose content matches the search term

<<FullSearchCached(text)>>


Works like the FullSearch macro but caches the results statically. Use it if you prefer speed over an up-to-date result

<<GoTo>>


directly go to the page you enter

See the FindPage

<<PageList(Help)>>


print a list of pages whose title matches the search term

See the HelpIndex

Macro


Description

Example

<<RecentChanges>>


a list of recently edited pages

See RecentChanges

<<TitleIndex>>


an index of all page titles

See TitleIndex

<<WordIndex>>


an index of all words in page titles

See WordIndex

<<WantedPages>>


list links to non-existent pages

See WantedPages

<<OrphanedPages>>


list pages no other page links to

See OrphanedPages

<<AbandonedPages>>


list pages that were not edited for the longest time

See AbandonedPages

<<RandomPage>>


a link to a random page

<<RandomPage>>

<<RandomPage(#)>>


links to a number of random pages

Two random pages: <<RandomPage(2)>>

<<TableOfContents([maxdepth])>>


display a local table of contents, possibly limited to a maximal depth

See above

<<Anchor(anchorname)>>


macro to insert anchors into a page

#here

<<Navigation(children[,maxdepth])>>


macro to list all of a pages' children

See start of this page

<<Navigation(siblings[,maxdepth])>>


quick navigation to siblings of a page

See /MailTo

<<Navigation(slideshow)>>


creates a link to toggle between slide show and wiki mode, and a link to start the slide show

See HelpOnSlideShows

<<Navigation(slides)>>


displays first/prev/next/last links

See HelpOnSlideShows

<<AttachInfo>>


displays number of attachments for current page

See HelpOnActions/AttachFile

<<AttachInfo(page)>>


displays number of attachments for page

See HelpOnActions/AttachFile

<<AttachList(pagename,mimetype)>>


displays list of attachments

See HelpOnActions/AttachFile

System information

Macro


Description

Example

<<InterWiki>>


a list of all known InterWiki names

InterWiki

<<SystemInfo>>


info on the wiki, the python interpreter and the host system

SystemInfo

<<PageCount(exists)>>


current page count. If exists is supplied as an argument, only existing pages will be shown.

<<PageCount>> pages

<<PageSize>>


list the sizes of all pages

See PageSize

<<StatsChart(type)>>


shows statistical charts (currently defined types: hitcounts, pagesize, useragents, languages)

See EventStats and subpages

<<SystemAdmin>>


Information for system administrators

You need to be superuser to call this macro

<<EditedSystemPages>>


A list of system pages that were modified

<<EditedSystemPages>>

Others

Macro


Description

Example

<<Action(action [,text])>>


links to page with valid action, optional text could be used as alias. (action names are case sensitive)

e.g. <<Action(print, Print this page)>>, Print this page

<<Icon(image)>>


display system icons

See HelpOnNavigation

<<UserPreferences>>


display a user preferences dialog

See UserPreferences

<<UserPreferences(createonly)>>


display user creation dialog

<<BR>>


insert a line break

1st line
2nd line

<<RandomQuote(pagename)>>


Select a random quote from the given page, or from FortuneCookies if omitted

<<RandomQuote>>

<<Include(HelloWorld[,"heading"[,level]])>>


include contents of another page

for details see /Include

<<FootNote(text)>>


Add a footnote1, or explicitly display collected footnotes when no args are given

See below for an example.

<<Date(timestamp)>>


display a timestamp according to system settings

2024-05-14

<<DateTime(timestamp)>>


display a timestamp2 according to user settings

2024-05-14 02:32:15

<<GetText(text)>>


loads I18N texts (mainly intended for use on Help pages)

"EditText" is translated to "EditText"

<<GetText2(,message,argument1,argument2,...)>>


loads I18N texts (mainly intended for use on Help pages or in generated output on wiki pages) and replaces %s in the message by the arguments. The first character of the argument is used as the separator (in this example: a comma). You can escape the separator by using a backslash.

"<<GetText2(,[You may not read %s],FooBar)>>" yields "[Potresti non aver letto FooBar]"

<<TeudView>>


useful for intranet developer wikis, a means to view pydoc documentation, formatted via a XSLT stylesheet

See http://twistedmatrix.com/wiki/python/TeudProject

<<MailTo(email)>>


protect your email address from spam bots

for details see /MailTo

<<NewPage(PageTemplate,ButtonLabel,[ParentPage,@ME,@SELF] [,NameTemplate])>>


Allow the user to create (sub-) pages easily, using the page PageTemplateas the template for the new page and the string NameTemplate as a template for the name.3 @ME is used if you want the page created below the users homepage. @SELF is used to create a subpage below the page where it is called from.

<<GetVal(NeatSnippets,regards)>>


Retrieve dictionary entries from dict pages.

If you have a page called GermanDict which contains the entry Test, you should see the translation here:

<<MonthCalendar(,,12)>>


Displays a Calendar and creates link for entries to each day on subpages

See /MonthCalendar

  1. the text cannot contain any wiki markup (1)

  2. "timestamp" can be empty (current time), a number of seconds since 1970 (unix timestamp), or a W3C time specification ("2002-01-23T12:34:56"). See RFC822, sect. 5. (2)

  3. NameTemplate is formatted with time.strftime(), with the exception of %s which is replaced by the input into the edit box (which is only shown if necessary). If NameTemplate is not specified or empty, it defaults to %s. (3)

Writing your own macro

Create a python file called MacroName.py located in your data/plugin/macro directory. Ensure it has a single method called execute(macro, arguments), which is the entry-point.

  • macro is an instance of class Macro, and also evaluates to a string of the macroname.

  • arguments is an arbitrary argument string you can pass in with parameters to your macro.

All Macro instances have a request member through which you can access the form parameters and other information related to user interaction.

execute() should use the formatter to construct valid markup for the current target format. In most cases this is HTML, so writing a macro which returns HTML will work in most cases but fail when formats like XML or text/plain are requested.

For example, your wiki page has the following line on it:

<<MacroName(arg1,arg2,arg3)>>

You could write a MacroName.py file like this:

   1 Dependencies = []
   2 def execute(macro, args):
   3     return macro.formatter.text("I got these args from a macro %s: %s" %
   4     (str(macro), args))
  • /!\ Add an entry into Dependencies if the output from your macro should not be cached. This is important if the macro output could change from one moment to another, for example if your macro searches in wiki pages which may be being edited by other users, or loads information from an external database whose contents may change. Currently the value of any entry does not matter and may be considered a short description for 'why results from this macro should not be cached', but please look at the entries used in other macros for values which may be suitable.