doc/blogilo/index.docbook

   1 <?xml version="1.0" ?>
   2 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
   3   <!-- Define an entity for your application if it is not part of KDE
   4        CVS -->
   5   <!ENTITY kapplication "<application>Blogilo</application>">
   6   <!ENTITY kappname "&kapplication;">
   7   <!ENTITY package "playground/pim">
   8   <!ENTITY % addindex "IGNORE">
   9   <!ENTITY % English "INCLUDE">
  10 ]>
  11 <book lang="&language;">
  12
  13 <bookinfo>
  14 <title>The &kapplication; Handbook</title>
  15
  16 <authorgroup>
  17 <author>
  18 &Mehrdad.Momeny;&Mehrdad.Momeny.mail;
  19 </author>
  20 <author>
  21 &Golnaz.Nilieh;&Golnaz.Nilieh.mail;
  22 </author>
  23
  24 <!-- TRANS:ROLES_OF_TRANSLATORS -->
  25 </authorgroup>
  26
  27 <copyright>
  28 <year>2009</year>
  29 <holder>&Mehrdad.Momeny;</holder>
  30 </copyright>
  31
  32 <legalnotice>&FDLNotice;</legalnotice>
  33
  34 <date>2009-09-21</date>
  35 <releaseinfo>1.0</releaseinfo>
  36
  37 <abstract>
  38 <para>
  39 &kapplication; is a blogging client for &kde;.
  40 </para>
  41 </abstract>
  42
  43 <keywordset>
  44 <keyword>KDE</keyword>
  45 <keyword>blog</keyword>
  46 </keywordset>
  47
  48 </bookinfo>
  49
  50 <chapter id="introduction">
  51 <title>Introduction</title>
  52
  53 <para>&kapplication; is a blogging client.</para>
  54 <para>A blog client (also called blog software or blogware) is a software designed to simplify the creation and maintenance of weblogs. As specialized content management systems, weblog applications support the authoring, editing, and publishing of blog posts and comments, with special functions for image management, web syndication, and moderation of posts and comments.</para>
  55 </chapter>
  56
  57 <chapter id="using-kapp">
  58 <title>Using &kapplication;</title>
  59
  60 <sect1 id="getting-started">
  61 <title>Getting started</title>
  62 <para>In &kapplication; main window, User can create new posts, modify previous ones, remove them from server, Also upload media files to servers. And he can save posts locally for later use.</para>
  63 <para>All of these will be available when user configures at least one blog on &kapplication;.</para>
  64 <para>Without any configured blog you can write and save some posts locally for later use.</para>
  65 <screenshot>
  66 <screeninfo>Here's a screenshot of &kapplication;</screeninfo>
  67   <mediaobject>
  68     <imageobject>
  69       <imagedata fileref="mainwindow.png" format="PNG"/>
  70     </imageobject>
  71     <textobject>
  72       <phrase>Main Window</phrase>
  73     </textobject>
  74   </mediaobject>
  75 </screenshot>
  76 </sect1>
  77
  78 <sect1 id="configuring-a-blog">
  79 <title>Configuring a blog</title>
  80 <para>Blog management is available in the <guilabel>Configure &kapplication;</guilabel> dialog,
  81 and is accessible via <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
  82 &kapplication;...</guimenuitem></menuchoice> menu. Also there is a shortcut for it
  83 in main window you can access it via <menuchoice>
  84 <guimenu>Blog</guimenu><guimenuitem>Add Blog...</guimenuitem></menuchoice> menu.</para>
  85 <screenshot>
  86 <screeninfo>Add a new blog - <guilabel>Basic</guilabel> tab</screeninfo>
  87   <mediaobject>
  88     <imageobject>
  89       <imagedata fileref="add-blog-1.png" format="PNG"/>
  90     </imageobject>
  91     <textobject>
  92       <phrase>Add a new blog - <guilabel>Basic</guilabel> tab</phrase>
  93     </textobject>
  94   </mediaobject>
  95 </screenshot>
  96 <para>
  97 To add a blog, simply you have to insert your blog address, username and password, in desired places,
  98 and then click <guibutton>Auto Configure</guibutton> button, for most famous blogging servers such as Wordpress,
  99 It will guess your blog, and api, and the will fetch your BlogId.</para>
 100 <para>And if It fails, you can select your blog's API type in the <guilabel>Advanced</guilabel> tab
 101 and click <guibutton>Fetch ID</guibutton> to fetch id, or enter Blog id, if you know it
 102 . And If you are using a “right to left” language, select <guilabel>Right To Left</guilabel> in next combo box.</para>
 103 <screenshot>
 104 <screeninfo>Add a new blog - <guilabel>Advanced</guilabel> tab</screeninfo>
 105   <mediaobject>
 106     <imageobject>
 107       <imagedata fileref="add-blog-2.png" format="PNG"/>
 108     </imageobject>
 109     <textobject>
 110       <phrase>Add a new blog - <guilabel>Advanced</guilabel> tab</phrase>
 111     </textobject>
 112   </mediaobject>
 113 </screenshot>
 114 <para>
 115 And after all, you can see what &kapplication; supports for your blog now, in Supported Features tab.</para>
 116 </sect1>
 117
 118 <sect1 id="creating-new-post">
 119 <title>Creating a new Post</title>
 120 <para>To create a new post, in main window, you can click on <guibutton>New Post</guibutton> toolbar
 121 button or under <guimenu>Post</guimenu> menu, or simply press
 122 <keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> (its shortcut).</para>
 123 <para>Then a new/empty post is created, and you can write, and configure it, and then submit it to your blog.</para>
 124 <para>The &kapplication; main window is divided into two sections, Composer and Toolbox.</para>
 125
 126 <sect2><title>Composer</title>
 127 <para>In the Composer section, you have a text field with label Title, that you can write the title of this post there. Below it, you have 3 tabs, first is Visual Editor, where you have a WYSWIG editor, next tab is &HTML; editor, where you have a text editor to edit &HTML; code of your post, with a syntax highlighted editor. And on last tab, you can view your post with your blog style, before submit it to server.</para>
 128 </sect2>
 129
 130 <sect2>
 131 <title>Toolbox</title>
 132 <para>The Toolbox has four sections:</para>
 133 <orderedlist>
 134 <listitem>
 135 <para>Blog Posts</para>
 136 <screenshot>
 137 <screeninfo>Blog Posts</screeninfo>
 138   <mediaobject>
 139     <imageobject>
 140       <imagedata fileref="toolbox-1.png" format="PNG"/>
 141     </imageobject>
 142     <textobject>
 143       <phrase>Blog Posts</phrase>
 144     </textobject>
 145   </mediaobject>
 146 </screenshot>
 147 <para>In this section, you can fetch the latest posts from the server.</para>
 148 <para>Double click on a post entry to load it into composer and modify it or remove a post from the server.</para>
 149 </listitem>
 150
 151 <listitem>
 152 <para>Post Categories</para>
 153 <screenshot>
 154 <screeninfo>Post Categories</screeninfo>
 155   <mediaobject>
 156     <imageobject>
 157       <imagedata fileref="toolbox-2.png" format="PNG"/>
 158     </imageobject>
 159     <textobject>
 160       <phrase>Post Categories</phrase>
 161     </textobject>
 162   </mediaobject>
 163 </screenshot>
 164 <para>In this section you can select categories and tags for your post. Tags must be comma separated.</para>
 165 </listitem>
 166
 167 <listitem>
 168 <para>Post Options</para>
 169 <screenshot>
 170 <screeninfo>Post Options</screeninfo>
 171   <mediaobject>
 172     <imageobject>
 173       <imagedata fileref="toolbox-3.png" format="PNG"/>
 174     </imageobject>
 175     <textobject>
 176       <phrase>Post Options</phrase>
 177     </textobject>
 178   </mediaobject>
 179 </screenshot>
 180 <para>Here you can select some options for current active post in the composer.</para>
 181 <para>Such as Feedback options, that if visitors can leave a comment for this post or not.</para>
 182 <para>Select publish date, or title to use for permalink of post. (For Wordpress blogs only).</para>
 183 </listitem>
 184
 185 <listitem>
 186 <para>Local Entries</para>
 187 <screenshot>
 188 <screeninfo>Local Entries</screeninfo>
 189   <mediaobject>
 190     <imageobject>
 191       <imagedata fileref="toolbox-4.png" format="PNG"/>
 192     </imageobject>
 193     <textobject>
 194       <phrase>Local Entries</phrase>
 195     </textobject>
 196   </mediaobject>
 197 </screenshot>
 198 <para>And in Local Entries section, you can double click on an entry to load it into composer, or remove it from disk.</para>
 199 </listitem>
 200
 201 </orderedlist>
 202 </sect2>
 203
 204 </sect1>
 205
 206 <sect1 id="uploading">
 207 <title>Uploading a Media file to server</title>
 208 <para>To upload a file to server, from Blog menu, select Upload Media... then you have to select a file from disk, And then the media upload dialog will ready to upload it:</para>
 209 <screenshot>
 210 <screeninfo>Upload Media</screeninfo>
 211   <mediaobject>
 212     <imageobject>
 213       <imagedata fileref="media-upload.png" format="PNG"/>
 214     </imageobject>
 215     <textobject>
 216       <phrase>Upload Media</phrase>
 217     </textobject>
 218   </mediaobject>
 219 </screenshot>
 220 <para>
 221 If your blog API supports media uploading, you have 2 options here, and if not, there is just one and it's &FTP; server.</para>
 222 <para>You can preview your desired file here (if it has any way to preview), and select it's name on server. And then Upload</para>
 223 <para>If you want to upload to a &FTP; server, the absolute path of the folder is required. And you have to enter a &URL; to use for guessing link of file on server.</para>
 224 </sect1>
 225
 226 </chapter>
 227
 228 <chapter id="menu-reference">
 229 <title>Menu Reference</title>
 230
 231 <sect1 id="file-menu">
 232 <title>The <guimenu>File</guimenu> Menu</title>
 233
 234 <variablelist>
 235 <varlistentry>
 236 <term><menuchoice>
 237 <shortcut>
 238 <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
 239 </shortcut>
 240 <guimenu>File</guimenu>
 241 <guimenuitem>Quit</guimenuitem>
 242 </menuchoice></term>
 243 <listitem><para><action>Quit</action> &kapplication;</para></listitem>
 244 </varlistentry>
 245 </variablelist>
 246
 247 </sect1>
 248
 249 <sect1 id="blog-menu">
 250 <title>The <guimenu>Blog</guimenu> Menu</title>
 251
 252 <variablelist>
 253 <varlistentry>
 254 <term><menuchoice>
 255 <guimenu>Blog</guimenu>
 256 <guimenuitem>Add Blog...</guimenuitem>
 257 </menuchoice></term>
 258 <listitem><para>A quick way to add a new blog.</para></listitem>
 259 </varlistentry>
 260
 261 <varlistentry>
 262 <term><menuchoice>
 263 <guimenu>Blog</guimenu>
 264 <guimenuitem>Upload Media...</guimenuitem>
 265 </menuchoice></term>
 266 <listitem><para>Open Media uploader, to upload files such as images to blog or &FTP; server.</para>
 267 <note><para>Only MetaWeblog and MovableType and Wordpress APIs support media uploading function.</para></note>
 268 </listitem>
 269 </varlistentry>
 270
 271 </variablelist>
 272
 273 </sect1>
 274
 275
 276 <sect1 id="post-menu">
 277 <title>The <guimenu>Post</guimenu> Menu</title>
 278
 279 <variablelist>
 280 <varlistentry>
 281 <term><menuchoice>
 282 <shortcut>
 283 <keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
 284 </shortcut>
 285 <guimenu>Post</guimenu>
 286 <guimenuitem>New Post</guimenuitem>
 287 </menuchoice></term>
 288 <listitem><para>Create a new and empty post.</para></listitem>
 289 </varlistentry>
 290
 291 <varlistentry>
 292 <term><menuchoice>
 293 <shortcut>
 294 <keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo>
 295 </shortcut>
 296 <guimenu>Post</guimenu>
 297 <guimenuitem>Save Locally</guimenuitem>
 298 </menuchoice></term>
 299 <listitem><para>Save current post locally.</para></listitem>
 300 </varlistentry>
 301
 302 <varlistentry>
 303 <term><menuchoice>
 304 <guimenu>Post</guimenu>
 305 <guimenuitem>Submit...</guimenuitem>
 306 </menuchoice></term>
 307 <listitem><para>Open Submit post dialog, to submit current active post, to current selected blog.</para>
 308 <para>In submit post, you can select if this post should submit as a draft or not.
 309 And additionally as an edit of current, or as a new post.</para>
 310 </listitem>
 311 </varlistentry>
 312
 313 </variablelist>
 314
 315 </sect1>
 316
 317 <sect1 id="settings-menu">
 318 <title>The <guimenu>Settings</guimenu> Menu</title>
 319
 320 <variablelist>
 321
 322 <varlistentry>
 323 <term><menuchoice>
 324 <guimenu>Settings</guimenu>
 325 <guimenuitem>Clear Cached Images</guimenuitem>
 326 </menuchoice></term>
 327 <listitem><para>Clear current image cache.</para></listitem>
 328 </varlistentry>
 329
 330 <varlistentry>
 331 <term><menuchoice>
 332 <shortcut>
 333 <keycombo action="simul">&Ctrl;<keycap>T</keycap></keycombo>
 334 </shortcut>
 335 <guimenu>Settings</guimenu>
 336 <guimenuitem>Show Toolbox</guimenuitem>
 337 </menuchoice></term>
 338 <listitem><para><action>Toggle</action> the toolbox on/off.</para></listitem>
 339 </varlistentry>
 340
 341 <varlistentry>
 342 <term><menuchoice>
 343 <guimenu>Settings</guimenu>
 344 <guimenuitem>Show Statusbar</guimenuitem>
 345 </menuchoice></term>
 346 <listitem><para><action>Toggle</action> the statusbar.</para></listitem>
 347 </varlistentry>
 348
 349 <varlistentry>
 350 <term><menuchoice>
 351 <guimenu>Settings</guimenu>
 352 <guimenuitem>Configure Shortcuts...</guimenuitem>
 353 </menuchoice></term>
 354 <listitem><para><action><action>Configure</action> the keyboard shortcuts used
 355 by &kapplication;.
 356 </action>
 357 </para></listitem>
 358 </varlistentry>
 359
 360 <varlistentry>
 361 <term><menuchoice>
 362 <guimenu>Settings</guimenu>
 363 <guimenuitem>Configure Toolbars...</guimenuitem>
 364 </menuchoice></term>
 365 <listitem><para><action>Configure</action> the items you want to put in the
 366 toolbar.
 367 </para></listitem>
 368 </varlistentry>
 369
 370 <varlistentry>
 371 <term><menuchoice>
 372 <guimenu>Settings</guimenu>
 373 <guimenuitem>Configure &kapplication;...</guimenuitem>
 374 </menuchoice></term>
 375 <listitem><para><action>Display</action> the &kapplication; settings dialog.
 376 </para></listitem>
 377 </varlistentry>
 378 </variablelist>
 379 </sect1>
 380
 381 <sect1>
 382 <title>The <guimenu>Help</guimenu> Menu</title>
 383 &help.menu.documentation;
 384 </sect1>
 385
 386 </chapter>
 387
 388 <chapter id="credits">
 389
 390 <title>Credits and License</title>
 391
 392 <para>&kapplication;</para>
 393 <para>
 394 Program copyright 2008-2009 &Mehrdad.Momeny;&Mehrdad.Momeny.mail; and
 395 &Golnaz.Nilieh;&Golnaz.Nilieh.mail;
 396 </para>
 397 <para>
 398 Documentation Copyright &copy; 2009 &Mehrdad.Momeny;&Mehrdad.Momeny.mail;
 399 </para>
 400
 401 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
 402
 403 &underFDL;               <!-- FDL: do not remove -->
 404 &underGPL;               <!-- GPL License -->
 405 </chapter>
 406
 407 <appendix id="installation">
 408 <title>Installation</title>
 409
 410 <sect1 id="getting-blogilo">
 411 <title>How to obtain &kapplication;</title>
 412
 413 &install.intro.documentation;
 414
 415 </sect1>
 416
 417 <sect1 id="compilation">
 418 <title>Compilation and Installation</title>
 419
 420 &install.compile.documentation;
 421
 422 </sect1>
 423
 424 </appendix>
 425
 426 &documentation.index;
 427 </book>
 428
 429 <!--
 430 Local Variables:
 431 mode: xml
 432 sgml-minimize-attributes:nil
 433 sgml-general-insert-case:lower
 434 sgml-indent-step:0
 435 sgml-indent-data:nil
 436 End:
 437
 438 vim:tabstop=2:shiftwidth=2:expandtab
 439 kate: space-indent on; indent-width 2; tab-width 2; indent-mode none;
 440 -->