Changeset 028ca92 for doc


Ignore:
Timestamp:
2016-09-21T02:48:14Z (3 years ago)
Author:
dequis <dx@…>
Branches:
master
Children:
35401cd
Parents:
7e4f439c
Message:

doc: some 'chat list' related help improvements

Location:
doc/user-guide
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • doc/user-guide/commands.xml

    r7e4f439c r028ca92  
    258258
    259259                        <para>
    260                                 Available actions: add, with. See <emphasis>help chat &lt;action&gt;</emphasis> for more information.
     260                                Available actions: add, with, list. See <emphasis>help chat &lt;action&gt;</emphasis> for more information.
    261261                        </para>
    262262
     
    272272
    273273                                <para>
    274                                         After adding a room to your list, you can simply use the IRC /join command to enter the room. Also, you can tell BitlBee to automatically join the room when you log in. (See <emphasis>chat set</emphasis>)
     274                                        After adding a room to your list, you can simply use the IRC /join command to enter the room. Also, you can tell BitlBee to automatically join the room when you log in. (<emphasis>channel &lt;channel&gt; set auto_join true</emphasis>)
    275275                                </para>
    276276
     
    287287                        <description>
    288288                                <para>
    289                                         List existing chatrooms provided by an account. BitlBee needs this to propogate an internal list of chats. The existing chat can then be added with <emphasis>chat add</emphasis>.
    290                                 </para>
    291                         </description>
     289                                        List existing chatrooms provided by an account. BitlBee needs this to propogate an internal list of chats. The existing chat can then be added with <emphasis>chat add</emphasis>, using the number in the index column after a "!" as a shortcut.
     290                                </para>
     291                        </description>
     292
     293                        <ircexample>
     294                                <ircline nick="dx">chat list facebook</ircline>
     295                                <ircline pre="1" nick="root">Index  Title                 Topic</ircline>
     296                                <ircline pre="1" nick="root">    1  869891016470949       cool kids club</ircline>
     297                                <ircline pre="1" nick="root">    2  457892181062459       uncool kids club</ircline>
     298                                <ircline nick="root">2 facebook chatrooms</ircline>
     299                                <ircline nick="dx">chat add facebook !1 #cool-kids-club</ircline>
     300                        </ircexample>
    292301                </bitlbee-command>
    293302
     
    298307                                <para>
    299308                                        While most <emphasis>chat</emphasis> subcommands are about named chatrooms, this command can be used to open an unnamed groupchat with one or more persons. This command is what <emphasis>/join #nickname</emphasis> used to do in older BitlBee versions.
     309                                </para>
     310
     311                                <para>
     312                                        Another way to do this is to join to a new, empty channel with <emphasis>/join #newchannel</emphasis> and invite the first person with <emphasis>/invite nickname</emphasis>
    300313                                </para>
    301314                        </description>
  • doc/user-guide/genhelp.py

    r7e4f439c r028ca92  
    6565
    6666    # Actually normalize whitespace
    67     tag.text = normalize(tag.text)
     67    if 'pre' not in tag.attrib:
     68        tag.text = normalize(tag.text)
    6869    tag.tail = normalize(tag.tail)
    6970
Note: See TracChangeset for help on using the changeset viewer.