From: <ez...@us...> - 2011-12-11 18:48:48
|
Revision: 20611 http://jedit.svn.sourceforge.net/jedit/?rev=20611&view=rev Author: ezust Date: 2011-12-11 18:48:41 +0000 (Sun, 11 Dec 2011) Log Message: ----------- Fixed some typos and validation errors in the docs. Updated to docbook 4.4 xsd. Modified Paths: -------------- plugins/SuperAbbrevs/trunk/docs/users-guide.xml Modified: plugins/SuperAbbrevs/trunk/docs/users-guide.xml =================================================================== --- plugins/SuperAbbrevs/trunk/docs/users-guide.xml 2011-12-11 15:46:35 UTC (rev 20610) +++ plugins/SuperAbbrevs/trunk/docs/users-guide.xml 2011-12-11 18:48:41 UTC (rev 20611) @@ -1,12 +1,9 @@ <?xml version="1.0"?> - <!-- jEdit buffer-local properties: --> <!-- :tabSize=2:indentSize=2:noTabs=true:wrap=hard: --> +<book xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:noNamespaceSchemaLocation='http://www.docbook.org/xsd/4.4/docbook.xsd' > -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> - -<!-- <book> --> -<book> <bookinfo> <title>SuperAbbrevs plugin user's guide</title> @@ -46,13 +43,14 @@ abbreviations that works across all modes. </para> <para> - You can defined, edit or delete the abbreviations from the optionpane, - this will be explained further in <xref linkend="Using the plugin"/>. + You can define, edit or delete the abbreviations from the optionpane, + this will be explained further in <xref linkend="UsingPlugin"/>. </para> </chapter> - <chapter id="Using the plugin"><title>Using the plugin</title> - <sect1 id="expand"><title>Expand an abbreviation</title> + <chapter id="UsingPlugin"><title>Using the plugin</title> + <section id="expand"><title>Expand an abbreviation</title> + <para> To expand an abbreviation, you have to be in the mode the abbreviation is associated with, and the cursor should be placed after the abbreviation. Then press the TAB key, the template will be @@ -60,57 +58,66 @@ of the variable it changes everywhere the variable is placed in the template. By pressing the TAB key once more, the next variable is selected. If you want to jump back to a earlier variable - you should just press S+TAB. - </sect1> - <sect1 id="expand selection"><title>Expand an abbreviation on a selection</title> + you should just press S+TAB. </para> + </section> + <section id="expandselection"><title>Expand an abbreviation on a selection</title> + <para> To expand an abbreviation when you have selected some text, you should invoke the <guimenu>Show expandsion dialog</guimenu> action in the <guimenu>Plugins</guimenu> menu. Type in the abbreviation and press ENTER. The abbreviation will be expanded and the selection will be available to - the template generating code. - </sect1> - <sect1 id="add"><title>Add a new abbreviation</title> + the template generating code. </para> + </section> + <section id="add"><title>Add a new abbreviation</title> + <para> In the SuperAbbrevs optionpane, find the mode in the dropdown menu, for which you want to add the abbreviation. Then press the plus button below the abbreviation table, a abbreviation editor will appear. Type in the abbreviation and the template according to the syntax explained in <xref - linkend="Writing templates"/>. Press the Ok button. The abbreviation is not saved + linkend="WritingTemplates"/>. Press the Ok button. The abbreviation is not saved yet, you have to press Apply or the Ok button, at the button of the - optionpane, to save all the changes you made to the abbreviations. - </sect1> - <sect1 id="add inline"><title>Add a new abbreviation from the buffer</title> + optionpane, to save all the changes you made to the abbreviations. </para> + </section> + <section id="addInline"><title>Add a new abbreviation from the buffer</title> + <para> If you want to add a new abbreviation from the buffer, type the abbreviation and press S+TAB a abbreviation editor dialog will be shown. This dialog is used the same way as <xref linkend="add"/>, the only difference is that there is to buttons instead of the Ok button, one for adding the abbreviation to the <emphasis>global</emphasis> mode and one for the current mode. - </sect1> - <sect1 id="edit"><title>Edit a existing abbreviation</title> + </para> + </section> + <section id="edit"><title>Edit a existing abbreviation</title> + <para> To edit an abbreviation, double click it, an abbreviation editor dialog will appear, Type in the abbreviation and the template according to the - syntax explained in <xref linkend="Writing templates"/>. Press the Ok button. + syntax explained in <xref linkend="WritingTemplates"/>. Press the Ok button. The abbreviation is not saved yet, you have to press Apply or the Ok button, at the button of the optionpane, to save all the changes you made to the - abbreviations. - </sect1> - <sect1 id="edit inline"><title>Add a new abbreviation from the buffer</title> + abbreviations. + </para> + </section> + <section id="editInline"><title>Add a new abbreviation from the buffer</title> + <para> If you want to edit an abbreviation from the buffer, type the abbreviation and press S+TAB a abbreviation editor dialog will be shown. This dialog is used the same way as <xref linkend="edit"/>, the only difference is that there is to buttons instead of the ok button, one for adding the abbreviation to the <emphasis>global</emphasis> mode and one for the current mode. - </sect1> + </para> + </section> </chapter> - <chapter id="Writing templates"><title>Writing templates</title> + <chapter id="WritingTemplates"><title>Writing templates</title> <para> A template can consist of the following things: </para> <itemizedlist> - <listitem>Variable + <listitem> <para> - Variables is the essential part of a template, you write a variable + <emphasis role="bold">Variable</emphasis>: + Variables are the essential part of a template. You write a variable in a template as ${number:value} where number is the TAB index of the variable, and value is the text that will be inserted in the variable when the template is expanded. The value will be inserted @@ -120,15 +127,17 @@ The characters \ { } have to be escaped in the value as \\ \{ \}. </para> </listitem> - <listitem>Variable reference + <listitem> <para> - You can refere to a variable by inserting $number, where number is - the TAB index of the variable you are referring to. This inserts the - text of the variable instead of the reference. + <emphasis role="bold">Variable reference</emphasis>: + You can refer to a variable by inserting <literal>$number</literal>, + where number is the TAB index of the variable you are referring to. + This inserts the text of the variable instead of the reference. </para> </listitem> - <listitem>Transformation variable reference + <listitem> <para> + <emphasis role="bold">Transformation variable reference</emphasis>: This is a special kind of reference where you can run beanshell code on the text of the referred variable. You insert it in the template as ${number=code} where number is the TAB index of the variable you @@ -139,8 +148,9 @@ code. </para> </listitem> - <listitem>The end variable + <listitem> <para> + <emphasis role="bold">The end variable</emphasis>: A special variable is $end, this variable will always be defined for a template, and represents the last place the cursor will jump to in the template. If the $end variable is not explicit defined, it will be @@ -148,8 +158,9 @@ the template becomes inactive and the TAB key functions as normal. </para> </listitem> - <listitem>Normal text + <listitem> <para> + <emphasis role="bold">Normal text</emphasis>: Everywhere thing else is just normal text that's inserted and not manipulated by the template engine. </para> @@ -189,7 +200,7 @@ templates and play around with them. </para> </chapter> - <chapter id="Template generation"><title>Template generation</title> + <chapter id="TemplateGeneration"><title>Template generation</title> <para> This is only for advanced users. </para> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ez...@us...> - 2011-12-13 22:58:15
|
Revision: 20639 http://jedit.svn.sourceforge.net/jedit/?rev=20639&view=rev Author: ezust Date: 2011-12-13 22:58:09 +0000 (Tue, 13 Dec 2011) Log Message: ----------- More typos. Modified Paths: -------------- plugins/SuperAbbrevs/trunk/docs/users-guide.xml Modified: plugins/SuperAbbrevs/trunk/docs/users-guide.xml =================================================================== --- plugins/SuperAbbrevs/trunk/docs/users-guide.xml 2011-12-13 22:18:35 UTC (rev 20638) +++ plugins/SuperAbbrevs/trunk/docs/users-guide.xml 2011-12-13 22:58:09 UTC (rev 20639) @@ -28,10 +28,10 @@ <chapter id="Introduction"><title>Introduction</title> <para> - This plugin gives you the ability to expand an abbreviations to userdefined + This plugin gives you the ability to expand an abbreviation to a userdefined code template. When expanded, you can jump between the variables in the template using the TAB key. If you change the text of a variable, the text - will change everywhere the variable is placed in the template. + will instantly change at the variable's other positions in the template. </para> <para> There are already some predefined abbreviations when you install the plugin. @@ -72,10 +72,10 @@ <para> In the SuperAbbrevs optionpane, find the mode in the dropdown menu, for which you want to add the abbreviation. Then press the plus button below the - abbreviation table, an abbreviation editor will appear. Type in the + abbreviation table. An abbreviation editor will appear. Type in the abbreviation and the template according to the syntax explained in <xref linkend="WritingTemplates"/>. Press the Ok button. The abbreviation is not saved - yet - you must press Apply or the Ok button, at the button of the + yet - you must press Apply or the Ok button, at the bottom of the optionpane, to save all the changes you made to the abbreviations. </para> </section> <section id="addInline"><title>Add a new abbreviation from the buffer</title> @@ -93,7 +93,7 @@ will appear. Type in the abbreviation and the template according to the syntax explained in <xref linkend="WritingTemplates"/>. Press the Ok button. The abbreviation is not saved yet, you still have to press Apply or the Ok button, - at the button of the optionpane, to save all the changes you made to the + at the bottom of the optionpane, to save all the changes you made to the abbreviations. </para> </section> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <joj...@us...> - 2012-07-12 14:07:20
|
Revision: 21932 http://jedit.svn.sourceforge.net/jedit/?rev=21932&view=rev Author: jojaba_67 Date: 2012-07-12 14:07:09 +0000 (Thu, 12 Jul 2012) Log Message: ----------- Updating user guide with zen-coding explanations Modified Paths: -------------- plugins/SuperAbbrevs/trunk/docs/users-guide.xml Modified: plugins/SuperAbbrevs/trunk/docs/users-guide.xml =================================================================== --- plugins/SuperAbbrevs/trunk/docs/users-guide.xml 2012-07-10 20:46:13 UTC (rev 21931) +++ plugins/SuperAbbrevs/trunk/docs/users-guide.xml 2012-07-12 14:07:09 UTC (rev 21932) @@ -10,6 +10,7 @@ <copyright> <year>2005</year> <year>2010</year> + <year>2012</year> <holder>Sune Simonsen</holder> </copyright> @@ -46,6 +47,13 @@ You can define, edit or delete abbreviations from this optionpane. This will be explained further in <xref linkend="UsingPlugin"/>. </para> + <para> + Additionnaly, you can use the Zen Coding syntax. Zen Coding is an editor + plugin for high-speed HTML, XML, XSL (or any other structured code format) + coding and editing. His core of is a powerful abbreviation engine which + allows you to expand expressions—similar to CSS selectors—into HTML code. + For further information please look into the <xref linkend="ZenCoding"/> section. + </para> </chapter> <chapter id="UsingPlugin"><title>Using the plugin</title> @@ -58,7 +66,8 @@ of the variable, it changes everywhere the variable is placed in the template. By pressing the TAB key once more, the next variable is selected. If you want to jump back to an earlier variable - you should just press S+TAB. </para> + you should just press S+TAB. + </para> </section> <section id="expandselection"><title>Expand an abbreviation on a selection</title> <para> @@ -66,7 +75,8 @@ the <guimenu>Show expandsion dialog</guimenu> action in the <guimenu>Plugins</guimenu> menu. Type in the abbreviation and press ENTER. The abbreviation will be expanded and the selection will be available to - the template generating code. </para> + the template generating code. + </para> </section> <section id="add"><title>Add a new abbreviation</title> <para> @@ -76,7 +86,8 @@ abbreviation and the template according to the syntax explained in <xref linkend="WritingTemplates"/>. Press the Ok button. The abbreviation is not saved yet - you must press Apply or the Ok button, at the bottom of the - optionpane, to save all the changes you made to the abbreviations. </para> + optionpane, to save all the changes you made to the abbreviations. + </para> </section> <section id="addInline"><title>Add a new abbreviation from the buffer</title> <para> @@ -85,7 +96,7 @@ same way as in <xref linkend="add"/> - the only difference is that there are two buttons instead of the Ok button, one for adding the abbreviation to the <emphasis>global</emphasis> mode and one for adding it to the current mode. - </para> + </para> </section> <section id="edit"><title>Edit a existing abbreviation</title> <para> @@ -95,7 +106,7 @@ The abbreviation is not saved yet, you still have to press Apply or the Ok button, at the bottom of the optionpane, to save all the changes you made to the abbreviations. - </para> + </para> </section> <section id="editInline"><title>Add a new abbreviation from the buffer</title> <para> @@ -237,4 +248,92 @@ ]]></programlisting> </para> </chapter> + + <chapter id="ZenCoding"><title>Zen Coding</title> + <para> + Below, the features of Zen Coding engine: + </para> + <itemizedlist> + <listitem> + <para> + ID and CLASS attributes: <code>div#page.section.main</code>. + </para> + </listitem> + <listitem> + <para> + Custom attributes: <code>div[title]</code>, <code>a[title="Hello world" rel]</code>, + <code>td[colspan=2]</code>. + </para> + </listitem> + <listitem> + <para> + Element multiplication: <code>li*5</code> will output li tag five times. + </para> + </listitem> + <listitem> + <para> + Item numbering with <code>$</code> character: <code>li.item$*3</code> will output li tag + three times, replacing <code>$</code> character with item number. + </para> + </listitem> + <listitem> + <para> + Multiple <code>$</code> characters in a row are used as zero padding, + i.e.: <code>li.item$$$</code> → <code>li.item001</code>. + </para> + </listitem> + <listitem> + <para> + Abbreviation groups with unlimited nesting: + <code>div#page>(div#header>ul#nav>li*4>a)+(div#page>(h1>span)+p*2)+div#footer</code>. + You can literally write a full document markup with just a single line. + </para> + </listitem> + <listitem> + <para> + Filters support. For example <code>div#content|e</code> will expand in + <programlisting><![CDATA[<div id="content">]]></programlisting>. + </para> + </listitem> + <listitem> + <para> + div tag name can be omitted when writing element starting from ID or + CLASS: <code>#content>.section</code> is the same as <code>div#content>div.section</code>. + </para> + </listitem> + <listitem> + <para> + Text support: <code>p>{Click }+a{here}+{ to continue}</code>. + </para> + </listitem> + </itemizedlist> + <para> + The example <code>div#page>div.logo+ul#navigation>li*5>a[title]</code> will expand in: + </para> + <para> + <programlisting><![CDATA[ + <div id="page"> + <div class="logo"></div> + <ul id="navigation"> + <li> + <a title="" href=""></a> + </li> + <li> + <a title="" href=""></a> + </li> + <li> + <a title="" href=""></a> + </li> + <li> + <a title="" href=""></a> + </li> + <li> + <a title="" href=""></a> + </li> + </ul> + </div> +]]></programlisting> + </para> + + </chapter> </book> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <kp...@us...> - 2012-11-28 08:59:43
|
Revision: 22509 http://jedit.svn.sourceforge.net/jedit/?rev=22509&view=rev Author: kpouer Date: 2012-11-28 08:59:32 +0000 (Wed, 28 Nov 2012) Log Message: ----------- added zencoding information Modified Paths: -------------- plugins/SuperAbbrevs/trunk/docs/users-guide.xml Modified: plugins/SuperAbbrevs/trunk/docs/users-guide.xml =================================================================== --- plugins/SuperAbbrevs/trunk/docs/users-guide.xml 2012-11-28 08:58:35 UTC (rev 22508) +++ plugins/SuperAbbrevs/trunk/docs/users-guide.xml 2012-11-28 08:59:32 UTC (rev 22509) @@ -251,6 +251,10 @@ <chapter id="ZenCoding"><title>Zen Coding</title> <para> + The Zen Coding feature is inspired from Zen Coding + <ulink url="http://code.google.com/p/zen-coding/">http://code.google.com/p/zen-coding/</ulink> + It is not an official implementation so it is possible to have some little + differences. Below, the features of Zen Coding engine: </para> <itemizedlist> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |