lyx_mirror/lib/layouts/pdfcomment.module.uwe

#\DeclareLyXModule{PDF Comments}
#DescriptionBegin
#Provides various kinds of annotations for the PDF output. The module uses
#the pdcomment package. Please consult the package documentation for details.
#DescriptionEnd
# Author: Juergen Spitzmueller <spitz@lyx.org> and Uwe Stöhr

Format 49

AddToPreamble
	\RequirePackage{pdfcomment}	%support for comments in PDF files
EndPreamble

#
# helper commands
#

Style Define_Avatar
	Category		PDF-comment
	LatexType		Command
	Margin			Dynamic
	LatexName		defineavatar
	ParSkip			0.4
	LabelType		Static
	LabelSep		M
	LabelString		"PDF-comment avatar:"
	Argument 1
		LabelString	"Name"
		Tooltip		"Name of the Avatar"
		Mandatory	1
	EndArgument
	PassThru		1
	LabelFont
	  Color			green
	  Shape			bold
	EndFont
	Requires		pdfcomment
End

Style Define_PDF-Comment_Style
	CopyStyle		Define_Avatar
	LatexName		definestyle
	LabelString		"PDF-comment style:"
	Argument 1
		LabelString	"Name"
		Tooltip		"Name of the style"
		Mandatory	1
	EndArgument
End

Style Define_PDF-Comment_List_Style
	CopyStyle		Define_Avatar
	LatexName		defineliststyle
	LabelString		"Definition of PDF-comment list style:"
	Argument 1
		LabelString	"Name"
		Tooltip		"Name of the list style"
		Mandatory	1
	EndArgument
End

Style Set_PDF-Comment_List_Style
	CopyStyle		Define_Avatar
	LatexName		setliststyle
	LabelString		"PDF-comment list style:"
	ResetArgs		1
End

#
# Comment insets
#

InsetLayout "Flex:PDF-Annotation"
	LyXType               custom
	LatexType             command
	Decoration            classic
	LabelString           "PDF (Annotation)"
	LatexName             pdfcomment
	LabelFont
	  Color               magenta
	  Size                Small
	EndFont
	MultiPar              false
	Argument 1
	  MenuString          "PDF-Annotation options"
	  LabelString         "Opts"
	  ToolTip             "Insert PDF-Annotation options here (see the pdfcomment manual)"
	EndArgument
	Requires              pdfcomment
End

InsetLayout "Flex:PDF-Comment-Setup"
	CopyStyle             "Flex:PDF-Annotation"
	LabelString           "PDF (Setup)"
	LatexName             pdfcommentsetup
	Argument 1
	  MenuString          "PDF-Comment setup options"
	  LabelString         "Opts"
	  ToolTip             "Insert PDF-Comment setup options here (see the pdfcomment manual)"
	EndArgument
End

InsetLayout "Flex:PDF-Margin"
	CopyStyle             "Flex:PDF-Annotation"
	LabelString           "PDF (Margin)"
	LatexName             pdfmargincomment
	Argument 1
	  MenuString          "PDF-Margin options"
	  LabelString         "Opts"
	  ToolTip             "Insert PDF-Margin options here (see the pdfcomment manual)"
	EndArgument
	LabelFont
	  Color               green
	  Size                Small
	EndFont
End

InsetLayout "Flex:PDF-Markup"
	CopyStyle             "Flex:PDF-Margin"
	LabelString           "PDF (Markup)"
	LatexName             pdfmarkupcomment
	Argument post:1
	  LabelString         "Comment"
	  Mandatory           1
	  ToolTip             "Insert the comment to the marked-up text here"
	EndArgument
End

InsetLayout "Flex:PDF-Freetext"
	CopyStyle             "Flex:PDF-Margin"
	LabelString           "PDF (Freetext)"
	LatexName             pdffreetextcomment
	Argument 1
	  MenuString          "PDF-Freetext options"
	  LabelString         "Opts"
	  ToolTip             "Insert PDF-Freetext options here (see the pdfcomment manual)"
	EndArgument
End

InsetLayout "Flex:PDF-Square"
	CopyStyle             "Flex:PDF-Margin"
	LabelString           "PDF (Square)"
	LatexName             pdfsquarecomment
	Argument 1
	  MenuString          "PDF-Square options"
	  LabelString         "Opts"
	  ToolTip             "Insert PDF-Square options here (see the pdfcomment manual)"
	EndArgument
End

InsetLayout "Flex:PDF-Circle"
	CopyStyle             "Flex:PDF-Margin"
	LabelString           "PDF (Circle)"
	LatexName             pdfcirclecomment
	Argument 1
	  MenuString          "PDF-Circle options"
	  LabelString         "Opts"
	  ToolTip             "Insert PDF-Circle options here (see the pdfcomment manual)"
	EndArgument
End

InsetLayout "Flex:PDF-Line"
	CopyStyle             "Flex:PDF-Margin"
	LabelString           "PDF (Line)"
	LatexName             pdflinecomment
	Argument 1
	  MenuString          "PDF-Line options"
	  LabelString         "Opts"
	  ToolTip             "Insert PDF-Line options here (see the pdfcomment manual)"
	EndArgument
End

InsetLayout "Flex:PDF-Reply"
	CopyStyle             "Flex:PDF-Margin"
	LabelString           "PDF (Reply)"
	LatexName             pdfreply
	Argument 1
	  MenuString          "PDF-Reply options"
	  LabelString         "Opts"
	  ToolTip             "Insert PDF-Reply options here (see the pdfcomment manual)"
	EndArgument
	LabelFont
	  Color               blue
	  Size                Small
	EndFont
End

InsetLayout "Flex:PDF-Tooltip"
	CopyStyle             "Flex:PDF-Markup"
	LabelString           "PDF (Tooltip)"
	LatexName             pdftooltip
	LabelFont
	  Color               red
	  Size                Small
	EndFont
	Argument 1
	  MenuString          "PDF-Tooltip options"
	  LabelString         "Opts"
	  ToolTip             "Insert PDF-Tooltip options here (see the pdfcomment manual)"
	EndArgument
	Argument post:1
	  MenuString          "Tooltip Text"
	  LabelString         "Tooltip"
	  Mandatory           1
	  ToolTip             "Insert the tooltip text here"
	EndArgument
End

#
# Environment inset
#

InsetLayout "Flex:PDF-Sideline"
	CopyStyle             "Flex:PDF-Margin"
	LabelString           "PDF (Sideline)"
	LatexType             environment
	LatexName             pdfsidelinecomment
	MultiPar              true
	Argument 1
	  MenuString          "PDF-Sideline options"
	  LabelString         "Opts"
	  ToolTip             "Insert PDF-Sideline options here (see the pdfcomment manual)"
	EndArgument
	Argument 2
	  LabelString         "Comment"
	  Mandatory           1
	  ToolTip             "Insert the comment here"
	EndArgument
End

#
# List of Annotations
#

Style List_of_PDF-Comments
	KeepEmpty	1
	Category	PDF-comment
	LatexType	Command
	LatexName	listofpdfcomments
	Margin		First_Dynamic
	NextNoIndent	1
	ParSkip		0
	TopSep		0
	BottomSep	0.25
	ParSep		0
	Align		Center
	LabelType	Static
	LabelBottomSep	0
	LeftMargin	MMMMM
	LabelString	"List of PDF-comments"
	LabelFont 
	    Family	sansserif
	    Series	Medium
	    Size	large
	    Color	latex
	    Shape	bold
	EndFont
	Argument 1
		LabelString	"Opts"
		MenuString	"List Options|s"
		Tooltip		"Insert list options here (see pdfcomment manual)"
	EndArgument
	PassThru	1
	Requires              pdfcomment
End