Skip to content

Commit

Permalink
Split libraries and release history in separate files
Browse files Browse the repository at this point in the history
  • Loading branch information
@ffes
ffes committed Jul 19, 2015
1 parent e1d843b commit b94fe3c
Show file tree
Hide file tree
Showing 3 changed files with 217 additions and 210 deletions.
214 changes: 4 additions & 210 deletions __Docs/ReadMe.xml
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY sect1_libraries SYSTEM "libraries.xml">
<!ENTITY sect1_history SYSTEM "history.xml">
<!ENTITY app_lic SYSTEM "gpl-2.0.xml">
<!ENTITY app_tabdef SYSTEM "tabledef.xml">
]>
Expand Down Expand Up @@ -56,88 +58,7 @@
<para>All the snippets are stored in one <ulink url="http://www.sqlite.org/">SQLite</ulink> database. SQLite is fast and easy to use. With SQLite most of the file and storage handling is taken care of. This is much more efficient then designing my own (complex) file format and implementing a parser and a writer, although I understand that editing a SQLite database is not as easy to edit for some as editing plain text files. But there is a user interface for editing the snippets.</para>
</sect1>

<sect1 id="libraries">
<title>Provided Snippets Libraries</title>
<para>At this moment the template database is filled with these libraries. If you upgrade from a previous version your databases is not changed. If you want to try any of the new libraries, you must manually import those libraries from the template database.</para>
<informaltable>
<tgroup cols="3">
<thead>
<row>
<entry><para>Library Name</para></entry>
<entry><para>Languages</para></entry>
<entry><para>By</para></entry>
</row>
</thead>
<tbody>
<row>
<entry><para>ANSI Characters</para></entry>
<entry><para>All</para></entry>
<entry><para>FFes</para></entry>
</row>
<row>
<entry><para>Templates</para></entry>
<entry><para>All</para></entry>
<entry><para>FFes</para></entry>
</row>
<row>
<entry><para>HTML Tags</para></entry>
<entry><para>HTML, PHP, ASP</para></entry>
<entry><para>FFes</para></entry>
</row>
<row>
<entry><para>HTML Characters</para></entry>
<entry><para>HTML, PHP, ASP</para></entry>
<entry><para>FFes</para></entry>
</row>
<row>
<entry><para>Greek Characters</para></entry>
<entry><para>HTML, PHP, ASP</para></entry>
<entry><para>FFes</para></entry>
</row>
<row>
<entry><para>W3C Doctypes</para></entry>
<entry><para>HTML</para></entry>
<entry><para>FFes</para></entry>
</row>
<row>
<entry><para>CSS2 Tags</para></entry>
<entry><para>CSS, HTML</para></entry>
<entry><para>FFes</para></entry>
</row>
<row>
<entry><para>CSS2 Tags &amp; Values</para></entry>
<entry><para>CSS, HTML</para></entry>
<entry><para>FFes</para></entry>
</row>
<row>
<entry><para>JavaScript - Basic</para></entry>
<entry><para>JavaScript, HTML</para></entry>
<entry><para>FFes</para></entry>
</row>
<row>
<entry><para>JavaScript - Date</para></entry>
<entry><para>JavaScript, HTML</para></entry>
<entry><para>FFes</para></entry>
</row>
<row>
<entry><para>JavaScript - Math</para></entry>
<entry><para>JavaScript, HTML</para></entry>
<entry><para>FFes</para></entry>
</row>
<row>
<entry><para>PHP Language</para></entry>
<entry><para>PHP</para></entry>
<entry><para>jvdanilo</para></entry>
</row>
<row>
<entry><para>XML Tags</para></entry>
<entry><para>XML</para></entry>
<entry><para>jvdanilo</para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</sect1>
&sect1_libraries;

<sect1 id="userlibs">
<title>User generated libraries</title>
Expand Down Expand Up @@ -205,134 +126,7 @@
<para>If you have problems with, questions about or suggestions for NppSnippets you can contact me at <ulink url="mailto:[email protected]">[email protected]</ulink>.</para>
</sect1>

<sect1 id="releasehistory">
<title>Release history</title>

<sect2 id="v1_4_0">
<title>Version 1.4.0 (XX XXXXXX 2015)</title>
<itemizedlist>
<listitem><para>Added option to export library for more easy sharing.</para></listitem>
<listitem><para>Fixed bug 6 at Google Code. When a snippets had an empty first line it could not be saved.</para></listitem>
<listitem><para>Removed all references to Google Code because that <ulink url="http://google-opensource.blogspot.nl/2015/03/farewell-to-google-code.html">service is retiring</ulink>. All things that were on Google Code have been moved to <ulink url="https://github.com/ffes/nppsnippets">GitHub</ulink>.</para></listitem>
<listitem><para>Internally use SqliteDB-class to communicate with the database.</para></listitem>
<listitem><para>Added option <computeroutput>ToolbarIcon</computeroutput> to ini-file to hide the icon from the toolbar.</para></listitem>
<listitem><para>Fixed issue that sometimes new libraries and/or new snippets could not be added.</para></listitem>
</itemizedlist>
</sect2>

<sect2 id="v1_3_0">
<title>Version <ulink url="https://github.com/ffes/nppsnippets/releases/tag/v1.3.0">1.3.0</ulink> (June 2013, never officially release)</title>
<itemizedlist>
<listitem><para>Fixed problem with inserting UTF snippets (<ulink url="http://code.google.com/p/nppsnippets/issues/detail?id=3">issue #3</ulink>).</para></listitem>
<listitem><para>Fixed wrong title of Import Library dialog.</para></listitem>
<listitem><para>Fixed some potential bugs found when trying to fix GCC compilation.</para></listitem>
<listitem><para>Converted the documentation from ODT to DocBook. Because of that an <ulink url="http://www.fesevur.com/docbook/nppsnippets">on-line version</ulink> of the documentation is available as well.</para></listitem>
<listitem><para>Upgrade to SQLite version 3.8.0.2</para></listitem>
</itemizedlist>
</sect2>

<sect2 id="v1_2_0">
<title>Version <ulink url="https://github.com/ffes/nppsnippets/releases/tag/v1.2.0">1.2.0</ulink> (8 January 2013)</title>
<itemizedlist>
<listitem><para>There was an inconsistency between the documentation and code about the name of the option to specify your custom path for the database. Use DBFile from now on. For backwards compatibility the DBPath entry will still be recognized.</para></listitem>
<listitem><para>When a snippets creates a new document and the current document is empty, it reuses the current one and does not start a new.</para></listitem>
<listitem><para>Added Duplicate snippet function to context menu.</para></listitem>
<listitem><para>New (simple) templates library.</para></listitem>
<listitem><para>Upgrade to SQLite version 3.7.15.1</para></listitem>
</itemizedlist>
</sect2>

<sect2 id="v1_1_0">
<title>Version 1.1.0 (13 December 2011)</title>
<itemizedlist>
<listitem><para>You can now add a new snippet to a library based upon the current selection or based upon the content of the clipboard. Right-click the snippets list to use these items.</para></listitem>
<listitem><para>Installation has been improved. A template database is provided and when the plug-in tries to find an existing database and it can't find it, it copies this template database to the AppData plugin-config directory.</para></listitem>
<listitem><para>The About dialog now shows the change-log.</para></listitem>
<listitem><para>When you upgrade the very first time the change-log for the current version will be shown.</para></listitem>
<listitem><para>When you didn't select a specific library for a certain language, the automatic selection of the library is improved. The first language specific library is preferred over the first general library.</para></listitem>
<listitem><para>Resized the edit snippet dialog.</para></listitem>
<listitem><para>Upgrade to SQLite version 3.7.9</para></listitem>
<listitem><para>Moved the download to <ulink url="https://code.google.com/p/nppsnippets/">Google code</ulink>. This gives me statistics about downloads and an issue tracker. The project's <ulink url="http://www.fesevur.com/nppsnippets">web page</ulink> stays where it is.</para></listitem>
</itemizedlist>
</sect2>

<sect2 id="v1_0_0">
<title>Version 1.0.0 (6 September 2011)</title>
<itemizedlist>
<listitem><para>The selection or cursor position are now restored after inserting a snippet.</para></listitem>
</itemizedlist>
</sect2>

<sect2 id="v0_7_1">
<title>Version 0.7.1 (28 August 2011)</title>
<itemizedlist>
<listitem><para>Fixed a bug in the dialog to edit the languages for a certain library. This bug could cause a problem that libraries turn invisible, since all the records in LibraryLang table for that library were deleted and no new records were added.</para></listitem>
<listitem><para>Added a JavaScript - Math library.</para></listitem>
</itemizedlist>
</sect2>

<sect2 id="v0_7_0">
<title>Version 0.7.0 (1 August 2011)</title>
<itemizedlist>
<listitem><para>A user interface for editing the language selection for libraries has been added. You need at least Notepad++ version 5.93 for this feature.</para></listitem>
<listitem><para>You can import a library from another NppSnippet database.</para></listitem>
<listitem><para>Start a new document for a certain snippets, and allow that snippet to set the language of that new document. There were already fields in the database for this. It can be very useful to start a new CSS-file or JavaScript-file from HTML, etc.</para></listitem>
<listitem><para>Added an option DBPath to the ini-file to override the default location of the database. Made this mainly for my own testing, but maybe it is useful for others as well (corporate database). You need to manually edit the ini-file to use this.</para></listitem>
<listitem><para>Added an icon to the tab of the docking interface.</para></listitem>
<listitem><para>Upgrade to SQLite version 3.7.7.1</para></listitem>
</itemizedlist>
</sect2>

<sect2 id="v0_6_0">
<title>Version 0.6.0 (15 June 2011)</title>
<itemizedlist>
<listitem><para>It is now possible to add, edit or delete the snippets and the libraries from within Notepad++. It is not yet possible to edit the languages for a library.</para></listitem>
<listitem><para>Added a new ANSI-characters library for all languages.</para></listitem>
<listitem><para>Deleted the useless General library.</para></listitem>
<listitem><para>Upgrade to SQLite version 3.7.6.3</para></listitem>
</itemizedlist>
</sect2>

<sect2 id="v0_5_0">
<title>Version 0.5.0 (21 December 2010)</title>
<itemizedlist>
<listitem><para>Upgrade to SQLite version 3.7.4</para></listitem>
<listitem><para>The focus is returned to the Scintilla window at start-up and after inserting a snippet.</para></listitem>
<listitem><para>The plug-in remembers if it is shown.</para></listitem>
<listitem><para>Added another special language to the table LibraryLang: Lang = -2. Libraries with this language will always be shown for all languages.</para></listitem>
<listitem><para>The languages last used is now stored in a separate table. The database schema version is 3. With this the libraries with special languages (negative language ID's) can be remembered as last used as well.</para></listitem>
<listitem><para>Error message when the database can not be opened.</para></listitem>
</itemizedlist>
</sect2>

<sect2 id="v0_4_0">
<title>Version 0.4.0 (8 April 2010)</title>
<itemizedlist>
<listitem><para>The database schema is updated and is now at version 2. The most important difference is that the "language" and "last used" field of the library are now in a separate table, allowing it to be one-to-many. Existing databases will be converted automatically to the new schema.</para></listitem>
<listitem><para>When there are multiple libraries for a language, changing to another library works and the last used library is remembered.</para></listitem>
<listitem><para>The plug-in now first tries to find the database in the user's plug-in config directory. On my Windows XP machine that is C:\Documents and Settings\Frank\Application Data\Notepad++\plugins\config. If the database can't be found there it looks in the plugin\config directory in the Notepad++ installation directory, in my case C:\Program Files\Notepad++\plugins\Config.</para></listitem>
<listitem><para>Small improvements to the About dialog.</para></listitem>
<listitem><para>There are now 4 HTML libraries, 1 PHP libraries, 1 XML library and 1 (rather useless) General library</para></listitem>
</itemizedlist>
</sect2>

<sect2 id="v0_3_0">
<title>Version 0.3.0 (10 February 2010)</title>
<itemizedlist>
<listitem><para>First alpha version, released under the GPL2 license.</para></listitem>
<listitem><para>The basics work, no User Interface yet to edit the snippets</para></listitem>
</itemizedlist>
</sect2>

<sect2 id="v0_1_0">
<title>Version 0.1.0 (22 January 2010)</title>
<itemizedlist>
<listitem><para>Internal proof of concept.</para></listitem>
</itemizedlist>
</sect2>

</sect1>

&sect1_history;
&app_tabdef;
&app_lic;

Expand Down
Loading

0 comments on commit b94fe3c

Please sign in to comment.