diff options
author | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
commit | e0c6872cf40896c7be36b11dcc744620f10adf1d (patch) | |
tree | 60335e10d2f4354b0674ec22d7b53f0f8abee672 /biblio/bibtex/utils/mkbib/help/C |
Initial commit
Diffstat (limited to 'biblio/bibtex/utils/mkbib/help/C')
16 files changed, 488 insertions, 0 deletions
diff --git a/biblio/bibtex/utils/mkbib/help/C/contacts.page b/biblio/bibtex/utils/mkbib/help/C/contacts.page new file mode 100644 index 0000000000..221ce50504 --- /dev/null +++ b/biblio/bibtex/utils/mkbib/help/C/contacts.page @@ -0,0 +1,23 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="topic" + id="contacts"> + + <info> + <link type="guide" xref="index#troubleshooting" group="first"/> + + <credit type="author copyright"> + <name>Rudra Banerjee</name> + <email>rudra.banerjee@aol.co.uk</email> + <years>2013</years> + </credit> + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> + <desc>INFO on <app>BiBTeX</app></desc> + </info> + <title>Contacts</title> + <terms> + <item> + <title><sys href="mailto:rudra.banerjee@aol.co.uk">Mail Me</sys></title> + <p>Contact Me to report bugs and suggested enhancements.</p> + </item> + </terms> +</page> diff --git a/biblio/bibtex/utils/mkbib/help/C/feature.page b/biblio/bibtex/utils/mkbib/help/C/feature.page new file mode 100644 index 0000000000..1629ea6ed0 --- /dev/null +++ b/biblio/bibtex/utils/mkbib/help/C/feature.page @@ -0,0 +1,80 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="topic" + id="feature"> + + <info> + <link type="guide" xref="index#overview" group="#first"/> + <link type="next" xref="interface"/> + <credit type="author copyright"> + <name>Rudra Banerjee</name> + <email>rudra.banerjee@aol.co.uk</email> + <years>2013</years> + </credit> + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> + <desc><app>mkBiB</app>: what it can and what it cann't</desc> + </info> + + <title><app>mkBiB</app>: Features and Limitatioins</title> + <section id="features"> + <title>Features</title> + <list> + <item> + <p> + A simple gui to generate and edit bibtex file. + </p> + </item> + <item> + <p> + Search google scholar from the same interface(Search in google scholar webpage, not withstanding their terms of usage,in my knowledge). + </p> + </item> + <item> + <p> + Include a complete bibtex entry. + </p> + </item> + </list> + </section> + <section id="limitations"> + <title>Limitations</title> + <list> + <item> + <p> + <app>BiBTeX</app> can be used with many format. The most popular (very small number of subset) of those format is tested. + </p> + </item> + </list> + </section> + <section id="File_Type"> + <title>Acceptable Entry Type</title> + <p>Below are two type of accpted and tested entry type</p> + <code mime="application/x-latex"> + @article{RevModPhys.71.1253, + title = {Nobel Lecture: Electronic structure of + matter\char22{}wave functions and density functionals}, + author = {Kohn, W.}, + journal = {Rev. Mod. Phys.}, + volume = {71}, + issue = {5}, + pages = {1253--1266}, + year = {1999}, + publisher = {American Physical Society} + } + </code> + <code> + @article{RevModPhys.71.1253, + title = "Nobel Lecture: Electronic structure of + matter\char22{}wave functions and density functionals", + author = "Kohn, W.", + journal = "Rev. Mod. Phys.", + volume = "71", + issue = "5", + pages = "1253--1266", + year = "1999", + publisher = "American Physical Society" + } + </code> + <p>When a entry is made by putting value to each key as available in left pane, it will produce a entry shown below.</p> + </section> +</page> + diff --git a/biblio/bibtex/utils/mkbib/help/C/google.page b/biblio/bibtex/utils/mkbib/help/C/google.page new file mode 100644 index 0000000000..a19742b6df --- /dev/null +++ b/biblio/bibtex/utils/mkbib/help/C/google.page @@ -0,0 +1,26 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="topic" + id="google"> + + <info> + <link type="guide" xref="index#usage"/> + <link type="next" xref="keyboard-shortcuts"/> + + <credit type="author copyright"> + <name>Rudra Banerjee</name> + <email>rudra.banerjee@aol.co.uk</email> + <years>2013</years> + </credit> + + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> + + <desc>Search <app>Google Scholar</app></desc> + + </info> + <title>Search <app>Google Scholar</app></title> + <p>Right from the left pane, user can "Search Google Scholar". Just enter <gui>Author</gui>, <gui>Title(As Keyword)</gui> and <gui>Year(Optional)</gui> and hit <gui style="button">Search Google Scholar</gui>. The result will be shown in user's default web browser. + </p> + <note style="tip"><p>You can do better by turning bibtex link in google scholar setting "on"</p></note> + +</page> + diff --git a/biblio/bibtex/utils/mkbib/help/C/images/entry_pane.png b/biblio/bibtex/utils/mkbib/help/C/images/entry_pane.png Binary files differnew file mode 100644 index 0000000000..a0bedb5972 --- /dev/null +++ b/biblio/bibtex/utils/mkbib/help/C/images/entry_pane.png diff --git a/biblio/bibtex/utils/mkbib/help/C/images/left_pane.png b/biblio/bibtex/utils/mkbib/help/C/images/left_pane.png Binary files differnew file mode 100644 index 0000000000..3ae1e0f9bf --- /dev/null +++ b/biblio/bibtex/utils/mkbib/help/C/images/left_pane.png diff --git a/biblio/bibtex/utils/mkbib/help/C/images/mkbib.png b/biblio/bibtex/utils/mkbib/help/C/images/mkbib.png Binary files differnew file mode 100644 index 0000000000..d010b7e167 --- /dev/null +++ b/biblio/bibtex/utils/mkbib/help/C/images/mkbib.png diff --git a/biblio/bibtex/utils/mkbib/help/C/images/right_pane.png b/biblio/bibtex/utils/mkbib/help/C/images/right_pane.png Binary files differnew file mode 100644 index 0000000000..47eece605b --- /dev/null +++ b/biblio/bibtex/utils/mkbib/help/C/images/right_pane.png diff --git a/biblio/bibtex/utils/mkbib/help/C/index.page b/biblio/bibtex/utils/mkbib/help/C/index.page new file mode 100644 index 0000000000..4988a3c1b3 --- /dev/null +++ b/biblio/bibtex/utils/mkbib/help/C/index.page @@ -0,0 +1,30 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="guide" style="2column task" + id="index"> + + <info> + <credit type="author copyright"> + <name>Rudra Banerjee</name> + <email>rudra.banerjee@aol.co.uk</email> + <years>2013</years> + </credit> + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> + </info> + + <title> + <media type="image" mime="image/png" src="images/mkbib.png"/> mkBiB Manual + </title> + + <section id="overview" style="2column"> + <title>Overview</title> + </section> + + + <section id="usage" style="2column"> + <title>Using <app>mkBiB</app></title> + </section> + + <section id="troubleshooting" style="2column"> + <title>Common problems and solutions</title> + </section> +</page> diff --git a/biblio/bibtex/utils/mkbib/help/C/install.page b/biblio/bibtex/utils/mkbib/help/C/install.page new file mode 100644 index 0000000000..b28b7ecf86 --- /dev/null +++ b/biblio/bibtex/utils/mkbib/help/C/install.page @@ -0,0 +1,58 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="topic" + id="install"> + + <info> + <link type="guide" xref="index#overview" group="#last"/> + <link type="next" xref="index#usage"/> + + <credit type="author copyright"> + <name>Rudra Banerjee</name> + <email>rudra.banerjee@aol.co.uk</email> + <years>2013</years> + </credit> + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> + <desc>Installing <app>mkBiB</app>: general and distro specific instruction.</desc> + </info> + + <title>Installing <app>mkBiB</app></title> + <section id="Download"> + <title>Download</title> + <p> + The most recent updated will always be available from <link href="http://download.savannah.gnu.org/releases/mkbib/">SAVANNAH REPO</link>. + </p> + <p> + The stable version will be availavle from <link href="http://www.ctan.org/pkg/mkbib">CTAN REPO</link> + </p> + + + </section> + <section id="install_generic"> + <title>Required Packages</title> + <list> + <item><p>GTK+-3</p></item> + <item><p>libsoup</p></item> + <item><p>intltool</p></item> + <item><p>yelp-tools</p></item> + <item><p>gnu-flex and bison</p></item> + </list> + </section> + <section id="distro"> + <title>Instruction for specific distro</title> + <section id="fedora"> + <title>Fedora 18</title> + <screen>yum install libsoup-devel.x86_64 intltool\ + yelp-tools intltool gtk3-devel \ + flex flex-devel bison</screen> + </section> + <section id="arch"> + <title>Arch</title> + <note> + <p> + Instruction for Arch and Ubuntu will be updated soon. + </p> + </note> + </section> + </section> +</page> + diff --git a/biblio/bibtex/utils/mkbib/help/C/interface.page b/biblio/bibtex/utils/mkbib/help/C/interface.page new file mode 100644 index 0000000000..14d3ddab26 --- /dev/null +++ b/biblio/bibtex/utils/mkbib/help/C/interface.page @@ -0,0 +1,51 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="topic" + id="interface"> + + <info> + <link type="guide" xref="index#overview"/> +<link type="next" xref="install"/> + + <credit type="author copyright"> + <name>Rudra Banerjee</name> + <email>rudra.banerjee@aol.co.uk</email> + <years>2013</years> + </credit> + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> + <desc><app>mkBiB</app>'s Interface</desc> + </info> + + <title><app>mkBiB</app> Interface</title> + <p><app>mkBiB</app> is an editor and viewer of <app>BiBTeX</app> file. The left hand pane is the main editor, and the right hand pane is the main viewer.</p> + <section id="left_pane"> + <title>Left Pane</title> + <p> + This Left Pane is the main editing area of <app>mkBiB</app> + </p> + <media type="image" src="images/left_pane.png" width="240"/> + <section id="menu_bar"> + <title><gui style="menuitem">Menu Bar</gui></title> + <p> + <gui style="group">Menu Bar</gui> contains standard <gui style="menu">File</gui>, <gui style="menu">Edit</gui> and <gui style="menu">Help</gui>. + </p> + <p> + <gui style="menuitem">File</gui> and <gui style="menuitem">Help</gui> contains traditional <gui style="menuitem">New</gui> , <gui style="menuitem">Open</gui>, <gui style="menuitem">Save</gui>, <gui style="menuitem">Save As</gui> and <gui style="menuitem">About</gui> and <gui style="menuitem">Help</gui> item with their traditional keyboard-shortcuts as listed <code xref="keyboard-shortcuts">here</code>. + </p> + </section> + <section id="entry_bar"> + <title>Entries</title> + <p>This part is used to create a single bibtex entry giving its value one by one. When finished, press <gui style="button">Create</gui> button to create a single bibtex entry.</p> + <note style="tip"> + <p> + An entry can be generated using <keyseq><key>Alt</key><key>E</key></keyseq> or <guiseq><gui style="menu">Edit</gui><gui style="menuitem">Edit</gui></guiseq> which will open a empty editor to input a complete entry. + </p> + </note> + </section> + </section> + <section id="right_pane"> + <title>Right Pane</title> + <p>Right Pane the viewer of the <gui>BiBTeX</gui> and the inline editor of visible columns.</p> + <media type="image" src="images/right_pane.png" width="240"/> + </section> +</page> + diff --git a/biblio/bibtex/utils/mkbib/help/C/introduction.page b/biblio/bibtex/utils/mkbib/help/C/introduction.page new file mode 100644 index 0000000000..e60a8f8069 --- /dev/null +++ b/biblio/bibtex/utils/mkbib/help/C/introduction.page @@ -0,0 +1,25 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="topic" + id="introduction"> + + <info> + <link type="guide" xref="index"/> + + <credit type="author copyright"> + <name>Rudra Banerjee</name> + <email>rudra.banerjee@aol.co.uk</email> + <years>2013</years> + </credit> + + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> + + <desc>What is <app>mkBiB</app>?</desc> + + </info> + + <title>Introduction</title> + <p><app>mkBiB</app> is a BibTeX manager. + User can creat, manage and edit a new or existing bibtex file. + User can enter each field separately or an complete entry. + </p> +</page> diff --git a/biblio/bibtex/utils/mkbib/help/C/keyboard-shortcuts.page b/biblio/bibtex/utils/mkbib/help/C/keyboard-shortcuts.page new file mode 100644 index 0000000000..ad81fff1ec --- /dev/null +++ b/biblio/bibtex/utils/mkbib/help/C/keyboard-shortcuts.page @@ -0,0 +1,90 @@ +<page xmlns="http://projectmallard.org/1.0/" + xmlns:ui="http://projectmallard.org/experimental/ui/" + type="task" + id="keyboard-shortcuts"> + + <info> + <revision pkgversion="3.8" version="0.1" date="2013-03-29" status="candidate"/> + <link type="guide" xref="index#usage" group="#last"/> + <link type="next" xref="index#troubleshooting"/> + + <credit type="author copyright"> + <name>Rudra Banerjee</name> + <email>rudra.banerjee@aol.co.uk</email> + <years>2013</years> + </credit> + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> + + <desc>Use keyboard shortcuts to work with <app>mkBiB</app> more efficiently.</desc> + + </info> + + <title>Keyboard shortcuts</title> + + <p>Keyboard shortcuts are combinations of keys that you can use instead of + navigating through the menu. The following shortcuts are available:</p> + + <table rules="rows" frame="top bottom" ui:expanded="yes"> + <title><gui style="guiitem">File</gui></title> + <thead> + <tr> + <td><p>Action</p></td> + <td><p>Shortcut</p></td> + </tr> + </thead> + <tbody> + <tr> + <td><p>Open A New File</p></td> + <td><p><keyseq><key>Ctrl</key><key>N</key></keyseq></p></td> + </tr> + <tr> + <td><p>Open An Existing File</p></td> + <td><p><keyseq><key>Ctrl</key><key>O</key></keyseq></p></td> + </tr> + <tr> + <td><p>Save File</p></td> + <td><p><keyseq><key>Ctrl</key><key>S</key></keyseq></p></td> + </tr> + <tr> + <td><p>Save As A New/Existing File</p></td> + <td><p><keyseq><key>Shift</key><key>Ctrl</key><key>S</key></keyseq></p></td> + </tr> + <tr> + <td><p>Quit</p></td> + <td><p><keyseq><key>Ctrl</key><key>Q</key></keyseq></p></td> + </tr> + </tbody> + </table> + + <table rules="rows" frame="top bottom" ui:expanded="yes"> + <title>Edit</title> + <thead> + <tr> + <td><p>Action</p></td> + <td><p>Shortcut</p></td> + </tr> + </thead> + <tbody> + <tr> + <td><p>Enter A Full Entry</p></td> + <td><p><keyseq><key>Alt</key><key>E</key></keyseq></p></td> + </tr> + </tbody> + </table> + <table rules="rows" frame="top bottom" ui:expanded="yes"> + <title>Help</title> + <thead> + <tr> + <td><p>Action</p></td> + <td><p>Shortcut</p></td> + </tr> + </thead> + <tbody> + <tr> + <td><p>Help (This Guide)</p></td> + <td><p><key>F1</key></p></td> + </tr> + </tbody> + </table> + +</page> diff --git a/biblio/bibtex/utils/mkbib/help/C/legal.xml b/biblio/bibtex/utils/mkbib/help/C/legal.xml new file mode 100644 index 0000000000..aff1f5a21a --- /dev/null +++ b/biblio/bibtex/utils/mkbib/help/C/legal.xml @@ -0,0 +1,3 @@ +<license xmlns="http://projectmallard.org/1.0/"> +<p> Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts and no Back-Cover Texts. A copy of the license is available at <link href="http://www.gnu.org/licenses/fdl-1.3.txt">GNU Free Documentation License</link> </p> +</license> diff --git a/biblio/bibtex/utils/mkbib/help/C/new.page b/biblio/bibtex/utils/mkbib/help/C/new.page new file mode 100644 index 0000000000..d179780b88 --- /dev/null +++ b/biblio/bibtex/utils/mkbib/help/C/new.page @@ -0,0 +1,33 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="topic" + id="new-file"> + + <info> + <link type="guide" xref="index#usage" group="first"/> +<link type="next" xref="old-file"/> + + <credit type="author copyright"> + <name>Rudra Banerjee</name> + <email>rudra.banerjee@aol.co.uk</email> + <years>2013</years> + </credit> + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> + <desc>Creating a new <app>BiBTeX</app> using <app>mkBiB</app></desc> + </info> + + <title>Creating a new <app>BiBTeX</app></title> + <p>An antry can be created either by putting values to cell as described in <code xref="#new_cell">New Cell</code> or a complete entry, as described in <code xref="#new_entry">New Entry</code> below.</p> + <section id="new_cell"> + <title>New Cell</title> + <p>Entries are adden in the left pane. The <gui style="button">Entry Type</gui> and <gui style="button">bibkey</gui> is compulsury. + </p> + <media type="image" src="images/left_pane.png" width="200"/> + </section> + <section id="new_entry"> + <title>New Entry</title> + <p>A complete entry can be added using <guiseq><gui>Edit</gui><gui>Edit</gui></guiseq> + Enter the entry in the pane opened, and click <gui style="button">Create</gui> to create the entry. + </p><media type="image" src="images/entry_pane.png" width="200"/> + </section> +</page> + diff --git a/biblio/bibtex/utils/mkbib/help/C/old.page b/biblio/bibtex/utils/mkbib/help/C/old.page new file mode 100644 index 0000000000..355c1d3b8f --- /dev/null +++ b/biblio/bibtex/utils/mkbib/help/C/old.page @@ -0,0 +1,41 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="topic" + id="old-file"> + + <info> + <link type="guide" xref="index#usage"/> +<link type="next" xref="google"/> + + <credit type="author copyright"> + <name>Rudra Banerjee</name> + <email>rudra.banerjee@aol.co.uk</email> + <years>2013</years> + </credit> + + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> + + <desc>Manageing an existing <app>BiBTeX</app> using <app>mkBiB</app></desc> + + </info> + <title>Manageing an existing <app>BiBTeX</app></title> + <p> + Open an existing <app>BiBTeX</app> follows standard method of openning files i.e. <keyseq><key>Ctrl</key><key>O</key></keyseq> or <guiseq><gui>File</gui><gui>Open</gui></guiseq> in <gui style="menuitem">menubar</gui>. + </p> + <p>Manageing an existing <app>BiBTeX</app> file using <app>mkBiB</app> can be done in two way. </p> + <section id="edit_cell"> + <title>Editing The View Pane</title> + <p> + All the elements visible in the right pane can be edited by double clicking on the corresponding cell. + </p> + <note style="warning"> + <p>Only visible columns, i.e. 5 columns can be edited. For all other columns, you have to do it manually, using a Text Editor.</p> + </note> + </section> + <section id="new-cell"> + <title>New Entry In Existing File</title> + <p> + You can enter new entries in existing <app>BiBTeX</app> as described <code xref="new-file#new_cell">here</code> or <code xref="new-file#new_entry">here</code>. + </p> + </section> +</page> + diff --git a/biblio/bibtex/utils/mkbib/help/C/trouble.page b/biblio/bibtex/utils/mkbib/help/C/trouble.page new file mode 100644 index 0000000000..3c99555cf4 --- /dev/null +++ b/biblio/bibtex/utils/mkbib/help/C/trouble.page @@ -0,0 +1,28 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="topic" + id="bibref"> + + <info> + <link type="guide" xref="index#troubleshooting" group="first"/> + <link type="next" xref="contacts"/> + + <credit type="author copyright"> + <name>Rudra Banerjee</name> + <email>rudra.banerjee@aol.co.uk</email> + <years>2013</years> + </credit> + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> + <desc>INFO on <app>BiBTeX</app></desc> + </info> + <title>Usefule <app>BiBTeX</app> links</title> + <terms> + <item> + <title><sys href="http://bibtex.org">bibtex.org</sys></title> + <p>Here you will find everything you need to know about <app>BiBTeX</app>, or such the website clames.</p> + </item> + <item> + <title><sys href="http://www.cs.stir.ac.uk/~kjt/software/latex/showbst.html">Ken Turnet's page on <app>BiBTeX</app></sys></title> + <p>A collection of most used <app>BiBTeX</app> style's output. Very Helpful.</p> + </item> + </terms> +</page> |