2.0Note Studio Help (Author)HomePageHomePageDogmelon Pty LtdCreated in dogMelon NoteStudio000Timestamp00Inserts a timestamp containing the computer's current time, directly onto the page.PC VersionThe precise format of this timestamp is determined by the "Regional Settings" options in the system's Control Panel.This option is only available in Edit mode.Importing Your Old Data00You import your version 1 WikiWorld data (now known as legacy data) using the legacy importer. This is an importer that knows how to read the original (legacy) *.wiki files.Invoking the Legacy ImporterFrom the Library panel, select 'Import Book' from the 'Library' menuSet the 'Book type' to 'Legacy wiki (*.wiki)'Navigate to your palm.wiki file.Select the wiki file, and press 'Open'For more information, refer to Importing from Legacy formatNavigator00This will toggle the Navigator Panel. The Navigator Panel is described in more detail in section Navigator PanelWhat would I use Note Studio for00Storing InformationEvery day, an enormous amount of information is lost because it wasn't written down, or it was written down somewhere but was later lost.There are many systems we use to store information - some more reliable than others. Scraps of paper, notebooks, sticky notes, our memories, other people's memories - these are some of the less reliable methods.With computers, everything should become much easier. Large amounts of memory should mean no information is ever lost again. But it doesn't tend to work that way.In the officeWhen you work on a particular project, you accumulate special knowledge in that area. What if, on every project, on every business trip, you could compiled an electronic notebok, and make it available your colleagues? That information could become part of your company's knowledge.In the homeIf someone tells you they know a good plumber - where do you store information like that? Do you run to your computer, launch your word processor, and make a note? Probably not. If you're like most people, you'll either write it on a scap of paper, only to lose it later, or you'll make a mental note, then try not to forget.Either way, when the time comes (maybe years later) when you could use that fact, it may not be readily available.Note Studio provides a permanent repository for storing information like this. Combined with the Palm companion, you can literally make notes any time, any place, and have them end up on your computer. You'll find yourself actually making note of, and subsequently using, much more information.Ideation / BrainstormingNote Studio is an excellent tool for working on ideas.By creating new pages and linking to them, you may explore different avenues, pursue tangents, make notes about related topics, then return to the central idea to keep working on it.Note Studio allows you to work the way you think. Pages can be created and linked together much more flexibly than traditional books.ResearchNote Studio is a powerful tool for doing research - especially using the internet.Make notes, and comments about what you discover. Paste in the address of useful web sites. Paste links to other files to your computer. Open those files with a single click. Store internet and file links together on the same page, along with your personal commentary on that topic.Note Studio can collate your discoveries from diverse sources into one central notebook.Creating simple booksDid you know? This entire help file was developed as a Note Studio notebook. You will find Note Studio an excellent tool for developing simple books of information.You can reorganise pages, insert pages, and link them together as you require. This makes it perfect for developing non-linear books.Non-linear books can be things such as Procedure manuals, or Flowcharts, or questionaires, where people can choose which pages to be directed to. You can rapidly develop website prototypes using Note Studio. You can actually develop commercial websites with Note Studio, but that is a more advanced topic.This gives you just an introduction. You will continue to discover reasons to use Note Studio.Library and Notebooks00LibraryWhen you launch Note Studio, you start off in the Library. The Library is where you manage your Notebooks.The library is the main view where you can:open notebookssearch through all your notebooksrename, or change other properties of new notebooksimport and export notebooksencrypt notebooksetcNotebookA notebook is a collection of pages, where you store your notes. Usually you will want different notebooks for different topics. Each notebook can have as many pages as you like.Forums00This opens a web browser to the Note Studio forums.XML Tags00(Advanced topic)XML can be inserted directly onto pages using the XML tags.XML tags are made by placing text inside [< ... >] tags (square bracket and angle bracket).Any XML you insert inside these tags is preserved when exporting to XML. This allows you to customise Note Studio output. Why would you do this? If you were converting a notebook to some other format via XSLT, you could insert additional information onto the pages using these tags.Markup: This is a special page. I'll tell my XSLT translator that it contains an index by placing my own tags: [< <index>1</index> >] Now continue with normal text. Displayed as:This is a special page. I'll tell my XSLT translator that it contains an index by placing my own tags:1Now continue with normal text.This will then be exported as: <text>This is a special page. I'll tell my XSLT translator that it contains an index by placing my own tags: <index>1</index> Now continue with normal text. </text> Known Issues00Current list of known issues is stored at:http://www.dogmelon.com.au/ns/issuesBook Properties00This option will bring up the Book Properties Dialog.This dialog allows you to view and modify the following notebook properties.TitleThe notebook's name, which should be unique within the libraryPublisherYour name or organisation. OptionalDescriptionA brief description of the notebook. OptionalRead-onlyToggle this checkbox to make the book read-only. This can prevent the notebook from being accidentally modified.Chapter 7 - Acknowledgements00Database LibraryPortions of this application contain copyrighted (c) material of Extended Systems IncWindows LibrarywxPython was used in developing this product (http://www.wxPython.org)XML LibraryThis product includes software developed by the Apache Software Foundation (http://www.apache.org/).Copyright (c) 1999-2003 The Apache Software Foundation. All rights reserved.Email Support00This initiates an email to mailto:support@dogmeon.com.auForward00Forward will move the current noteback to the next page in the history.This is only available after you have gone back. Using Back and Forward, you can navigate through the ten most recently visited pages in this notebook.Chapter 2 - Getting Started00This chapter will help you to get started in Note Studio.It will then guide you through the process of creating a notebook, and making some simple notes.Basic ConceptsBasic ConceptsIntroduces you the the basic idea of Note Studio.Working with NotebooksWorking with NotebooksTakes you through the process of creating a book, and editing a page.Upgrading from an earlier versionUpgrading from an earlier versionProvides information needed by people who used version 1 of this product.Chapter 6 - Support00This chapter points you in a few directions if you need help with Note Studio.It also points to some locations where you can get more advanced tips on using Note Studio most effectively.Editing a Page00For this example, imagine you invest in Real Estate, and want to create a set of notes containing all the information you like to keep handy.Let's set up the front page of this book.Press the Edit button, to enter edit mode. You should see a cursor blinking. Delete whatever text is currently on the page. Then copy and paste the following text (everything between the following horizontal lines) onto the page: +Property Investment Notes This notebook contains useful details about my property investments. Press Edit again to leave edit mode. It should now look like this:Property Investment NotesThis notebook contains useful details about my property investments.Notice that the first line of the text has become a heading. The '+' at the start of the line makes that line a heading. This is an example of markup. There is much more markup, as discussed later in this help.Next, we'll create more pages.View Menu00The View menu contains the following items:SearchSearchInfoInfoSyntax Guide00This is a short-cut which opens the main help file directly to the Syntax summary Summary of Outlining SyntaxThis is a handy quick reference which you can pull up at any time quickly check markup syntax.Insert Link to Page00This option inserts a link to another page within the notebook.On selecting this option, a dialog will list all available pages within the notebook. Selecting one of these pages will cause a link to that page to be pasted onto the current page.This can be a superior way of linking pages together, especially as a notebook becomes large. Rather than trying to remember and enter the page name correctly, selecting the page from the list ensures the correct link will be made.This option is only available in Edit mode.Create Page00Selecting this option will create a new page and insert it into the current notebook.You will be prompted to enter a page name. A default page name, containing a timestamp, will be suggested, or you can povide an alternative.On creating the page, you will immediately be taken to that page, and be placed in Edit mode, able to enter text straight away.This option allows you to immediately make an entry into the current notebook, without making any decisions about what to call the page, or how to connect it. Get the data down now, organise it later.Rename Page00This option renames the current page.A dialog will prompt you for a new page name.The page name must be a legal page name, and must not already exist within the notebook.This option is particularly powerful, because as well as renaming the page, it goes through the entire notebook and renames every link pointing to that page. This makes it easy to fully rename pages.Remove Page00This option will remove the current page from the notebook.It will not remove any link that points to the removed page. You need to remove them manually.Home00This will return you to the notebook's home page.Creating a Book00Launch Note Studio, and look at the library. Let's ignore any books in there, and create a new one.From the Book Menu, select Create BookA dialog will prompt you to specify a name. You may accept the default, or enter a new name.Press OK, and the new book should appear in your library.Congratulations! You've just created a notebook.Opening a Book00Let's open the notebook you just created.Move the mouse over the name of the new notebook you created. The mouse pointer should change from an arrow to a pointing hand.Left-click the mouse. If the mouse pointer is over the notebook name, the notebook is opened.At first, there is not much to see in this notebook (after all, you've just created it). The notebook contains just one page, called 'Home Page'. You should be able to see the name of the page, just under the main toolbar.This page is not very exciting yet. Let's make some notes.Create Book00Creates a new notebook in your library.Selecting this option will bring up a dialog, prompting you for a name for the book. A default name will be suggested, but you will usually want to change this.The name of the book must meet the following rules: it must be unique, ie there is no other notebook by that name in your library it must not contain any illegal characters. Illegal characters are [ ] < > { } # * ,If you want to change the name of a book later you can do so with the Book PropertiesBook Properties DialogImport Book00Imports a notebook into your library.Selecting this option will bring up the Import Book Dialog. Select a book you wish to import, and press OK. No book with the same name should already exist in your Library.For more information on importing books, see section Importing NotebooksExport Book00Exports a book from your library, into an external format.Selecting this option will bring up the Export Book Dialog. You will be prompted to select the book you wish to export. You may only select one book at a time. Pressing OK will continue with the export.You will then be prompted to specify a filename. You may also select the file type in the dialog (XML or HTML).For more information on importing books, see section Exporting NotebooksShare Book00(Note Studio Professional only)Makes a book able to be shared by others on a network.Selecting this option will bring up the Share Book Dialog. You will be prompted to select the book you wish to share. You may only select one book at a time. Pressing OK will share the book.You will then be prompted to specify a filename. This is where the notebook will be created on the network. This becomes the file that others should import, in order to share the book.For more information on sharing books, see section Shared Books.Decrypt Book00Decrypts the contents of a notebook that was previously encrypted. Once a notebook is decrypted, it is stored in plain text, and anyone who has access to your computer or handheld will be able to read the contents of the notebook.Selecting this option will bring up the Decrypt Book Dialog. You will be prompted to select the book you wish to decrypt. You may only select one book at a time. Pressing OK will continue with the decryption process.You will then be prompted to specify a password. This must be the password you used to encrypt the book. If you enter the password correctly, the Library panel's icon will show the padlock open. This indicates that the book has been successfully decrypted.Remove Book00Removes a notebook from your library altogether.Selecting this option will bring up the Remove Book Dialog. You will be prompted to select the book you wish to remove. You may only select one book at a time. Pressing OK will remove the book from your library. There is no way to recover the book, unless you have backed it up to XML, in which case, you can re-import it.(Note Studio Professional only):If you remove a shared book, it only unlinks the shared book from your library. The file is not deleted - it remains on the shared drive. This means others still have access to the shared book. To physically remove a shared book you should first remove it from Note Studio, then delete it using your file system commands.Creating a Shared Book00(Note Studio Professional only)To make a shared book, first create it as a normal book (see Create Book). When you are ready, share the book by using the menu option Share Book.You will be prompted to specify a file location. You should choose a location that is available to others you wish to share the notebook with. This may be a shared drive, or a file server, etc. Pressing 'OK' will cause the file to be created. Book Property is modifiedThe book will have a new property set, indicating it is now a shared book. This means that this book is not stored with all your local books, in your Note Studio area. The notebook is stored in that shared location. Any changes you make to the notebook will modify that shared file.Now others can share this book by Importing a Shared BookImporting it into their library.Importing a Shared Book00(Note Studio Professional only)If someone else has created a shared notebook, you may share it by importing that book into your library.When you import a shared book, you have an extra option:maintain link to shared bookIf you maintain a link to the notebook, it means you are using that book as a shared book. Any changes you make to that book will be visible to anyone else who is sharing that book.If you do not maintain a link to the notebook, it means you are taking your own, local copy of the book. Now this book is your own private book, unrelated to the shared book you imported it from. Any changes you make in your book will not be reflected in the shared book.You may wish to take your own local copy if you do not permanently have access to that shared location.Back00Back will set the notebook to the previous page.Up to ten previous pages are stored in the history. These are restored the next time Note Studio is started.Main Panel00At any time while running Note Studio, you are either viewing the entire library, or you are viewing a particular notebook. This is known as being in Library view or being in Notebook view.The Main Panel is generally the largest window in Note Studio. Depending on which view you are in, it either displays the The LibraryLibrary view or the Note BooksNotebook view.Info Panel00NameInfo PanelLibrary or Notebook ViewLibraryThe Info Panel shows some useful properties of the current notebook. When the Info Panel is visible, you can move your mouse over different book names, and see that book's properties displayed in the Info Panel.This can is useful when you have a lot of notebooks.Recent Changes Panel00NameRecent Changes PanelLibrary or Notebook ViewNotebookThe Recent Changes Panel lists the most recently changed pages. Up to 10 pages are remembered. In the Palm version, two separate lists are maintained: Recent computer changes and Recent handheld changes.This is useful when you come back to a notebook and want to see what you were last editing.(Note Studio Professional only):With shared books, in a multi-user environment, you are able to see what pages other people have been changing recently.The Library Panel00The main library panel shows a list of all notebooks currently in your library.Each row contains five fields:Field NameDescriptionAction on ClickBook TypeDisplays the type of book. Standard: Books are always internal Professional: Books can be internal or shared.Opens the notebookBook NameThe name of the notebookOpens the notebookBook PropertiesThe book properties launcherOpens the Book PropertiesBook Properties dialogRead-onlyDisplays whether the book is writable or readonlyToggles the read-only propertyEncryptedDisplays whether the book is encryptedToggles the encrypted propertyExporting to XML00When you export to XML, a single xml file is created for your entire book. The file format of this xml file is described in section Note Studio Markup Language Definition.Importing from XML00You may wish to import from XML format for several reasons: you backed up (exported) a notebook to XML format, and now you want to restore it to your library. you have obtained an XML notebook from another source, and wish to import it into your library.The xml file is expected to be a valid Note Studio markup file according to: Note Studio Markup Language Definition. If it is not, the file will not be loaded.If your library already contains a notebook by that name, the new notebook will not be added. You may need to rename an existing book in your library to import another book by the same name.About this Help00This is the main help file for Note Studio. The book is arranged in the following chapters:Chapter 2 - Getting StartedChapter 2: Getting StartedThis will introduce you through the basic concepts behind Note Studio. It will guide you through the process of creating a simple notebook.It will also provide information for people upgrading from version 1 of this product.Chapter 3 - Using Note StudioChapter 3: Using Note StudioThis is the main reference for Note Studio. It describes the interface in more detail, and how to work with the library and notebooks in much more detail.Chapter 4 - Managing your NotesChapter 4: Managing your NotesDescribes how to import and export notebooks from Note Studio. Also, how you can share these notebooks with others.Chapter 5 - Extending Note StudioChapter 5: Extending Note StudioContains a description of the Note Studio xml format, as well as an introduction to plugins and hooks.Chapter 6 - SupportChapter 6: SupportHow to get more out of Note Studio by using resources on the web.Chapter 7 - AcknowledgementsChapter 7: AcknowledgementsLibrary View Toolbar00Here is a summary of Toolbar buttons visible while in Library View:ButtonDescriptionSearchsee section SearchInfosee section InfoNotebook View Toolbar00Here is a summary of Toolbar buttons visible while in Notebook View:ButtonDescriptionBacksee section BackForwardsee section ForwardHomesee section HomeEditsee section Edit PageNewsee section Create PageNavigatorsee section NavigatorSearchsee section Search (Notebook View)Changessee section Recent ChangesLibrarysee section LibraryTour00This shows the Tour. The tour is a friendly guide which provides an introduction to Note Studio.Side Panels00Side Panels are shown to the left of the main panel.There are different side panels for different purposes. You can show or hide side panels whenever you like. Note Studio comes with the following side panels: Info PanelInfo Navigator PanelNavigator Search PanelSearch Recent Changes PanelRecent ChangesSide panels can be toggled on or off using either the Menumenu or the Toolbartoolbar.When activated, side panels are restored to their previous size. Side panels can be deactivated in two ways: turning the active panel off. This means no side panels are visible turning another side panel on. This will replace the current side panel.Contents00This option shows the main help file.Note Books00When you open a notebook, Note Studio goes into Notebook View.This is the view you will spend most of your time in. You can read and edit your notebooks from here.This section describes how to use notebooks in further detail.Italic00Italic text is made by placing text between '=' characters. Only a single line can be made italic at a time, ie if the text between the '=' characters contains a new-line, that text will not be made italic.Markup:this =text= is italicDisplayed as:this text is italicPRE Tags00PRE tags are made by placing text inside [| ... |] tags (square bracket and vertical pipe character).The pre tag is equivalent to the HTML pre tag. Text is left alone, and is shown in a fixed width font with the whitespace preserved.Markup:[| {4 spaces}for i in range(10): {8 spaces}print i |]Displayed as: for i in range(10): print i Headings00Headings are made by placing one or more '+' characters at the start of a line.There are four levels of heading available.Markup:+heading 1 some normal text ++heading 2 some normal text +++heading 3 some normal text ++++heading 4 some normal textDisplayed as:heading 1some normal textheading 2some normal textheading 3some normal textheading 4some normal textBullet Lists00Bullet lists are made by placing one or more '-' characters at the start of the line.Each additional '-' character results in an extra level of indentation. This means bullet lists can be nested.Markup:-item 1 -item 2 --item 2a ---item 2a(i) ---item 2a(ii) --item 2b -item 3Displayed as:item 1item 2item 2aitem 2a(i)item 2a(ii)item 2bitem 3Number Lists00Number lists are made by placing one or more '#' characters at the start of the line.Each additional '#' character results in an extra level of indentation. This means number lists can be nested.Markup:#item #item ##sub-item ###sub-sub-item ###sub-sub-item ##sub-item #itemDisplayed as:itemitemsub-itemsub-sub-itemsub-sub-itemsub-itemitemHorizontal Lines00Horizontal lines are made by placing three '_' (underscore) characters at the start of a line.The line must contain no other text. Markup:text above the line ___ text below the lineDisplayed as:text above the linetext below the linePage Links00Page links are made by placing a page name inside square brackets.If the contents of the square brackets is not a valid page name, no link is made.Markup:here is a link to a [new page]Displayed as:here is a link to a Page Linksnew pageChapter 4 - Managing your Notes00This chapter gives you some more information on how you can use Note Studio to manage your note books. This includes:Exporting NotebooksExporting books to other formatsImporting NotebooksImporting books from other formatsShared BooksSharing books in a networked environmentAbout Hooks00(Note Studio Professional only)Hooks are like plugins, except that they are automatically triggered by certain events.Purpose of HooksHooks allow automation of certain operations. Possible uses for hooks would be: launch a backup procedure automatically export a notebook to the web automatically import data from an external source send an emailand so on...Hook EventsEvents that trigger a hook are:eventhook script triggeredDescriptionpreOpenhook_preOpen.pyWhen Note Studio launched, this event occurs just before the library file is readpostOpenhook_postOpen.pyWhen Note Studio launched, this event occurs just after the library file is readpreWritehook_preWrite.pyWhen a change is made to a notebook, this event occurs just before the change is written.postWritehook_postWrite.pyWhen a change is made to a notebook, this event occurs just after the change is written.Developing Hook scriptsDeveloping hook scripts is largely the same as developing a plugin. Interested developers can contact mailto:support@dogmelon.com.ausupport for more information.Page Size Limitations00Currently an individual page may not contain more than 32000 characters.For encrypted pages (or books), the limit is 16000.Frequently Asked Questions00The list of Frequently Asked Questions is constantly updated.It is located at:http://www.dogmelon.com.au/ns/faqCreating More Content00Let's add some more content to the book. We are not going to flesh out the entire book - just enough to give you the idea.On the Tradespeople page, enter Edit mode, and enter the following text. [Termite Inspectors] [Plumbers] [Carpenters] Leave Edit mode, and you should now see:Creating More ContentTermite InspectorsCreating More ContentPlumbersCreating More ContentCarpentersLet's say you have made some notes about the plumbers you know:Select the Plumbers link, and then paste the following notes (remember to go into Edit mode): +Robin & Son *(don't use next time!)* 555-801 4432 07/03/2001 Fixed tap in #3 Wide St. Cost $220. 10/08/2002 Fixed broken shower head in Smith St Said would come at 10am. Showed up at 2pm. Cost $350 +Fixit Plumbers 555-806 7531 recommended by Dean. They fixed his broken pipe. Said they were cheap and very professional. Ask for Terry. Mention that you know Dean. Leave Edit mode, and it should look as follows:Robin & Son(don't use next time!)555-801 443207/03/2001Fixed tap in #3 Wide St.Cost $220.10/08/2002Fixed broken shower head in Smith StSaid would come at 10am. Showed up at 2pm.Cost $350Fixit Plumbers555-806 7531recommended by Dean. They fixed his broken pipe. Said they were cheap and very professional.Ask for Terry. Mention that you know Dean.This is only a brief sample, but you are probably getting the idea. This book is building up information that will be useful later. Continuing to fill in information over the following months would produce a very useful notebook.Exit00This will shut down Note Studio.About00This shows the About Box for Note Studio.This is where you can see the version of your Note Studio.Cut00This will remove the currently selected text from the page, and copy that text to the clipboard. This text can later be pasted onto a page.Undo Text00Undoes the last typing done on the current page.Note that there is only one level of undo available.This option is only available in Edit mode.The Note Studio Interface00Note Studio interface has the following major components:Main PanelMain PanelSide PanelsSide Panels (optional)ToolbarToolbarMenuMenuStatus BarStatus BarTools Menu00The Tools menu contains the following items:PluginsPluginsHelp Menu00The Help menu contains the following items:ContentsContentsSyntax GuideSyntax GuideTourTourForumsForumsEmail SupportEmail SupportAboutAboutEdit Menu00The Edit menu contains the following items:Edit PageEdit PageCutCutCopyCopyPastePasteUndo TextUndo TextSelect AllSelect AllMake Page From SelectionMake Page from SelectionInsert sub-menuInsert sub-menuInsert Link to PageInsert Link to PageContents of FileInsert Contents of FileTimestampInsert TimestampBook PropertiesBook PropertiesNavigate Menu00The Navigate menu contains the following items:BackBackForwardForwardHomeHomeGo to PageGo to PageMenu Description00This section describes the items on the menu when in Library view.Library view contains the following menus:File MenuFileBook MenuBookView MenuViewTools MenuToolsHelp MenuHelpStatus Bar00The status bar is at the bottom, beneath the main panel. Contents of the status bar change depending on whether you are Library view or Notebook view.Status bar in Library viewThe status bar in Library view is currently empty.Status bar in Notebook viewThe status bar in Notebook view contains the following fields (left-to-right)NamePossible ValuesDescriptionLink name{any}When you hold your mouse over a link, the actual link contents are shown here. This means that, even if the link has a friendly name, you can see what it actually points to by looking at the status bar.Encrypted{blank}, ENCRYPTEDShows whether this page (or book) is encryptedRead-only{blank}, READ-ONLYShows whether this page is read-onlyEdit ModeEDIT, VIEWShows whether you are in Edit or View mode.Working with Notebooks00Here we will give an example. By following this example, you will learn how to:Creating a BookCreate a BookOpening a BookOpen a BookEditing a PageEdit a PageCreating a New PageCreate a New PageCreating More ContentCreate More ContentMoving around in Note StudioMove around in Note StudioReturning to the LibraryReturn to the LibraryLet's begin.Markup changes00There are many markup additions in the new Note Studio. You can now do bold, italic, headings, among other things. For a full list of markup syntax, see Summary of Outlining Syntax.But there are also some changes to version 1 markup syntax.1. Bullet pointsIn version 1, the '*' (asterix) character represented a bullet point.As of version 2.0, the '-' (dash) character represents a bullet point.ExampleIn version 1, you would do a bullet list as:*bullet item*bullet item**indented bullet itemAs of version 1, you would do a bullet list as:-bullet item -bullet item --indented bullet itemRationale: the '' character is now used to mark up bold text.2. WikiWord syntax is de-activated.In version 1, you made links by typing wiki words. These included at least two capital letters (also known as CamelCase).For example, JohnSmith, or MyDog, were wiki words.As of version 2.0, links can be made using the new, square bracket syntax. You can keep your old wiki words by changing them to [JohnSmith] and [MyDog]. As a result, the old link syntax is no longer required.Rationale: there were problems with the original CamelCase solution. Many valid words or symbols were detected as wiki words: for example, NaCl for the chemical symbol salt. Also, people tended to mangle words to force them to be wiki words.We considered keeping version 1 wiki words, but feel it will be ultimately neater to make a clean break and stop recognising them altogether.Plugins00Allows you to select and run a plugin from the plugins directory.Plugins are described more in section About PluginsExporting Notebooks00Note Studio can be exported to two formats:Exporting to HTMLHtmlExporting to XMLXmlImporting Notebooks00There are two formats you can import from:Importing from XMLXML formatImporting from Legacy formatLegacy formatRecent Changes00This will toggle the Recent Changes Panel. The Recent Changes Panel is described in more detail in section Recent Changes PanelAbout Plugins00Note Studio has a plugin architecture, allowing even more powerful tools to be developed.This section describes plugins from a user point of view. For developers interested in writing plugins, contact mailto:support@dogmelon.com.ausupport for more information.Plugin file formatPlugins may be be supplied in one of the following formats*.pyc*.py*.pydInstalled plugins.Currently only one plugin is supplied with Note StudioNameDescriptionBackupBacks up your Note Studio library to an xml fileFuture pluginsCheck the Note Studio website for more plugins in the future.Bold00Bold text is made by placing text between '*' characters. Only a single line can be made bold at a time, ie if the text between the '*' characters contains a new-line, that text will not be made bold.Markup:this *text* is boldDisplayed as:this text is boldImporting from Legacy format00This format is only for people who used version 1 of Note Studio, when it was called Wiki World or Wiki Studio. This is a way for them to import their old files into Note Studio format.Version 1 did not have a concept of notebooks, or Notebook name. When you import a legacy book, its filename will be used for the notebook name. If your library already contains a notebook by that name, the new notebook will not be added. You may need to rename an existing book in your library to import another book by the same name.Automatically Modifying on ImportMarkup syntax has changed since version 1. It would be a pain to go back through your legacy book converting markup. The importer knows how to make the required changes to markup text, to work in Note Studio 2.0.As text comes in, two conversions take place:Links that were originally Camel Case have square brackets placed around them, to ensure that they remain links.'*' Bullet points are replaced with '-' bullet pointsThere is one limitation to this:Encrypted pages cannot be automatically decrypted, so are left untouched. As a result, bullet points and links that you had on encrypted pages will need to be manually converted.Note:Importing a legacy file is a one-off operation. The legacy file is not affected in any way. Changes you make in Note Studio will not be written back to that legacy file.Contacting Support00Note Studio main web page:http://www.dogmelon.com.au/nsNote Studio support web page:http://www.dogmelon.com.au/ns/supportemail:support@dogmelon.com.auphone: +61-8-9284 0313post:144 Harborne StWembleyWA 6014AustraliaHomePage00NoteStudioNote Studio Helpversion 2.0(c) Dogmelon Pty Ltd 2001-2003Chapter 1 - IntroductionWhat would I use Note Studio forWhy Note StudioAbout this HelpChapter 2 - Getting StartedBasic ConceptsLibrary and NotebooksMarkupEdit-ViewWorking with NotebooksCreating a BookOpening a BookEditing a PageCreating a New PageCreating More ContentMoving around in Note StudioReturning to the LibraryUpgrading from an earlier versionMarkup changesImporting Your Old DataChapter 3 - Using Note StudioThe Note Studio InterfaceMain PanelSide PanelsInfo PanelNavigator PanelSearch PanelRecent Changes PanelToolbarLibrary View ToolbarNotebook View ToolbarMenuStatus BarThe LibraryThe Library PanelMenu DescriptionFile MenuExitBook MenuCreate BookImport BookExport BookShare BookEncrypt BookDecrypt BookRemove BookView MenuSearchInfoTools MenuPluginsHelp MenuContentsSyntax GuideTourForumsEmail SupportAboutNote BooksNotebook SyntaxItalicBoldHeadingsBullet ListsNumber ListsHorizontal LinesTablesPage LinksSpecial LinksFriendly NamesPRE TagsNOP TagsXML TagsSummary of Outlining SyntaxEncryptionPage Size LimitationsMenu Description (Notebook View)Menu DescriptionFile Menu (Notebook View)File MenuLibraryPrint PageExport Book (Notebook View)Export BookExit (Notebook View)ExitEdit MenuEdit PageCutCopyPasteUndo TextSelect AllMake Page From SelectionInsert sub-menuInsert Link to PageContents of FileTimestampBook PropertiesPage MenuCreate PageRename PageEncrypt PageRemove PageNavigate MenuBackForwardHomeGo to PageView Menu (Notebook View)View MenuNavigatorSearch (Notebook View)SearchRecent ChangesChange FontTools Menu (Notebook View)Tools MenuHelp Menu (Notebook View)Help MenuChapter 4 - Managing your NotesExporting NotebooksExporting to HTMLExporting to XMLImporting NotebooksImporting from XMLImporting from Legacy formatShared BooksCreating a Shared BookImporting a Shared BookUsing Shared BooksChapter 5 - Extending Note StudioNote Studio Markup Language DefinitionRoot Format DefinitionNotebook DefinitionPage DefinitionText Format DefinitionAbout PluginsAbout HooksChapter 6 - SupportNote Studio WebsiteContacting SupportFrequently Asked QuestionsRelease NotesKnown IssuesChapter 7 - AcknowledgementsBook Menu00The Book menu contains the following items:Create BookCreate BookImport BookImport BookExport BookExport BookShare BookShare BookEncrypt BookEncrypt BookDecrypt BookDecrypt BookRemove BookRemove BookPrint Page00This will print the current page.Edit Page00Toggles the edit mode between Edit mode and View mode. For more details on Edit and View mode, see section Edit-ViewThis option will not be available if the book has been set to read-only.Paste00Pastes the text from the clipboard into the currently selected position on the page.This option is only available in Edit mode.Contents of File00Pastes the contents of a file onto the current page.On selecting this option, a dialog will prompt you to select a file. On selecting a file, the contents of that file will be pasted onto the page.This option is only available in Edit mode.Encrypt Page00This option will toggle the encryption setting on the current page.Note:It is very important that you remember your password. There is no way to decrypt a book if you lose or forget the password.Encryption is better described better in Encryption.Go to Page00This option provides an easy way to quickly jump to another page. A dialog will show all the page names in the current notebook. Selecting one will set the notebook to that page.Search00Toggles the Search panel. Searching is described in section Search Panel.Returning to the Library00So, now you know how to create a notebook, edit it, and move around in it. This gives you the basics you need to start making notes.There's one more thing though - we've only looked at one notebook. You will probably want to set up others. This means you need to return to the Library.Remember, the Library is where you can see all of your notebooks, and decide which one to open.To return to the library from a notebook, push the 'Library' button on the main toolbar. This closes your current notebook, and returns you to the library view.Congratulations, you now know the basics required to use Note Studio.The Library00The Library is the main view from which you can manage your notebooks.From here you can see all of your notebooks at the same time. You can perform operations which affect the entire library, such as adding books, removing books, or renaming books.You can also perform operations across your entire library. For example, in Library view you can search your entire library for specific text.Library00This will cause Note Studio to leave Notebook view and return to Library view.Exit (Notebook View)00This will exit the application.Export Book (Notebook View)00This option wll export the current book. For more details on exporting, see section Exporting NotebooksFile Menu (Notebook View)00The File menu contains the following items:LibraryLibraryPrint PagePrint PageExport Book (Notebook View)Export BookExit (Notebook View)ExitHelp Menu (Notebook View)00The Help menu is identical the help menu in Library view. See section Help Menu.Menu Description (Notebook View)00This section describes the items on the menu when in Notebook view.Notebook view contains the following menus:File Menu (Notebook View)FileEdit MenuEditPage MenuPageNavigate MenuNavigateView Menu (Notebook View)ViewTools Menu (Notebook View)ToolsHelp Menu (Notebook View)HelpSearch (Notebook View)00This will toggle the Search Panel. The Search Panel is described in more detail in section Search PanelTools Menu (Notebook View)00The Tools menu is identical the tools menu in Library view. See section Tools Menu.View Menu (Notebook View)00The View menu contains the following items:NavigatorNavigatorSearch (Notebook View)SearchRecent ChangesRecent ChangesChange FontChange FontEncrypt Book00Encrypts the contents of an entire notebook. Once a notebook is encrypted, nobody can read the contents of that notebook without entering a password.Selecting this option will bring up the Encrypt Book Dialog. You will be prompted to select the book you wish to encrypt. You may only select one book at a time. Pressing OK will continue with the encryption process.You will then be prompted to specify a password. You must enter this password twice, to confirm. This password will then be used to encrypt the contents of the notebook.On the Library panel, the icon of a padlock will show the padlock closed. This indicates that the book has successfully been encrypted.Encryption is better described better in Encryption.Navigator Panel00NameNavigator PanelLibrary or Notebook ViewNotebookThe Navigator Panel shows a list of all pages within the current book. Pages are listed in alphabetical order.Left-clicking on a page name will cause the main panel to display that page.Right-clicking on a page name will bring up a context menu allowing you to perform operations on the current page.Search Panel00NameSearch PanelLibrary or Notebook ViewBoth Library and NotebookThe Search Panel is used to perform a text search over one or all of your notebooks.In Library view, searching will search all books in your library.In Notebook view, searching will search only the current notebook.To perform a search, type the text you are searching for into the box, and press the Search button. Note Studio will now search for the text. A list of pages containing the text will be shown underneath the search box.Clicking on any of these pages will open the notebook to that page.Search Panel searches 'Raw Text'Search looks through the text before it is marked up. This means it may find text which is not actually visible when you are looking at a pageExample:Consider the following text:Here is a link: [[actual page name] friendly name] When viewed, it looks like:Here is a link: Search Panelfriendly nameIf you were to search for the word 'actual', you would find it on this page, even though you cannot usually see the word 'actual'.Exporting to HTML00Exporting a notebook to HTML means that notebook can then be viewed by a web browser. This makes HTML versions of a notebook ideal for websites.When you export to html, each page is saved as a separate file. Filenames will approximately correspond to page names, with some exceptions. Note Studio is much more flexible about what you name a page than some file systems, so page names may be changed to ensure they will work on the underlying file system.As well as exporting an HTML file for each notebook page, Note Studio exports a stylesheet: NoteStudio.css. This file styles how your text will be displayed.If you are familier with stylesheets, you may be able to change the stylesheet.Select All00Selects all of the text on the current page.This option is only available in Edit mode.Note Studio Markup Language Definition00In future a proper schema file will be developed to describe Note Studio markup language.For now, the format is described in this section.The format definition is broken up according to the following:Root(contains) Notebook(contains) Page(s)(contains) TextRoot Format DefinitionRoot DefinitionNotebook DefinitionNotebook DefinitionPage DefinitionPage DefinitionText Format DefinitionText DefinitionRoot Format Definition00Namespace: All tags are by default placed in the namespace: xmlns="http://www.dogmelon.com.au/ns Here is the outer structure, used to 'wrap' a notebook. <note_studio_markup_root> <version>2.0</version> <notebook> ... </notebook> </note_studio_markup_root> note_studio_xmlthe outermost root elementversionthe version of Note Studio that created this XML file. Or, if importing, tells the loader which version of the xml file to expect. notebookcontains a notebook. An xml file may contain multiple notebooks.Notebook Definition00 <notebook> <display_name>...</display_name> <home_page>...</home_page> <current_page>...</current_page> <history_page00>...</history_page00> <description>...</description> <publisher>...</publisher> <readonly>...</readonly> <date>...</date> <page> ... </page> <page> ... </page> ... <page> ... </page> </notebook> display_nameThe name of the book, as listed in the Library panelhome_pageThe name of the book's homepagecurrent_pageThe currently selected pagehistory_page00The previously selected pages. =NB there are 10 levels of history available: history_page00 .. history_page09descriptionA description of the contents of the notebookpublisherThe entity which developed the notebookreadonly0 if the book is writable. 1 if the book is readonlydateA number of the format YYYYMMDD, indicating when the notebook was createdpagecontains the description of an individual page.Text Format Definition00Text on a page is not stored in Note Studio markup syntax. It is much more like a standard html format. <text> ...<bold>...</bold> ... ...<italic>...</italic> ... ...<heading1>...</heading1> ... ...<heading2>...</heading2> ... ...<heading3>...</heading3> ... ...<heading4>...</heading4> ... <bullet_list> <bullet>...</bullet> </bullet_list> <number_list> <number>...</number> </number_list> ...<horizontal_line / ... ...<br /> ... <table> <tr> <td>...</td> <td>...</td> .... <td>...</td> </tr> <tr> <td>...</td> <td>...</td> .... <td>...</td> </tr> .... <tr> <td>...</td> <td>...</td> .... <td>...</td> </tr> </table> ... <link> <value>...</value> </link> ... <url> <value>...</value> </url> ... <email> <value>...</value> </email> ... <file> <value>...</value> </file> ... <link> <value>...</value> <friendly_name>...</friendly_name> </link> ... <url> <value>...</value> <friendly_name>...</friendly_name> </url> ... <email> <value>...</value> <friendly_name>...</friendly_name> </email> ... <file> <value>...</value> <friendly_name>...</friendly_name> </file> ... ...<nop>...</nop> ...<pre>...</pre> ...<xml>...</xml> ... </text> boldtext is marked bolditalictext is marked italicheading1text is a heading 1heading2text is a heading 2heading3text is a heading 3heading4text is a heading 4bullet_listcontains a bullet listbulletcontains a single bullet itemnumber_listcontains a number listnumbercontains a single number itemhorizontal_lineshould not contain anything. Marks a horizontal line in the text.brshould not contain anything. Marks an end-of-line character in the text.tablecontains a tabletrcontains a row of a tabletdcontains an element in a table rowlinkcontains link to another pageurlcontains link to a url, eg http://www.dogmelon.com.auemailcontains link to an email addressfilecontains link to a file namevaluethe actual value of the link (page name, filename, email address, url)friendly_namecontains the friendly name of the link. This is what gets displayed on the page.Page Definition00 <page> <page_name>...</page_name> <encrypted>...</encrypted> <cursor_pos>...</cursor_pos> <text>...</text> </page> page_namethe name of the pageencrypted1 if the page is encrypted, 0 otherwisecursor_posthe index of the last cursor position (not used in 2.0)textcontains the page's text. NB: Under this node, white-space is important. In particular, this node should not be pretty-printedMoving around in Note Studio00Now, we could continue to make notes in this notebook. But let's learn some other useful ways of moving around.Home, Back and Forward buttonsOn your main toolbar, you will see three useful buttons: 'Home', 'Fwd', 'Back'. These buttons might be familiar if you have ever browsed the internet.You will often want to return to the front page of your notebook. Pressing 'Home' returns you to that page.The 'Back' button allows you to go to the last page you visited. This lets you retrace your steps through the notepad.The 'Fwd' button is exactly the opposite. After you have stepped back through your visited pages, you can step forward again.Info00Toggles the Info panel. The info panel is described in section Info Panel.Why Note Studio00Why would you use Note Studio as the method of storing your notes?Good mix of power and simplicity:When you're writing quick notes, you don't want to be messing around. Setting font size, tab stops, font face or colour, page breaks, is more than you need. You just want to get the information down.Yet, it's nice to have some formatting. A big text file can be hard to read, unless it contains headings, bullet points, bold/italic, and other markup you're used to.Note Studio provides the right mix of quick, easy editing, with powerful text markup.One Central LocationYour information may be in a lot of different places, in different file formats: word documents, text files, intranet pages, etc...Note Studio brings all your notes together, in one easy-to-manage location. Copy pages from book to book. Add pages, delete pages, rename pages. All your notes are at your fingertips, and can be organised however you like.Easy to See, Easy to ShareNote Studio will allow you to access all your notes whenever you want. But sometimes this may not be enough. You will need to show your notes to others, or make them available in other formats.Note Studio allows this. Your notes are not 'stuck' in Note Studio. They can be exported to HTML. This can allow notebooks to be shared on the internet, or on a corporate intranet. They can be exported to XML, then converted into practically any other format.Anywhere, Anytime... Note Studio is future-proofUntil you say otherwise, your notes should be available for life. As hardware and software evolve, Note Studio will be there. Already you can access Note Studio on desktop or laptop PCs. You can transfer these notes onto Palm devices, including Palm-based mobile phones. In future Note Studio will be made available on other important platforms. No matter what hardware you choose, you will have access to your notes.Chapter 3 - Using Note Studio00This chapter will explain in depth how to use various parts of Note Studio. It is broken into three sections:The Note Studio InterfaceThe Note Studio InterfaceThe LibraryThe LibraryNote BooksNotebooksChapter 5 - Extending Note Studio00There are a few different ways of getting more out of Note Studio.XML toolsBecause note books can be exported to XML, these books can then be translated to or from other formats using XML tools such as XSLT. This is far beyond the scope of this help. However, the full specification for the Note Studio XML file format is provided Note Studio Markup Language Definitionhere.About PluginsPluginsAbout HooksHooksMarkup00Some text you enter onto a page has special meanings. This means you can control the way your notes look by typing some extra characters. This special text is called markup.For example, you can make text bold by enclosing it in asterisk characters, such as: *bold*.You can only see markup characters while you are editing your notes. When you are viewing your notes, you cannot see the markup. Instead you see the text properly formatted according to the markup you have used.Toolbar00The toolbar is located between the top menu and the main/side panels. It has different buttons depending on whether you are in Library View or Book ViewLibrary View ToolbarLibrary ViewNotebook View ToolbarNotebook ViewBasic Concepts00This section describes a few of the things you need to know, to start using Note Studio effectively. Library and NotebooksLibrary and Notebooks describes how your notebooks are stored in a library. MarkupMarkup describes how some text has special meaning, allowing you to format your text. Edit-ViewEdit-View describes how to edit and view your notebooks.Friendly Names00Links (both page links and special links) can be given friendly names, to be easier to read. There are two alternate formats:[[actual name] [friendly name]][[actual name] friendly name]Markup: -Notes of [[Meeting Notes 6/5/2003] [meeting]] -[[http://www.dogmelon.com.au] Dogmelon Website] -[[mailto:support@dogmelon.com.au] email support] -[[file://///really/long/path/to/a/file/called/readme.txt] readme file] Displayed as:Notes of Meeting Notes 6/5/2003meetinghttp://www.dogmelon.com.auDogmelon Websitemailto:support@dogmelon.com.auemail supportfile://///really/long/path/to/a/file/called/readme.txtreadme fileNOP Tags00NOP tags are made by placing text inside [{ ... }] tags (square bracket and curly brace characters).NOP tags prevent Note Studio from marking up text. This can be necessary, for example, if you are pasting text from another source. If that text contains square brackets, it forms a link, unless you prevent it.Pasted Text (including unwanted link): If you want to make peace with your enemy, you have to work with your enemy. Then he becomes your partner. [Nelson Mandela] Displayed as:If you want to make peace with your enemy,you have to work with your enemy.Then he becomes your partner.NOP TagsNelson MandelaAdd NOP tags to prevent unwanted link:[{ If you want to make peace with your enemy, you have to work with your enemy. Then he becomes your partner. [Nelson Mandela]}]Now displayed as: If you want to make peace with your enemy, you have to work with your enemy. Then he becomes your partner. [Nelson Mandela] Tables00Tables provide a way of laying out data neatly into rows and columns. Tables can be made by using 'tab' characters to mark column boundaries.The presence of a tab in a line of text implies that this line is part of a table. The number of columns in a table is equal to the number of tabs plus 1 By making consecutive rows of text containing tabs, you can have multiple rows in your tables.Markup: *row 1, col 1* *row1, col2,* *row1, col3* row 2, col 1 row2, col2, row2, col3 row 3, col 1 row3, col2, row3, col3 Displayed as:row 1, col 1row1, col2,row1, col3row 2, col 1row2, col2,row2, col3row 3, col 1row3, col2,row3, col3Special Links00Special links are formed by text that is recognised to have special meaning.Some examples of this include: urls file links mail linksSquare brackets around such links is optional:Markup: Dogmelon website http://www.dogmelon.com.au email support mailto:support@dogmelon.com.au remote file link file:///\\server\shared\readme.txt remote file link file://///server/shared/readme.txt =alternate, fwd slash syntax= local file link file:///C:\readme.txt local file link file:///C:\readme.txt =alternate, fwd slash syntax= Displayed as:Dogmelon websitehttp://www.dogmelon.com.auemail supportmailto:support@dogmelon.com.auremote file linkfile:///\\server\shared\readme.txtremote file linkfile://///server/shared/readme.txt alternate, fwd slash syntaxlocal file linkfile:///C:\readme.txtlocal file linkfile:///C:\readme.txt alternate, fwd slash syntaxShared Books00(Note Studio Professional only)Shared books are books which are stored somewhere on a computer network. They can be shared by Note Studio users on the network.Multiple users may edit the contents of the same notebook. This is ideal, for example, in a corporate environment where notebooks are shared by an entire department. Note Studio provides the necessary file locking to allow multiple people to simultaneously read and edit the same notebook at the same time.Using Shared Books00(Note Studio Professional only)You use a shared book just like you would use your personal, local books. The only difference is, Note Studio is doing some things behind the scenes. This is to do with locking pages, so that no two people edit the same page, at the same time. This may lead to some interesting effects:ExampleYou are viewing a page, and decide to modify that page. When you press 'Edit', the page contents may change. This is because, since you visited the page, someone else has modified that page. When you come to editing that page, you will suddenly see the other person's changes.Obtaining a page lockWhen you enter edit mode, an edit-lock will be set on that page. This locks other users out - they can still view the page, but not edit it. If another user tries to edit the page while you are editing it, they will get an error message: "page is being edited". They can retry until you finish editing the page (releasing the page lock), or cancel, and continue doing other things.Release Notes006.3.1 Release Notes for 2.0version 2.0Change Font00This will bring up the Font dialog. This allows you to change the fonts used to view Note Studio notebooks.Creating a New Page00Now it is time to create a link to another page. This is done by placing a new page name inside square brackets. Edit the page you are working on, so it looks like this: +Property Investment Notes This notebook contains useful details about my property investments. - [Interesting Properties] - [Real Estate Agents] - [Solicitor] - [Mortgage Broker] - [Tradespeople] Leave edit mode. It should now look like this:Property Investment NotesThis notebook contains useful details about my property investments. Creating a New PageInteresting Properties Creating a New PageReal Estate Agents Creating a New PageSolicitor Creating a New PageMortgage Broker Creating a New PageTradespeopleThe page names inside the square brackets have become links. They link to new pages. When you move your mouse over these links, the cursor will change. Clicking on a link will go to the page with that name. If the page does not exist, it will be created. This is how you can make new pages.Click on the Tradespeople link. This will take you to a new page, called Tradespeople. Yo