scalos/main/docs/Filetypes.guide

   1 @database "FileTypes.guide"
   2 @width 77
   3 @height 24
   4 @smartwrap
   5 @version $VER: FileTypes.guide 1.0 (01.10.04) ©2000-2005 The Scalos Team
   6
   7 ----------------------------------------------------------------------------
   8 @node main "FileTypes.guide"
   9
  10
  11 @{" DESCRIPTION " Link Description      }       NAME/A
  12
  13
  14 @{" INCLUDE " Link Include              }       NAME/A
  15
  16
  17 @{" POPUPMENU " Link PopupMenu          }       n/a
  18
  19 @{" ENDPOPUPMENU " Link EndPopupMenu    }       n/a
  20
  21
  22 @{" TOOLTIP " Link ToolTip              }       n/a
  23
  24 @{" ENDTOOLTIP " Link EndToolTip        }       n/a
  25
  26
  27 @{" Examples and additionnals informations " link "Tooltip definition/main" }
  28
  29 @endnode
  30 ----------------------------------------------------------------------------
  31 @node Description "DESCRIPTION"
  32
  33 @{b}
  34 DESCRIPTION     NAME/A@{ub}
  35
  36
  37 NAME
  38 @{LINDENT 8}
  39         This is the title that is displayed in the top line of any popup menu.
  40 @{LINDENT 0}
  41
  42 @endnode
  43 ----------------------------------------------------------------------------
  44 @node Include "INCLUDE"
  45
  46 @{b}
  47 INCLUDE         NAME/A@{ub}
  48
  49
  50 NAME
  51 @{LINDENT 8}
  52         Name of file to be included. Path can be relative to "Scalos:FileTypes".
  53 @{LINDENT 0}
  54 @endnode
  55 ----------------------------------------------------------------------------
  56 @node PopupMenu "POPUPMENU"
  57
  58 @{b}
  59 POPUPMENU@{ub}
  60
  61
  62 Starts the popup menu description section for this filetype.
  63
  64
  65 The following Subcommands are allowed inside popup menus:
  66 @{LINDENT 8}
  67
  68 @{" SUBMENU " Link SubMenu              }       "NAME/A"
  69
  70 @{" ENDSUBMENU " Link EndSubMenu        }
  71
  72
  73 @{" MENUENTRY " Link MenuEntry          }       "NAME/A,KEY/K,DEFAULTACTION/S"
  74
  75 @{" ENDMENUENTRY " Link EndMenuEntry    }
  76
  77
  78 @{" INTERNALCMD " Link InternalCmd      }       "NAME/A"
  79
  80 @{" WBCMD " Link WbCmd                }         "NAME/A,STACK/K/N,WBARGS/S,PRI=PRIORITY/K/N"
  81
  82 @{" AREXXCMD " Link ARexxCmd            }       "NAME/A,STACK/K/N,WBARGS/S,P=PRIORITY/K/N"
  83
  84 @{" CLICMD " Link CliCmd                }       "NAME/A,STACK/K/N,WBARGS/S,P=PRIORITY/K/N"
  85
  86 @{" ICONWINDOWCMD " Link IconWindowCmd  }       "NAME/A"
  87
  88 @{" PLUGINCMD " Link PluginCmd          }       "NAME/A"
  89
  90
  91 @{" MENUSEPARATOR " Link MenuSeparator  }
  92 @{LINDENT 0}
  93
  94 @endnode
  95 ----------------------------------------------------------------------------
  96 @node EndPopupMenu "ENDPOPUPMENU"
  97
  98 @{b}
  99 ENDPOPUPMENU@{ub}
 100
 101
 102 Ends the popup menu description section for this filetype.
 103
 104 @endnode
 105 ----------------------------------------------------------------------------
 106 @node SubMenu "SUBMENU"
 107
 108 @{b}
 109 SUBMENU         NAME/A@{ub}
 110
 111
 112 Starts a submenu entry inside a popup menu section.
 113
 114
 115 NAME
 116
 117 @endnode
 118 ----------------------------------------------------------------------------
 119 @node EndSubMenu "ENDSUBMENU"
 120
 121 @{b}
 122 ENDSUBMENU@{ub}
 123
 124
 125 Ends a submenu entry inside a popup menu section.
 126
 127 @endnode
 128 ----------------------------------------------------------------------------
 129 @node MenuEntry "MENUENTRY"
 130
 131 @{b}
 132 MENUENTRY       NAME/A,KEY/K,DEFAULTACTION/S@{ub}
 133
 134
 135         NAME
 136
 137         KEY
 138
 139         DEFAULTACTION
 140
 141 @endnode
 142 ----------------------------------------------------------------------------
 143 @node EndMenuEntry "ENDMENUENTRY"
 144
 145 @{b}
 146 ENDMENUENTRY@{ub}
 147
 148 @endnode
 149 ----------------------------------------------------------------------------
 150 @node ToolTip "ToolTip"
 151
 152 @{b}
 153 TOOLTIP@{ub}
 154
 155
 156 Starts the tooltip description section for this filetype.
 157
 158
 159 The following Subcommands are allowed inside popup menus:
 160 @{LINDENT 8}
 161
 162 @{" GROUP " Link Group        }         "ORIENTATION/K"
 163
 164 @{" ENDGROUP " Link EndGroup    }
 165
 166
 167 @{" MEMBER " Link Member        }       "HIDE/K"
 168
 169 @{" ENDMEMBER " Link EndMember  }
 170
 171
 172 @{" HBAR " Link HBar            }
 173
 174
 175 @{" STRING " Link String        }       "ID/K,TEXT/K,SRC/K,TEXTPEN/K,HALIGN/K,STYLE/K,FONT/K,VALIGN/K"
 176
 177
 178 @{" SPACE " Link Space        }         "SIZE/N/A"
 179
 180 @{" DTIMAGE " Link DtImage      }       "FILENAME/A"
 181 @{LINDENT 0}
 182
 183 @endnode
 184 ----------------------------------------------------------------------------
 185 @node EndToolTip "ENDTOOLTIP"
 186
 187 @{b}
 188 ENDTOOLTIP@{ub}
 189
 190
 191 Ends the tooltip description section for this filetype.
 192
 193 @endnode
 194 ----------------------------------------------------------------------------
 195 @node String "STRING"
 196
 197 @{b}
 198 STRING          ID/K,TEXT/K,SRC/K,TEXTPEN/K,HALIGN/K,STYLE/K,FONT/K,VALIGN/K@{ub}
 199
 200
 201 @{" ID " Link StringId}
 202
 203 TEXT
 204
 205 @{" TEXTPEN " Link StringTextPen }
 206
 207 HALIGN
 208
 209         LEFT
 210
 211         CENTER
 212
 213         RIGHT
 214
 215 STYLE
 216
 217         NORMAL
 218
 219         BOLD
 220
 221         ITALIC
 222
 223         BOLDITALIC
 224
 225 FONT    "fontname.font/size"
 226
 227 VALIGN
 228
 229         TOP
 230
 231         CENTER
 232
 233         BOTTOM
 234
 235 @endnode
 236 ----------------------------------------------------------------------------
 237 @node InternalCmd "INTERNALCMD"
 238
 239 @{b}
 240 INTERNALCMD             NAME/A@{ub}
 241
 242
 243 "about"
 244 "backdrop"
 245 "cleanup"
 246 "cleanupbyname"
 247 "cleanupbydate"
 248 "cleanupbysize"
 249 "cleanupbytype"
 250 "clearselection"
 251 "clone"
 252 "close"
 253 "copy"
 254 "cut"
 255 "delete"
 256 "emptytrashcan"
 257 "executecommand"
 258 "formatdisk"
 259 "iconify"
 260 "iconinfo"
 261 "lastmsg"
 262 "leaveout"
 263 "makedir"
 264 "open"
 265 "parent"
 266 "paste"
 267 "putaway"
 268 "quit"
 269 "redraw"
 270 "redrawall"
 271 "rename"
 272 "reset"
 273 "selectall"
 274 "showallfiles"
 275 "showonlyicons"
 276 "shutdown"
 277 "sizetofit"
 278 "snapshot"
 279 "snapshotall"
 280 "snapshotwindow"
 281 "unsnapshot"
 282 "update"
 283 "updateall"
 284 "viewbydate"
 285 "viewbyicon"
 286 "viewbysize"
 287 "viewbytype"
 288 "viewbytext"
 289
 290 @endnode
 291 ----------------------------------------------------------------------------
 292 @node WbCmd "WBCMD"
 293
 294 @{b}
 295 WBCMD           NAME/A,STACK/K/N,WBARGS/S,PRI=PRIORITY/K/N@{ub}
 296
 297
 298         NAME
 299
 300         STACK
 301
 302         WBARGS
 303
 304         PRIORITY
 305
 306 @endnode
 307 ----------------------------------------------------------------------------
 308 @node ARexxCmd "AREXXCMD"
 309
 310 @{b}
 311 AREXXCMD                NAME/A,STACK/K/N,WBARGS/S,P=PRIORITY/K/N@{ub}
 312
 313
 314         NAME
 315
 316         STACK
 317
 318         WBARGS
 319
 320         PRIORITY
 321
 322 @endnode
 323 ----------------------------------------------------------------------------
 324 @node CliCmd "CLICMD"
 325
 326 @{b}
 327 CLICMD                  NAME/A,STACK/K/N,WBARGS/S,P=PRIORITY/K/N@{ub}
 328
 329
 330         NAME
 331
 332         STACK
 333
 334         WBARGS
 335
 336         PRIORITY
 337
 338 @endnode
 339 ----------------------------------------------------------------------------
 340 @node IconWindowCmd "ICONWINDOWCMD"
 341
 342 @{b}
 343 ICONWINDOWCMD           NAME/A@{ub}
 344
 345
 346         NAME
 347
 348 @endnode
 349 ----------------------------------------------------------------------------
 350 @node PluginCmd "PLUGINCMD"
 351
 352 @{b}
 353 PLUGINCMD               NAME/A@{ub}
 354
 355
 356         NAME
 357
 358 @endnode
 359 ----------------------------------------------------------------------------
 360 @node MenuSeparator "MENUSEPARATOR"
 361
 362 @{b}
 363 MENUSEPARATOR@{ub}
 364
 365 @endnode
 366 ----------------------------------------------------------------------------
 367 @node StringId "STRING ID"
 368
 369 @{b}
 370 STRING          ID/K@{ub}
 371
 372
 373 MSGID_BYTENAME
 374 MSGID_KBYTENAME
 375 MSGID_MBYTENAME
 376 MSGID_GBYTENAME
 377 MSGID_TBYTENAME
 378 MSGID_PBYTENAME
 379 MSGID_HBYTENAME
 380 MSGID_REQTITLE
 381 MSGID_OPENERRORNAME
 382 MSGID_OPENERRORGADGETS
 383 MSGID_QUITERRORNAME
 384 MSGID_GADGETSNAME
 385 MSGID_WBLOADNAME
 386 MSGID_WBLOAD_ASLTITLE
 387 MSGID_REPLACENAME
 388 MSGID_REPLACEGNAME
 389 MSGID_DOWAITERRNAME
 390 MSGID_SCAERRORNAME
 391 MSGID_CLOSEWBNAME
 392 MSGID_ABOUTNAME
 393 MSGID_OKNAME
 394 MSGID_UPDATENAME
 395 MSGID_SYSINFONAME
 396 MSGID_FLUSHNAME
 397 MSGID_REBOOTNAME
 398 MSGID_EXISTSNAME_COPY
 399 MSGID_EXISTSGNAME
 400 MSGID_SUREREBOOTNAME
 401 MSGID_OKCANCELNAME
 402 MSGID_LIBERRORNAME
 403 MSGID_SCALIBERRORNAME
 404 MSGID_COLNAMENAME
 405 MSGID_COLSIZENAME
 406 MSGID_COLACCESSNAME
 407 MSGID_COLDATENAME
 408 MSGID_COLTIMENAME
 409 MSGID_COLCOMNAME
 410 MSGID_USEDLIBSNAME
 411 MSGID_SCARUNNINGNAME
 412 MSGID_PREVIEWNAME
 413 MSGID_EMULATIONNAME
 414 MSGID_FILETRANSTITLE_COPY
 415 MSGID_COPYINGNAME
 416 MSGID_FROMNAME
 417 MSGID_TONAME
 418 MSGID_PMTITLE1NAME
 419 MSGID_PMTITLE2NAME
 420 MSGID_PMTITLE3NAME
 421 MSGID_PMTITLE4NAME
 422 MSGID_PMTITLE5NAME
 423 MSGID_PMTITLE6NAME
 424 MSGID_COPYERRORNAME
 425 MSGID_COPYERRORGNAME
 426 MSGID_MOVEERRORNAME
 427 MSGID_DELETEERRORNAME
 428 MSGID_ABOUT_TESTTEXT
 429 MSGID_ABOUT_UNREGTEXT
 430 MSGID_ABOUT_REGTOTEXT
 431 MSGID_ABOUT_REGTEXT
 432 MSGID_ABOUT_COMREGINFO
 433 MSGID_PROGRESS_SETUPSCREEN
 434 MSGID_PROGRESS_SETUPSCRPATTERN
 435 MSGID_PROGRESS_INITMENU
 436 MSGID_PROGRESS_INITTIMER
 437 MSGID_PROGRESS_STARTWINDOWPROC
 438 MSGID_PROGRESS_INITNOTIFY
 439 MSGID_PROGRESS_WBSTARTUP
 440 MSGID_PROGRESS_WBSTARTUP_RUNPRG
 441 MSGID_PROGRESS_READDEVICEICONS
 442 MSGID_PROGRESS_INITDEVICEWINDOW
 443 MSGID_PROGRESS_WBSTARTUPFINISHED
 444 MSGID_PROGRESS_SCALOSVERSION
 445 MSGID_TOOLTIP_ROOTDIR
 446 MSGID_TOOLTIP_USERDIR
 447 MSGID_TOOLTIP_SOFTLINK
 448 MSGID_TOOLTIP_HARDLINKDIR
 449 MSGID_TOOLTIP_FILE
 450 MSGID_TOOLTIP_HARDLINKFILE
 451 MSGID_TOOLTIP_PIPEFILE
 452 MSGID_TOOLTIP_UNKNOWNTYPE
 453 MSGID_TOOLTIP_LASTCHANGE
 454 MSGID_TOOLTIP_SIZE
 455 MSGID_TOOLTIP_PROTECTION
 456 MSGID_TOOLTIP_STATE_WRITEPROTECT
 457 MSGID_TOOLTIP_STATE_VALIDATING
 458 MSGID_TOOLTIP_STATE_READWRITE
 459 MSGID_TOOLTIP_STATE_UNKNOWN
 460 MSGID_TOOLTIP_DISK
 461 MSGID_TOOLTIP_USEDCOUNTFMT
 462 MSGID_TOOLTIP_CREATED
 463 MSGID_TOOLTIP_STATE
 464 MSGID_TOOLTIP_USED
 465 MSGID_TOOLTIP_FILESIZEFMT
 466 MSGID_TOOLTIP_APPICON
 467 MSGID_ICON_WITHOUT_FILE
 468 MSGID_ICONIFIED_WINDOW
 469 MSGID_PMMENU_APPICON_OPEN
 470 MSGID_PMMENU_APPICON_COPY
 471 MSGID_PMMENU_APPICON_RENAME
 472 MSGID_PMMENU_APPICON_INFO
 473 MSGID_PMMENU_APPICON_SNAPSHOT
 474 MSGID_PMMENU_APPICON_UNSNAPSHOT
 475 MSGID_PMMENU_APPICON_LEAVEOUT
 476 MSGID_PMMENU_APPICON_PUTAWAY
 477 MSGID_PMMENU_APPICON_DELETE
 478 MSGID_PMMENU_APPICON_FORMATDISK
 479 MSGID_PMMENU_APPICON_EMPTYTRASHCAN
 480 MSGID_EXISTSNAME_MOVE
 481 MSGID_MULTIDRAG
 482 MSGID_MULTIDRAG_DRAWER_1
 483 MSGID_MULTIDRAG_DRAWER_2
 484 MSGID_MULTIDRAG_FILE_1
 485 MSGID_MULTIDRAG_FILE_2
 486 MSGID_TEXTICON_DRAWER
 487 MSGID_TEXTICON_TRASHCAN
 488 MSGID_PROGRESS_ENDREADDEVICEICONS
 489 MSGID_STATUSBARTEXT
 490 MSGID_MULTIDRAG_DEVICE_1
 491 MSGID_MULTIDRAG_DEVICE_2
 492 MSGID_CANCELBUTTON
 493 MSGID_PREPARING_COPY
 494 MSGID_PREPARING_MOVE
 495 MSGID_FILETRANSFER_REMAININGTIME
 496 MSGID_FILETRANSFER_MINUTES
 497 MSGID_FILETRANSFER_SECONDS
 498 MSGID_FILETRANSFER_SECOND
 499 MSGID_FILETRANSTITLE_MOVE
 500 MSGID_MOVINGNAME
 501 MSGID_PROGRESS_READINGPREFS
 502 MSGID_DISK_UNREADABLE
 503 MSGID_PROGRESS_MAINWINDOW
 504 MSGID_NEW_DRAWER_NAME
 505 MSGID_CANNOT_OPEN_DRAWER
 506 MSGID_ALLOCPENSREQ_CONTENTS
 507 MSGID_ALLOCPENSREQ_GADGETSNAME
 508 MSGID_TOOLTIP_FILETYPE_WBGARBAGE
 509 MSGID_TOOLTIP_FILETYPE_WBPROJECT
 510 MSGID_TOOLTIP_FILETYPE_WBDEVICE
 511 MSGID_TOOLTIP_FILETYPE_WBKICK
 512 MSGID_TOOLTIP_FILETYPE_WBTOOL
 513 MSGID_TOOLTIP_FILETYPE_WBDISK
 514 MSGID_ERROR_NO_DEFAULTTOOL
 515 MSGID_TOOLTIP_GADGET_RIGHTSCROLLER
 516 MSGID_TOOLTIP_GADGET_BOTTOMSCROLLER
 517 MSGID_TOOLTIP_GADGET_UPARROW
 518 MSGID_TOOLTIP_GADGET_DOWNARROW
 519 MSGID_TOOLTIP_GADGET_RIGHTARROW
 520 MSGID_TOOLTIP_GADGET_LEFTARROW
 521 MSGID_TOOLTIP_GADGET_ICONIFY
 522 MSGID_TOOLTIP_GADGET_STATUSBAR_TEXT
 523 MSGID_TOOLTIP_GADGET_STATUSBAR_READONLY
 524 MSGID_TOOLTIP_GADGET_STATUSBAR_READING
 525 MSGID_TOOLTIP_GADGET_STATUSBAR_TYPING
 526 MSGID_TOOLTIP_GADGET_STATUSBAR_SHOWALL
 527 MSGID_EXISTSICON_COPY
 528 MSGID_TOOLTIP_USEDCOUNTFMT_FULL
 529 MSGID_TOOLTIP_USEDCOUNTFMT_FREE
 530 MSGID_TOOLTIP_USEDCOUNTFMT_INUSE
 531 MSGID_TOOLTIP_DRAWERS
 532 MSGID_TOOLTIP_FILES
 533 MSGID_TOOLTIP_LINKTO
 534 MSGID_TOOLTIP_KICKSTART
 535 MSGID_NODEFAULTTOOL_REQ
 536 MSGID_NODEFAULTTOOL_REQ_GADGETS
 537 MSGID_REQ_SELECTDEFTOOL
 538 MSGID_TEXTICON_SOLOICON
 539
 540 @endnode
 541 ----------------------------------------------------------------------------
 542 @node StringTextPen "STRING TEXTPEN"
 543
 544 @{b}
 545 STRING          TEXTPEN/K@{ub}
 546
 547
 548 PENIDX_HSHINEPEN
 549 PENIDX_HSHADOWPEN
 550 PENIDX_ICONTEXTOUTLINEPEN
 551 PENIDX_DRAWERTEXT
 552 PENIDX_DRAWERTEXTSEL
 553 PENIDX_DRAWERBG
 554 PENIDX_FILETEXT
 555 PENIDX_FILETEXTSEL
 556 PENIDX_FILEBG
 557 PENIDX_BACKDROPDETAIL
 558 PENIDX_BACKDROPBLOCK
 559 PENIDX_TOOLTIP_TEXT
 560 PENIDX_TOOLTIP_BG
 561 PENIDX_DRAGINFOTEXT_TEXT
 562 PENIDX_DRAGINFOTEXT_BG
 563 PENIDX_STATUSBAR_BG
 564 PENIDX_STATUSBAR_TEXT
 565 PENIDX_ICONTEXTPEN
 566 PENIDX_ICONTEXTPENSEL
 567 PENIDX_ICONTEXTSHADOWPEN
 568
 569 @endnode
 570 ----------------------------------------------------------------------------
 571 @node StringSrc "STRING SRC"
 572
 573 @{b}
 574 STRING          SRC/K@{ub}
 575
 576
 577 "diskstate"
 578 "diskusage"
 579 "diskusagefree"
 580 "diskusageinuse"
 581 "diskusagepercent"
 582 "fibfilename"
 583 "filecomment"
 584 "filedate"
 585 "fileprotection"
 586 "filesize"
 587 "filetime"
 588 "filetypestring"
 589 "iconname"
 590 "linktarget"
 591 "plugin"
 592 "versionstring"
 593 "volumecreateddate"
 594 "volumecreatedtime"
 595 "volumeordevicename"
 596
 597 @endnode
 598 ----------------------------------------------------------------------------
 599 @node MemberHide "MEMBER HIDE"
 600
 601 @{b}
 602 MEMBER          HIDE/K@{ub}
 603
 604 "novolumenode"
 605 "isempty"
 606
 607 @endnode
 608 ----------------------------------------------------------------------------
 609 @node Group "GROUP"
 610
 611 @{b}
 612 GROUP           ORIENTATION/K@{ub}
 613
 614 @endnode
 615 ----------------------------------------------------------------------------
 616 @node EndGroup "ENDGROUP"
 617
 618 @{b}
 619 ENDGROUP@{ub}
 620
 621 @endnode
 622 ----------------------------------------------------------------------------
 623 @node Member "MEMBER"
 624
 625 @{b}
 626 MEMBER          HIDE/K@{ub}
 627
 628
 629         @{" HIDE " Link MemberHide }
 630
 631 @endnode
 632 ----------------------------------------------------------------------------
 633 @node EndMember "ENDMEMBER"
 634
 635 @{b}
 636 ENDMEMBER@{ub}
 637
 638 @endnode
 639 ----------------------------------------------------------------------------
 640 @node HBar "HBAR"
 641
 642 @{b}
 643 HBAR@{ub}
 644
 645 @endnode
 646 ----------------------------------------------------------------------------
 647 @node Space "SPACE"
 648
 649 @{b}
 650 SPACE           SIZE/N/A@{ub}
 651
 652
 653         SIZE
 654
 655 @endnode
 656 ----------------------------------------------------------------------------
 657 @node DtImage "DTIMAGE"
 658
 659 @{b}
 660 DTIMAGE         FILENAME/A@{ub}
 661
 662
 663         FILENAME
 664
 665 @endnode
 666 ----------------------------------------------------------------------------