mirror of
https://github.com/octoleo/telegram-bot-bash.git
synced 2025-01-23 13:48:24 +00:00
add references to bashbot doc
This commit is contained in:
Kay Marquardt (Gnadelwartz)
parent
bd4a1167e9
commit
293ad088e1
@ -17,6 +17,9 @@ Most complete [UTF-8 support for bashbot](doc/4_expert.md#Bashbot-UTF-8-Support)
|
||||
Bashbot [Documentation](https://github.com/topkecleon/telegram-bot-bash) and [Downloads](https://github.com/topkecleon/telegram-bot-bash/releases) are availible on www.github.com
|
||||
|
||||
## Documentation
|
||||
* [Bots: Introduction for developers] (https://core.telegram.org/bots)
|
||||
* [The one to rule them all](https://core.telegram.org/bots#3-how-do-i-create-a-bot)
|
||||
* [Bot commands](https://core.telegram.org/bots#commands)
|
||||
* [Install Bashbot](doc/0_install.md)
|
||||
* Install release
|
||||
* Install from githup
|
||||
@ -76,4 +79,4 @@ Bashbot is not more (in)secure as any other Bot written in any other language, w
|
||||
|
||||
If you feel that there's something missing or if you found a bug, feel free to submit a pull request!
|
||||
|
||||
#### $$VERSION$$ v0.70-pre1-0-g490c472
|
||||
#### $$VERSION$$ v0.70-pre1-1-gbd4a116
|
||||
|
||||
@ -27,6 +27,10 @@ are availible on www.github.com
|
||||
Documentation
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
* [Bots: Introduction for developers] (https://core.telegram.org/bots)
|
||||
** https://core.telegram.org/bots#3-how-do-i-create-a-bot[The one to
|
||||
rule them all]
|
||||
** https://core.telegram.org/bots#commands[Bot commands]
|
||||
* link:doc/0_install.md[Install Bashbot]
|
||||
** Install release
|
||||
** Install from githup
|
||||
@ -123,5 +127,5 @@ That's it!
|
||||
If you feel that there's something missing or if you found a bug, feel
|
||||
free to submit a pull request!
|
||||
|
||||
latexmath:[\[VERSION\]] v0.70-pre1-0-g490c472
|
||||
latexmath:[\[VERSION\]] v0.70-pre1-1-gbd4a116
|
||||
+++++++++++++++++++++++++++++++++++++++++++++
|
||||
|
||||
@ -12,6 +12,8 @@
|
||||
|
||||
Now your Bot is ready to start ...
|
||||
|
||||
If you are new to Bot development read [Bots: An introduction for developers](https://core.telegram.org/bots)
|
||||
|
||||
### Install from Github
|
||||
|
||||
As an alternative to download the zip files, you can clone the github repository to get the latest improvements/fixes.
|
||||
@ -61,5 +63,5 @@ The old format is supported for backward compatibility, but may fail for corner
|
||||
|
||||
#### [Next Create Bot](1_firstbot.md)
|
||||
|
||||
#### $$VERSION$$ v0.70-pre1-0-g490c472
|
||||
#### $$VERSION$$ v0.70-pre1-1-gbd4a116
|
||||
|
||||
|
||||
@ -1,5 +1,10 @@
|
||||
#### [Home](../README.md)
|
||||
## Create a Telegram Bot with botfather
|
||||
[BotFather is the one bot to rule them all](https://core.telegram.org/bots#3-how-do-i-create-a-bot). It will help you create new bots and change settings for existing ones.
|
||||
|
||||
[Commands known by Botfather](https://core.telegram.org/bots#generating-an-authorization-token)
|
||||
|
||||
### Creating a new Bot
|
||||
|
||||
1. Message @botfather https://telegram.me/botfather with the following
|
||||
text: `/newbot`
|
||||
@ -62,5 +67,5 @@ group. This step is up to you actually.
|
||||
#### [Prev Installation](0_install.md)
|
||||
#### [Next Getting started](2_usage.md)
|
||||
|
||||
#### $$VERSION$$ v0.70-pre1-0-g490c472
|
||||
#### $$VERSION$$ v0.70-pre1-1-gbd4a116
|
||||
|
||||
|
||||
@ -162,9 +162,10 @@ Allowed values: typing for text messages, upload_photo for photos, record_video
|
||||
```bash
|
||||
send_action "${CHAT[ID]}" "action"
|
||||
```
|
||||
See also [Bashbot function reference](6_reference.md)
|
||||
|
||||
#### [Prev Create Bot](1_firstbot.md)
|
||||
#### [Next Advanced Usage](3_advanced.md)
|
||||
|
||||
#### $$VERSION$$ v0.70-pre1-0-g490c472
|
||||
#### $$VERSION$$ v0.70-pre1-1-gbd4a116
|
||||
|
||||
|
||||
@ -56,6 +56,7 @@ You must use the function ```user_is_allowed``` to check if a user has the capab
|
||||
;;
|
||||
esac
|
||||
```
|
||||
See also [Bashbot User Access Control functions](6_functions.md#User_Access_Control)
|
||||
|
||||
### Interactive Chats
|
||||
To create interactive chats, write *(or edit the 'exmaples/question.sh' script)* a bash *(or C or python)* script, make it executable
|
||||
@ -166,5 +167,5 @@ answer_inline_query "$iQUERY_ID" "cached_sticker" "identifier for the sticker"
|
||||
#### [Prev Getting started](2_usage.md)
|
||||
#### [Next Expert Use](4_expert.md)
|
||||
|
||||
#### $$VERSION$$ v0.70-pre1-0-g490c472
|
||||
#### $$VERSION$$ v0.70-pre1-1-gbd4a116
|
||||
|
||||
|
||||
@ -59,6 +59,8 @@ send_normal_message "${CHAT[ID]}" "<b>bold</b> <i>italic><i> <em>italic>/em> <a
|
||||
|
||||
*old call:* forward "${CHAT[ID]}" "$FROMCHAT" "${MESSAGE[ID]}"
|
||||
|
||||
See also [Text formating options](https://core.telegram.org/bots/api#formatting-options)
|
||||
|
||||
----
|
||||
|
||||
##### delete_message
|
||||
@ -66,6 +68,7 @@ If your Bot is admin of a Chat he can delete every message, if not he can delete
|
||||
|
||||
*usage:* delete_message "${CHAT[ID]}" "${MESSAGE[ID]}"
|
||||
|
||||
See also [deleteMessage limitations](https://core.telegram.org/bots/api#deletemessage)
|
||||
----
|
||||
|
||||
##### answer_inline_query
|
||||
@ -125,6 +128,10 @@ send_keyboard "${CHAT[ID]}" "Enter digit" "[ \\"1\\" , \\"2\\" , \\"3\\" ] , [ \
|
||||
##### remove_keyboard
|
||||
*usage:* remove_keybord "$CHAT[ID]" "message"
|
||||
|
||||
See also: [Keyboard Markup](https://core.telegram.org/bots/api/#replykeyboardmarkup)
|
||||
|
||||
----
|
||||
|
||||
##### send_button
|
||||
*usage:* send_button "chat-id" "message" "text" "URL"
|
||||
|
||||
@ -153,6 +160,8 @@ send_inline_keyboard "${CHAT[ID]}" "" '[{"text":"button 1", url"":"url 1"}, {"te
|
||||
send_inline_keyboard "${CHAT[ID]}" "" '[{"text":"b 1", url"":"u 1"}, {"text":"b 2", url"":"u 2"}, {"text":"b 2", url"":"u 2"} ]'
|
||||
```
|
||||
|
||||
See also [Inline keyboard markup](https://core.telegram.org/bots/api/#inlinekeyboardmarkup)
|
||||
|
||||
----
|
||||
|
||||
### Manage users
|
||||
@ -185,6 +194,8 @@ if _is_admin ; then
|
||||
fi
|
||||
```
|
||||
|
||||
See also [kicki Chat Member](https://core.telegram.org/bots/api/#kickchatmember)
|
||||
|
||||
----
|
||||
|
||||
### User Access Control
|
||||
@ -223,8 +234,10 @@ if _is_admin ; then
|
||||
fi
|
||||
```
|
||||
|
||||
See also [ChatMember](https://core.telegram.org/bots/api/#chatmember)
|
||||
|
||||
##### user_is_allowed
|
||||
Bahsbot supports User Access Control, see [Advanced Usage](4_advanced.ma)
|
||||
Bahsbot supports User Access Control, see [Advanced Usage](4_advanced.md)
|
||||
|
||||
*usage:* user_is_allowed "${USER[ID]}" "what" "${CHAT[ID]}"
|
||||
|
||||
@ -453,6 +466,8 @@ Reads JSON fro STDIN and Outputs found Value to STDOUT
|
||||
##### get_chat_member_status
|
||||
*usage:* get_chat_member_status "${CHAT[ID]}" "${USER[ID]}"
|
||||
|
||||
this may get an official function ...
|
||||
|
||||
----
|
||||
|
||||
##### process_client
|
||||
@ -473,5 +488,5 @@ Send Input from Telegram to waiting Interactive Chat.
|
||||
#### [Prev Best Practice](5_practice.md)
|
||||
#### [Next Notes for Developers](7_develop.md)
|
||||
|
||||
#### $$VERSION$$ v0.70-pre1-0-g490c472
|
||||
#### $$VERSION$$ v0.70-pre1-1-gbd4a116
|
||||
|
||||
|
||||
@ -29,9 +29,9 @@ A typical bashbot develop loop looks as follow:
|
||||
After some development it may time to create a new version for the users. a new version can be in sub version upgrade, e.g. for fixes and smaller additions or
|
||||
a new release version for new features. To mark a new version use ```git tag NEWVERSION``` and run ```dev/version.sh``` to update all version strings.
|
||||
|
||||
Usually I start with some pre-x versions and when everything looks good I push out a release candidate (rc) and finally the new version.
|
||||
Usually I start with pre versions and when everything looks good I push out a release candidate (rc) and finally the new version.
|
||||
```
|
||||
v0.x-dev -> v0.x-pre-x -> v0.x-rc -> v0.x ... 0.x+1-dev ...
|
||||
v0.x-devx -> v0.x-prex -> v0.x-rc -> v0.x ... 0.x+1-dev ...
|
||||
```
|
||||
|
||||
### Versioning
|
||||
@ -92,5 +92,5 @@ fi
|
||||
#### [Prev Function Reference](6_function.md)
|
||||
#### [Next Bashbot Environment](8_custom.md)
|
||||
|
||||
#### $$VERSION$$ v0.70-pre1-0-g490c472
|
||||
#### $$VERSION$$ v0.70-pre1-1-gbd4a116
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user