2.0Note Studio Tour (Author)Note Studio TourNote Studio TourDogmelon2.0000Upgrading from Wiki Studio - Improved Import and Export Capabilities00In Note Studio 2.0 we stop using the original *.wiki (legacy) file format, except to be able to import from it.The (*.wiki) file format was essentially the same on both the desktop and the Palm. The file format was designed for ease-of-use. While it was convenient (as people noticed, you could edit the files using a text-editor), it had a some problems: as an ordinary file, it was hard to share in multi-user environment. performance problems on the Palm.Now Notebooks are stored in a database. This solves the above issues. However, there is still the requirement to be able to transfer data between Note Studio and other applications.Note Studio XML formatIn version 2, we introduce Note Studio XML Format. This is a fully-compliant xml format, and has two main purposes: allow notebooks to be provided to others. One user can create a notebook, export it to xml, then any other Note Studio user can import that notebook into their own library. allow data interchange with other applications. The xml format can be translated to other formats, via XSLT or other means. Conversely, other applications can export data to the xml format, for reading into Note Studio.The Note Studio XML Format is fully documented in the main help file.Get started00Shut down this tour, you can always come back to this by selecting 'Note Studio Tour' in the 'Help' menu.Introduction - Make Page Example - Shopping List00normally, this page would be empty, because you've just created itIntroduction - Make Page ExampleGo back to previous pageNew to Note Studio - What's good00Here's a summary of the main benefits of using Note Studio:New to Note Studio - Ease of set-upEase of set-upNew to Note Studio - Advanced Notebook ManagementAdvanced Notebook ManagementNew to Note Studio - Intuitive, easy-to-use interfaceIntuitive, easy-to-use interfaceNew to Note Studio - Palm CompatibilityPalm CompatibilityNew to Note Studio - Powerful Data Exchange with other applicationsPowerful Data Exchange with other applicationsNew to Note StudioBackUpgrading from Wiki Studio - Multi-user Support00(Professional version only)In version 1, it was not really possible to share *.wiki files in a multi-user environment (eg an office). You could do it, by placing a *.wiki file on a network drive, but there were problems if both people tried to edit the file at once. This is because the *.wiki file was a simple file, with no in-built locking or synchronisation.In Note Studio 2, we have moved to a database system, which provides the synchronisation and locking you need. Now it is possible for multiple users to share notebooks safely.Introduction - Household example - house00Here you might enter notes about the house, including links to more pages.[[Introduction -> Household example]Go back]Upgrading from Wiki Studio - Name Change00As of version 2.0, the product is named Note Studio.It is the same product, only by a different name. If you ever bought dogMelon Wiki for Palm, Wiki World or Wiki Studio, you are still entitled to updates. You just now own a licence for Note Studio.So is Note Studio still a Wiki application? Yes, it's still based on the wiki concept.Introduction (part 3)00How do I manage my notebooks?Notebooks are stored in your Library. Your library allows you to manage all the notebooks you are currently using. For example, using the library, you can:open a notebook for readingsearch all your notebookscreate new notebooksimport notebooksexport notebooksmark notebooks as read-onlyrename notebooksetcNote: When you launch Note Studio, you will start in the library.Introduction (part 4)Continue IntroductionIntroduction (part 2)Go to previousIntroduction (part 5)00Where to from here?That is the end of the introductory tour. You are now ready to use Note Studio.In future, you can re-do this tour from the 'Help' menu, by selecting 'Note Studio Tour'To learn more about Note Studio, you can access the full help from the 'Help' menu, by selecting 'Contents'To quickly see a list of all possible markup syntax, select 'Syntax Guide' from the Help Menu.HelpMainReturn to Start of TourIntroduction (part 4)Go to previousUpgrading from Wiki Studio00Firstly, welcome to version 2. It's been a long time in development, and represents an almost complete overhaul of version 1. We hope you like the changes.In this the tour, we'll briefly show you the changes in Note Studio, so you can get started as quickly as possible. Here is a summary of the major changes:Upgrading from Wiki Studio - Improved SyntaxImproved Syntax Upgrading from Wiki Studio - Multi-book ArchitectureMulti-book ArchitectureUpgrading from Wiki Studio - Multi-user SupportMulti-user SupportUpgrading from Wiki Studio - GUI ImprovementsGUI ImprovementsUpgrading from Wiki Studio - Localisation SupportLocalisation SupportUpgrading from Wiki Studio - Improved Import and Export CapabilitiesImproved Import/Export CapabilitiesUpgrading from Wiki Studio - Plugin ArchitecturePlugin ArchitectureUpgrading from Wiki Studio - Name ChangeName ChangeFinally, as an upgrading user, the most important thing you need to know is:Upgrading from Wiki Studio - Importing old dataHow do I import my old data?Get startedHow do I exit the tour?Introduction - Household example - car00Here you might enter notes about the car, including links to more pages.[[Introduction -> Household example]Go back]Introduction - Make Page Example00You can make a new page by placing the page name in square brackets:You typeYou seeNext week's [shopping list]Next week's Introduction - Make Page Example - Shopping Listshopping listYou have now created a link to a new page. Clicking on that page will take you to the new page. In this way, you can join pages together, in the same way pages are linked together on the internet.IntroductionGo back to previous pageIntroduction - Setup Notebook Example00Imagine you were creating a notebook to help you manage your household.You might set up the front page like this: *My Household Notebook* -[kids] -[car] -[house] -[money] (encrypted) Here's how the page would be displayed:My Household NotebookIntroduction - Household example - kidskidsIntroduction - Household example - carcarIntroduction - Household example - househouseIntroduction - Household example - moneymoney (encrypted)Introduction (part 2)Go back to previous pageNew to Note Studio - Intuitive, easy-to-use interface00Because it is a stand-alone application, not a browser, Note Studio is able to have a more powerful graphical user-interface. At any time, bring up the following panels:Navigator PanelSee all your pages, for fast navigationSearch PanelQuickly search your book for a word or phraseRecent Changes PanelSee all the latest changes made to the current notebook.Library PanelManage all your notebooks with a few clicks.New to Note Studio - Palm CompatibilityNext: Palm CompatibilityNew to Note Studio - What's goodBackUpgrading from Wiki Studio - Where is original wiki file00It depends on where you installed your Palm software, but generally it will be in that directory, then under your username, in the wiki directory.ExampleIf your username is SmithR, thenfor a standard palm, it may be: C:/Program Files/Palm/SmithR/wiki/palm.wikifor a Sony Clie, it may be: C:/Program Files/Sony Handheld/SmithR/wiki/palm.wikiIntroduction - Household example - money00Here you might enter notes about money. You might encrypt this page.[[Introduction -> Household example]Go back]Full Markup Description00MarkupEffect*bold*bold text=italic=italic text=*bold-italic*=bold-italic text-(hyphen, start of line) bullet point--(hyphen, start of line) nested bullet point (keep adding an extra '-' to nest deeper)#(start of line) numbered point##(start of line) nested numbered point (keep adding an extra '#' to nest deeper)+(start of line) heading 1++(start of line) heading 2+++(start of line) heading 3++++(start of line) heading 4___(3 underscores, start of line) horizontal line[some page]link to page called 'some page'[[some page][friendly name]]link called 'friendly name', goes to page called 'some page'[[some page] friendly name]link called 'friendly name', goes to page called 'some page' (short-hand version)[[http://www.dogmelon.com.au][friendly name]]url with a friendly name[[mailto:support@dogmelon.com.au][friendly name]]email link with a friendly name[[file:///c:\some_file.txt][friendly name]]link to open a file[[file:///c:/some_file.txt][friendly name]]link to open a file (fwd slashes)[[file:///\\servername\path\some_file.txt][friendly name]]link to open a file on a remote machine[[file://///servername/path/some_file.txt][friendly name]]link to open a file on a remote machine (fwd slashes)[{...}]don't marked up text inside brackets[|...|]equivalent to <pre> in HTMLtabthe tab character is used as a column separator, to make simple tables.HelpMain00Note Studio 2.0(c) Dogmelon Pty Ltd 2001-2003.Take the Tour!Welcome to Note Studio.This book will quickly show you around Note Studio. At any time during the tour, you can return here by pressing Home, in the toolbar.Please select a link:IntroductionAssume I know nothing. Give me a full introduction.New to Note StudioI have used a wiki before, but I'm new to Note StudioUpgrading from Wiki StudioI'm upgrading from a program called WikiStudio / WikiWorld.Get startedI don't care for a tutorial. Tell me how to start straight awayUpgrading from Wiki Studio - Importing old data00First, make sure you have read about the Upgrading from Wiki Studio - Improved Syntax - Changed Syntaxchanges to version 1 markup. Exit the tour (Get startedhow?) You will be in the library panel. From the Library menu, select Import Book.... This will bring up a file dialog: choose file type as Legacy wiki file (*.wiki) navigate to your original wiki file (Upgrading from Wiki Studio - Where is original wiki filewhere?) press the Open button.Note:The only pages which will not be converted, are encrypted pages. You will need to convert these manually.Once you have imported the legacy file, changes you make within Note Studio will not be written back to the legacy file.Introduction - Household example - kids00Here you might enter notes about the kids, including links to more pages.[[Introduction -> Household example]Go back]Upgrading from Wiki Studio - GUI Improvements00Apart from general cosmetic surgery, Note Studio's main viewing window is now HTML-based, looking much more like a web browser (and yes, the cursor now changes over a link).In addition, side panels have been added. Using the toolbar, you can now use tools likeNavigator - shows a list of all pages in a book, jumps to the page you selectSearch - lets you search for text either in a notebook or the entire libraryRecent Changes - see which pages were edited most recently. Great for multi-user environments.Incidentally, with the introduction of the 'Navigator', you can now access pages even if no other page links to them.New to Note Studio - Advanced Notebook Management00Here's a brief overview of interesting things you can do using Note Studio:Search notebooksSearch your notebooks for a word or phrase. This means you can immediately find notes you made months ago, as long as you can remember roughly what the note was about.Encrypt notebooksStore passwords, bank details, diary or any other private data in an encrypted notebook. When you encrypt a notebook, others are not able to read the contents, even if your PC or handheld falls into the wrong hands. Have you ever written down any passwords, PIN numbers or other secret information, to avoid forgetting it? Never again, with Note Studio.Share notebooksIn a multi-user environment (eg office or home network), have notebooks in a shared location, so that multiple users can read or edit it simultaneously.Exchange notebooksSend your notebooks to other Note Studio users. Compile sets of notes that would be useful to others. Read notebooks written by others.Carry notebooksWith your Palm device, carry all your notebooks around with you, all of the time, without needing a mule.Export notebooksYou can save your notebooks in HTML format. These are then ready to be put on the web. Make your notes available to the whole world!Beam notebooks(coming soon) Notebooks can be beamed to other Note Studio users via your Palm device.New to Note Studio - Intuitive, easy-to-use interfaceNext: Intuitive, easy-to-use interfaceNew to Note Studio - What's goodBackNew to Note Studio - What's Different00Note Studio has a slightly different paradigm to most other wiki applications.1. Stand-alone applicationThe original wiki concept involves setting up a wiki server on a host machine. Users interact with this server through a web browser. Thus the wiki server maintains a database, available over a network, which users can read and write through a simple browser interface.Note Studio is a stand-alone application. It does not need a web server. It does not need a web browser. It is provides a browser-like interface, through which the user can edit data stored on local (or remote) files.2. Notebook-Library architectureNote Studio lets you separate your information into different notebooks. Basically, each notebook is a separate wiki database. You can set up different notebooks for different topics that are of interest to you.You can manage these notebooks individually. For example you might encrypt some notebooks, make others read-only, share others on an intranet, export others to HTML.You manage these notebooks through the Library.New to Note StudioBackUpgrading from Wiki Studio - Localisation Support00So many of our users are from non-English speaking backgrounds. This has caused problems.menus and help files in English onlysome languages do not have upper case, so making links was not possible in version 1.many non-english characters (eg äöüÄÖÜ) were not allowed in links, and could not be encrypted properly.Now with the square-bracket syntax, links are much easier to make.Also, as of version 2.0, we plan to provide at least one other language file (German). If you are interested in translating Note Studio, we would like to hear from you. Please mailto:support@dogmelon.com.auemail us.Introduction (part 2)00How would I set up a notebook?It depends very much on your personal preferences. Here's one way you might do it:Introduction - Setup Notebook ExampleWhenever you want, you can make notes on the appropriate page, or make new pages. In time your notebooks will become invaluable sources of information.What else can I do with notebooks?You can do many other useful things with notebooks. Some of these things are:Search notebooksSearch your notebooks for a word or phrase. This means you can immediately find notes you made months ago, as long as you can remember roughly what the note was about.Encrypt notebooksStore passwords, bank details, diary or any other private data in an encrypted notebook. When you encrypt a notebook, others are not able to read the contents, even if your PC or handheld falls into the wrong hands. Have you ever written down any passwords, PIN numbers or other secret information, to avoid forgetting it? Never again, with Note Studio.Share notebooksIn a multi-user environment (eg office or home network), have notebooks in a shared location, so that multiple users can read or edit it simultaneously.Exchange notebooksSend your notebooks to other Note Studio users. Compile sets of notes that would be useful to others. Read notebooks written by others.Carry notebooksWith your Palm device, carry all your notebooks around with you, all of the time, without needing a mule.Export notebooksYou can save your notebooks in HTML format. These are then ready to be put on the web. Make your notes available to the whole world!Beam notebooks(coming soon)Notebooks can be beamed to other Note Studio users via your Palm device.Introduction (part 3)Continue IntroductionIntroductionGo back to start of IntroductionIntroduction (part 4)00Edit and View ModesBefore you start, the final thing you need to know is how to actually edit a page.When you're working in a notebook, it is in one of two states: View Mode Edit ModeNormally, when you are looking around a notebook, you will be in View Mode. Your notes will be properly marked up.In order to change a page, switch into Edit Mode. While in Edit Mode, text is not marked up. It is possible to see (and edit) markup characters.The following table summarizes the differences:Modemarkup characters are visibleexample: *bold* appears aspage can be editedViewnoboldnoEdityes*bold*yesToggle between View and Edit modes by using the 'Edit' button on the toolbar.Introduction (part 5)Continue IntroductionIntroduction (part 3)Go to previousNew to Note Studio00Thank you for trying Note Studio. We hope you will find it a very powerful tool for managing all your data.This overview is designed to get you using Note Studio as quickly as possible, given that you have used a wiki before.New to Note Studio - What's DifferentWhat's different about Note Studio, compared to other wikis?New to Note Studio - Markup SyntaxMarkup SyntaxNew to Note Studio - What's goodWhat's good about Note StudioWhere to from here?That is the end of the tour. You are now ready to start using Note Studio.In future, you can re-do this tour from the 'Help' menu, by selecting 'Note Studio Tour'To learn more about Note Studio, you can access the full help from the 'Help' menu, by selecting 'Contents'HelpMainReturn to Start of TourNew to Note Studio - Ease of set-up00Run a simple install, and you're running.No server to set upNo permissions to configure.A stand-alone application that anyone can install and use.New to Note Studio - Advanced Notebook ManagementNext: Advanced Notebook ManagementNew to Note Studio - What's goodBackNote Studio Tour00Note Studio 2.0(c) Dogmelon Pty Ltd 2001-2003.______________________________________Take the Tour!Welcome to Note Studio.This book will quickly show you around Note Studio. At any time during the tour, you can return here by pressing Home, in the toolbar.Please select a link:IntroductionI don't know what a Wiki is. I want a full introduction.New to Note StudioI have used a wiki before, but I'm new to Note StudioUpgrading from Wiki StudioI'm upgrading from a program called WikiStudio / WikiWorld.Get startedI don't care for a tutorial. Tell me how to start straight awayNew to Note Studio - Powerful Data Exchange with other applications00Note Studio has a standard XML-based file format for data interchange. This XML format is documented in Note Studio's main help file.Import data into Note StudioAny data that can be translated into this XML format can be imported into Note Studio.Export data from Note StudioConversely, any Note Studio book, once exported to XML format, can be translated for use by other applications.New to Note Studio - What's goodBackIntroduction - Markup Example00Imagine you make a note such as:Next Meeting: 04 NovemberNow you decide, you'd like to emphasise some text. If you make the note:*Next Meeting:* 04 NovemberIt will then be displayed as:Next Meeting: 04 NovemberLook at the following examples:You typeYou seeNext Meeting: 04 NovemberNext Meeting: 04 November*Next Meeting:* 04 NovemberNext Meeting: 04 November=Next Meeting:= 04 NovemberNext Meeting: 04 November=*Next Meeting:*= 04 NovemberNext Meeting: 04 NovemberIntroductionGo back to previous pageUpgrading from Wiki Studio - Multi-book Architecture00In version 1, you could have multiple Wiki Studio (*.wiki) files on your desktop, but only one could be synchronised to your Palm.This meant: your main wiki database tended to grow large if you maintained other *.wiki files, you never had access to them on your Palm.Note Studio 2.0 introduces the concept of a library, which contains notebooks. So now you can have multiple databases (notebooks), both on your desktop and on your Palm.There are two main benefits to having this notebook architecture. it's now easier to manage your notes it's now possible to share notesManaging notesWe use the 'notebook' analogy, because we feel it's a close fit to how people use notebooks in real life. People tend to have separate notebooks for different areas of their life.You may now perform operations on particular notebooks, eg encrypt a notebook mark a notebook as read-onlySharing notesNotebooks can be copied, exported, imported, so it becomes possible to make notebooks available to others.Notebooks can be exported to HTML, for display on the web.Notebooks can be edited by multiple people in an office-type situation.Notebooks may be made available to anyone in the world for download.Upgrading from Wiki Studio - Plugin Architecture00Note Studio has a plugin architecture, allowing plugins to be developed, downloaded, and run from within Note Studio.This will be documented further in the future, but it will provide a powerful way for extending Note Studio.New to Note Studio - Markup Syntax00Here is a quick summary of Note Studio's markup syntax:MarkupEffect*bold*bold text=italic=italic text=*bold-italic*=bold-italic text-(hyphen, start of line) bullet point--(hyphen, start of line) nested bullet point (keep adding an extra '-' to nest deeper)#(start of line) numbered point##(start of line) nested numbered point (keep adding an extra '#' to nest deeper)+(start of line) heading 1++(start of line) heading 2+++(start of line) heading 3++++(start of line) heading 4___(3 underscores, start of line) horizontal line[some page]link to page called 'some page'[[some page][friendly name]]link called 'friendly name', goes to page called 'some page'[[some page] friendly name]link called 'friendly name', goes to page called 'some page' (short-hand version)[[http://www.dogmelon.com.au][friendly name]]url with a friendly name[[mailto:support@dogmelon.com.au][friendly name]]email link with a friendly name[[file:///c:\some_file.txt][friendly name]]link to open a file[[file:///c:/some_file.txt][friendly name]]link to open a file (fwd slashes)[[file:///\\servername\path\some_file.txt][friendly name]]link to open a file on a remote machine[[file://///servername/path/some_file.txt][friendly name]]link to open a file on a remote machine (fwd slashes)[{...}]don't marked up text inside brackets[|...|]equivalent to <pre> in HTMLtabthe tab character is used as a column separator, to make simple tables.New to Note StudioBackUpgrading from Wiki Studio - Improved Syntax00By now you may already have noticed that Note Studio provides more powerful markup syntax than the earlier versions.The new markup is mostly extensions and additions, but there have also been changes.Upgrading from Wiki Studio - Improved Syntax - New SyntaxNew SyntaxUpgrading from Wiki Studio - Improved Syntax - Changed SyntaxChanged SyntaxUpgrading from Wiki Studio - Improved Syntax - Changed Syntax00We don't change syntax lightly.The last thing we want is for current users to be inconvenienced when they upgrade. However, if we were to make any changes, we thought it was now or never. As more people use Note Studio, it becomes harder to change the fundamentals.What has changed?Changes to syntax are: change bullet point syntax from '*' (asterisk) to '-' (dash)removal of original Wiki Word links (camel case) altogetherWhy are these changed?Bullet points: avoid ambiguity with the new bold syntax, which uses the '*' character.Camel Case links: There are a lot of problems with the old camel-case syntax (ie words capitalised in a particular way to form links, eg 'CamelCase'). The problems are: you get false hits, eg the chemical symbol NaCl looks like a link. Even a practical solution to this (extra markup meaning: don't recognise this next bit as a link) is more complication and messy. You get unnatural-looking words, in order to make links, making your notes look messy. We did consider leaving camel case links in, for compatibility, but in the end decided to kill them off here and now. You can always simulate them with the new square bracket syntax.What about all my old data. Do I have to go back and change all the old syntax?No. The first time you import your version 1 legacy data, it will automatically be converted. Bullet-point '*' characters are replaced with '-' characters, and CamelCase links, if they point to actual pages, are placed within square brackets.How do you convert encrypted pages?By asking you for the password for each encrypted page, as they are found. If you cannot supply the password, this page will not be converted. It will still import correctly, but you will need to re-do links and bullet points on that page.Upgrading from Wiki Studio - Improved Syntax - New Syntax00New syntax includes bold italic headings (heading 1, heading 2, heading 3, and heading 4) friendly link names horizontal lines very simple table supportFull Markup DescriptionHere are some examples:bolditalicbold italicheading 1heading 2heading 3heading 4http://www.dogmelon.com.au/ns (a link to the dogmelon Note Studio website)http://www.dogmelon.com.au/nsThe same link with a different namePage links can have friendly names too:HelpMainGo back to the start of the tourhorizontal line:A simple table:Column 1Column 2Column 3row1, col1row1, col2row1, col3row2, col1row2, col2row2, col3Paste in code inside PRE tags: for( int i=0; i<1; i++ ) { ++j; } New to Note Studio - Palm Compatibility00From day one, Note Studio was designed for portable devices. You can read and edit your notes while out on the road. On return to your desktop, synch your notes, and have your Palm changes reflected back onto your PC.Portable notebooks!Carry documentation around with you.New to Note Studio - Powerful Data Exchange with other applicationsNext: Powerful Data Exchange with Other ApplicationsNew to Note Studio - What's goodBackIntroduction00Thank you for using Note Studio. We hope you find it a very useful tool.What is Note Studio?make notes that you can instantly retrieve months later.arrange notes into different notebookspublish your notebooks onto a web pagesend your notebooks to other peopleencrypt your notebooks, to keep data privateusing your Palm device, carry your notes with you alwaysThese are the sorts of things you can do with Note Studio. Quite simply, it is the easiest system for making notes on any topic at all.How does it work?When you enter your notes, you just enter text like you normally would. However, some text has special meaning. This is called markup. Markup enables you to enter ordinary text, but have it displayed in a special way.Introduction - Markup ExampleClick here to see an exampleMarkup also allows you to make new pages in your notebook, and link them together.Introduction - Make Page ExampleClick here to see an exampleThere are many more ways to mark up text than these simple examples demonstrate. To find out more, go to 'Syntax Guide' from the Help Menu.Introduction (part 2)Continue Introduction