Sample .ipi file

[mouser]

just to give you an idea how i am thinking..

you will download cheat sheet "sets" that can contain any number of actual cheat sheets or info pages.
here's a sample of my current thinking of what a configuration file for a SET would look like.

So note that this file just DESCRIBES the resources in the set (ie it refers to some html pages which are the cheat sheets, and one refers to an "online" resource); in this way, cheat sheets can be local, online, html, text, movies, etc.

Sorry the tabs did not display properly smf needs a formatting mode that respects tabs !!


//---------------------------------------------------------------------------
// .ipi configuration file for some UltraEdit InfoPages.
//---------------------------------------------------------------------------

//---------------------------------------------------------------------------
// Info about this file format:
//  Note that we can use a single common "Author", "Date", "Homepage" fields
//   (or we could have specified them explicitly with each entry)
//  Entries MUST start with the keyword "Title", others can be in any order.
//  Comments *start* with // (only if starting a line is it a comment).
//  Dates should be specified in illogical US format (MM/DD/YYYY)
//  URL's can be online or local (relative to cur dir) resources
//  "Hint" is optional (title will be used on mouse over if no hint specified)
//  "Keyword" is optional (should be comma separated words)
//---------------------------------------------------------------------------


//---------------------------------------------------------------------------
Author=         mouser
Date=         06/10/2005
Homepage=      https://www.donationcoder.com
//---------------------------------------------------------------------------


//---------------------------------------------------------------------------
Title=         UltraEdit HotKeys
Application=   UltraEdit
Hint=         Common HotKeys for UltraEdit
Description=   A simple list of hotkeys for UltraEdit, in html format.  Suitable for small window display.
URL=         file://uedit_hotkeys.html
Keywords=      hotkey,shortcut

Title=         UltaEdit Forum
Application=   UltraEdit
Description=   Visit the UltraEdit Online Forum
URL=         http://www.ultraedit...?name=Forums&c=1
Keywords=      forum

Title=         UltraEdit Tips
Application=   UltraEdit
Description=   A list of tips and tricks for advanced users
URL=         file://uedit_tips.html
Keywords=      tip,trick
//---------------------------------------------------------------------------

[mouser]

I made some changes to organization.  here is a more accurate view of current ipi file:

//---------------------------------------------------------------------------
// .ipi configuration file for some UltraEdit ResourceSets.
//---------------------------------------------------------------------------

//---------------------------------------------------------------------------
// About this file format:
//  The file must begin with a SET definition
//  Info Page Entries MUST start with the keyword "RESOURCE" on a line alone
//  Comments *start* with // (only if starting a line is it a comment).
//  Dates should be specified in illogical US format (MM/DD/YYYY)
//  URL's can be online or local (relative to cur dir) resources
//  "Hint" is optional (title will be used on mouse over if no hint specified)
//  "Keyword" is optional (should be comma separated words)
//---------------------------------------------------------------------------


//---------------------------------------------------------------------------
SET
Author=         mouser
Date=         06/10/2005
Homepage=      https://www.donationcoder.com
Application=   UltraEdit
FileRegEx=      *.ue\.exe||*.ultraedit\.exe
UpdateURL=      https://www.donation...user/uedit/uedit.ipi
//---------------------------------------------------------------------------


//---------------------------------------------------------------------------
RESOURCE
Title=         UltraEdit HotKeys
Hint=         Common HotKeys for UltraEdit
Description=   A simple list of hotkeys for UltraEdit, in html format.  Suitable for small window display.
URL=         file://uedit_hotkeys.html
Keywords=      hotkey||shortcut

RESOURCE
Title=         UltaEdit Forum
Description=   Visit the UltraEdit Online Forum
URL=         http://www.ultraedit...?name=Forums&c=1
Keywords=      forum

RESOURCE
Title=         UltraEdit Tips
Description=   A list of tips and tricks for advanced users
URL=         file://uedit_tips.html
Keywords=      tip||trick
//---------------------------------------------------------------------------

[Dragonrider]

Mouser:
If I may ask.  Why are you going thru all the work of creating a config file format  when you could be using an INI file formatted configuration file that would be IMHO more flexible.  Let me illustrate with an INI file that would do
the same as what you describe & yet could also have multiple instances of your file in the same file.


[Applications]
001=UltraEdit - mouser
002=MS Word - dragonrider
003=Powerpoint
004=Project Dogwaffle
005=UltraEdit - dragonrider

; As many applications can go here as desired.  Just don't have any embedded empty lines in any of the sections.
; I know that comments can be inserted into an INI file, but I honestly don't remember how.  I think that any
; lines that are isolated by blank lines from a section are ignored, but I believe that there is an actual comment
; character(s) as well.

[UltraEdit - mouser]
Author=mouser
Date=06/10/2005
Homepage=https://www.donationcoder.com
Application=UltraEdit
FileRegEx=*.ue\.exe||*.ultraedit\.exe
UpdateURL=https://www.donationcoder.com/cheatsheeter/mouser/uedit/uedit.ipi
Hotkeys=UltraEdit - Hotkeys - mouser
Forum=UltraEdit Forum - mouser
Tips=UltraEdit Tips - mouser

[UltraEdit Forum - mouser]
Description=Visit the UltraEdit Online Forum
URL=http://www.ultraedit.com/index.php?name=Forums&c=1
Keywords=forum

[UltraEdit Tips - mouser]
Description=A list of tips and tricks for advanced users
URL=file://uedit_tips.html
Keywords=tip||trick

[UltraEdit - Hotkeys - mouser]
Hint=Common HotKeys for UltraEdit
Description=A simple list of hotkeys for UltraEdit, in html format.  Suitable for small window display.
URL=file://uedit_hotkeys.html
Keywords=hotkey||shortcut

[UltraEdit - dragonrider]
Author=dragonrider
Date=06/11/2005
Homepage=http://www.freddiethefreeloader.com
Application=UltraEdit
FileRegEx=*.ue\.exe||*.ultraedit\.exe
UpdateURL=https://www.donationcoder.com/cheatsheeter/mouser/uedit/uedit.ipi
Hotkeys=UltraEdit - Hotkeys - dragonrider
Forum=UltraEdit Forum - dragonrider
Tips=UltraEdit Tips - dragonrider

[MS Word - dragonrider]
Author=dragonrider
[email protected]
version=1.2
Date=06/11/2005
Homepage=http://www.dragonrider.com
Application=Microsoft Word
FileRegEx=*.msword\.exe
UpdateURL=https://www.donationcoder.com/cheatsheeter/dragonrider/msword/msword.ini
Hotkeys=MS Word - Hotkeys - dragonrider
Forum=
Tips=MS Word Tips - dragonrider
Links=MS Word Links - dragonrider

[MS Word Links - dragonrider]
Description=A list of links for extra research and help.
URL=file://msword_links.htm
keywords=links||urls

[MS Word Tips - dragonrider]
Description=A list of tips and tricks for advanced users
URL=file://msword_tips.html
Keywords=tip||trick

[MS Word - Hotkeys - dragonrider]
Hint=Common HotKeys for MS Word
Description=A simple list of hotkeys for MS Word, in html format.  Suitable for small window display.
URL=file://msword_hotkeys.html
Keywords=hotkey||shortcut

The benefits of having an INI file instead of a proprietary format are:
*   many DLLs & function libraries that can handle INI files in many different programming languages.
*   the sections don't have to be in any particular order.
*   more than 1 applications sheets can be described in a single file.
*   more than 1 version of the same application can be described in a single file (see UltraEdit - 1 & 2)
*   because its 1 file instead of many, it is much faster to load the info. from the file into the program.
*   Additional fields can be created on the fly (see "MS Word - dragonrider" section) like version & email.

To update this file with new sheets would just require CheatSheet to:
*   get the files from donationcoder.com
*   if the file set exists already on the local PC, ask to user if they want to overwrite or add it to their
   list of sheets
*   If yes, then overwrite the files with the new ones.
*   If no, then make new names for the files.
*   take the required information out of the application INI files & write it into the main INI file.

As usual, I'm not trying to force this on you.  I'm just suggesting the possible benefits of this approach.

Regards
Dragonrider

[mouser]

i've spent a lot of time agnoizing over how to manage these info pages.
i think when its all working it will make more sense, but i'll lay out some of my thinking.

i want it to be easy to add new cheat sheet sets, and easy to enable and disable them.

so if you look at the sample screenshot in the other thread you will see its like a two level hierarchy
you have SETS and then you have RESOURCES (files,urls) in each set.

a SET has an application, author, a homepage, etc.

a SET contains a number of RESOURCES, each one is like a shortcut to a afile or online url, etc.

you can browse SETS, and enable and disable them, and also browse and enable/disable the resources in each set.

each config file describes a SET, you can have tons of config files; they are discovered automatically when found in the data directory.

i could use a more ini style config file file.. couldn't really hurt though i dont think there is any real advantage to it/