From 51582ce5f109b295c333fea6db2b8ccc617dded2 Mon Sep 17 00:00:00 2001 From: Daniil Gentili Date: Wed, 21 Mar 2018 10:53:02 +0100 Subject: [PATCH] Add tip to visit try.madelineproto.xyz --- README.md | 10 +++++----- build_docs_index.php | 5 +++-- docs/docs/CALLS.md | 4 +++- docs/docs/CHAT_INFO.md | 4 +++- docs/docs/{CONTRIBUTING.md => CONTRIB.md} | 4 +++- docs/docs/CREATING_A_CLIENT.md | 4 +++- docs/docs/DIALOGS.md | 4 +++- docs/docs/EXCEPTIONS.md | 4 +++- docs/docs/FEATURES.md | 4 +++- docs/docs/FILES.md | 4 +++- docs/docs/FLOOD_WAIT.md | 4 +++- docs/docs/INLINE_BUTTONS.md | 4 +++- docs/docs/INSTALLATION.md | 4 +++- docs/docs/LOGGING.md | 4 +++- docs/docs/LOGIN.md | 4 +++- docs/docs/LUA.md | 4 +++- docs/docs/PROXY.md | 4 +++- docs/docs/REQUIREMENTS.md | 4 +++- docs/docs/SECRET_CHATS.md | 4 +++- docs/docs/SELF.md | 4 +++- docs/docs/SETTINGS.md | 4 +++- docs/docs/TEMPLATES.md | 2 ++ docs/docs/UPDATES.md | 4 +++- docs/docs/USING_METHODS.md | 4 +++- docs/index.md | 10 +++++----- 25 files changed, 78 insertions(+), 33 deletions(-) rename docs/docs/{CONTRIBUTING.md => CONTRIB.md} (94%) diff --git a/README.md b/README.md index d96435f9..4bf0e067 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ $MadelineProto->messages->sendMessage(['peer' => 'https://t.me/joinchat/Bgrajz6K echo 'OK, done!'.PHP_EOL; ``` -Run this code in a browser or in a console. +[Try this code now!](https://try.madelineproto.xyz) or run this code in a browser or in a console. Tip: if you receive an error (or nothing), [send us](https://t.me/pwrtelegramgroup) the error message and the `MadelineProto.log` file that was created in the same directory (if running from a browser). @@ -125,10 +125,10 @@ Tip: if you receive an error (or nothing), [send us](https://t.me/pwrtelegramgro * [Sending secret messages](https://docs.madelineproto.xyz/docs/SECRET_CHATS.html#sending-secret-messages) * [Lua binding](https://docs.madelineproto.xyz/docs/LUA.html) * [Using a proxy](https://docs.madelineproto.xyz/docs/PROXY.html) -* [Contributing](https://docs.madelineproto.xyz/docs/CONTRIBUTING.html) - * [Translation](https://docs.madelineproto.xyz/docs/CONTRIBUTING.html#translation) - * [Contribution guide](https://docs.madelineproto.xyz/docs/CONTRIBUTING.html#contribution-guide) - * [Credits](https://docs.madelineproto.xyz/docs/CONTRIBUTING.html#credits) +* [Contributing](https://docs.madelineproto.xyz/docs/CONTRIB.html) + * [Translation](https://docs.madelineproto.xyz/docs/CONTRIB.html#translation) + * [Contribution guide](https://docs.madelineproto.xyz/docs/CONTRIB.html#contribution-guide) + * [Credits](https://docs.madelineproto.xyz/docs/CONTRIB.html#credits) * [Web templates for `$MadelineProto->start()`](https://docs.madelineproto.xyz/docs/TEMPLATES.html) diff --git a/build_docs_index.php b/build_docs_index.php index c4fdb49e..2eb94200 100644 --- a/build_docs_index.php +++ b/build_docs_index.php @@ -43,7 +43,7 @@ foreach ($files as $file) { $orderedfiles[18] = $file; } else if ($base === 'PROXY') { $orderedfiles[19] = $file; - } else if ($base === 'CONTRIBUTING') { + } else if ($base === 'CONTRIB') { $orderedfiles[20] = $file; } else if ($base === 'TEMPLATES') { $orderedfiles[21] = $file; @@ -61,7 +61,8 @@ foreach ($orderedfiles as $key => $filename) { } if (isset($orderedfiles[$key+1])) { $nextfile = "https://docs.madelineproto.xyz/docs/".basename($orderedfiles[$key+1], '.md').".html"; - $lines[count($lines)] = "\n
"; + $prevfile = $key === 0 ? "https://docs.madelineproto.xyz" : "https://docs.madelineproto.xyz/docs/".basename($orderedfiles[$key-1], '.md').".html"; + $lines[count($lines)] = "\n
"; } else { $lines[count($lines)] = "\n
"; } diff --git a/docs/docs/CALLS.md b/docs/docs/CALLS.md index b29827d4..f68cd38e 100644 --- a/docs/docs/CALLS.md +++ b/docs/docs/CALLS.md @@ -120,4 +120,6 @@ foreach ($updates as $update) { -
\ No newline at end of file + + +
\ No newline at end of file diff --git a/docs/docs/CHAT_INFO.md b/docs/docs/CHAT_INFO.md index 2073ca77..3c7b95a2 100644 --- a/docs/docs/CHAT_INFO.md +++ b/docs/docs/CHAT_INFO.md @@ -45,4 +45,6 @@ You can also use `get_info` to get chat info, see [here for the parameters and t -
\ No newline at end of file + + +
\ No newline at end of file diff --git a/docs/docs/CONTRIBUTING.md b/docs/docs/CONTRIB.md similarity index 94% rename from docs/docs/CONTRIBUTING.md rename to docs/docs/CONTRIB.md index b44351ad..fa0c791c 100644 --- a/docs/docs/CONTRIBUTING.md +++ b/docs/docs/CONTRIB.md @@ -92,4 +92,6 @@ Thanks to the devs that contributed to these projects, MadelineProto is now an e -
\ No newline at end of file + + +
\ No newline at end of file diff --git a/docs/docs/CREATING_A_CLIENT.md b/docs/docs/CREATING_A_CLIENT.md index 888e3bbd..f709dea2 100644 --- a/docs/docs/CREATING_A_CLIENT.md +++ b/docs/docs/CREATING_A_CLIENT.md @@ -23,4 +23,6 @@ $MadelineProto->session = 'newsession.madeline'; -
\ No newline at end of file + + +
\ No newline at end of file diff --git a/docs/docs/DIALOGS.md b/docs/docs/DIALOGS.md index 2b3c040b..3286797f 100644 --- a/docs/docs/DIALOGS.md +++ b/docs/docs/DIALOGS.md @@ -34,4 +34,6 @@ Since bots cannot run `get_dialogs`, you must make use of the internal MadelineP -
\ No newline at end of file + + +
\ No newline at end of file diff --git a/docs/docs/EXCEPTIONS.md b/docs/docs/EXCEPTIONS.md index 3e017bb2..eed0a81a 100644 --- a/docs/docs/EXCEPTIONS.md +++ b/docs/docs/EXCEPTIONS.md @@ -109,4 +109,6 @@ try { -
\ No newline at end of file + + +
\ No newline at end of file diff --git a/docs/docs/FEATURES.md b/docs/docs/FEATURES.md index 0baa6981..838fb457 100644 --- a/docs/docs/FEATURES.md +++ b/docs/docs/FEATURES.md @@ -45,4 +45,6 @@ -
\ No newline at end of file + + +
\ No newline at end of file diff --git a/docs/docs/FILES.md b/docs/docs/FILES.md index 34ae9105..bb197a88 100644 --- a/docs/docs/FILES.md +++ b/docs/docs/FILES.md @@ -430,4 +430,6 @@ $output_file_name = $MadelineProto->download_to_file( -
\ No newline at end of file + + +
\ No newline at end of file diff --git a/docs/docs/FLOOD_WAIT.md b/docs/docs/FLOOD_WAIT.md index b32f9239..ee1104ee 100644 --- a/docs/docs/FLOOD_WAIT.md +++ b/docs/docs/FLOOD_WAIT.md @@ -16,4 +16,6 @@ Use sleep to execute max N calls in `floodwaitrate` seconds, this way you won't -
\ No newline at end of file + + +
\ No newline at end of file diff --git a/docs/docs/INLINE_BUTTONS.md b/docs/docs/INLINE_BUTTONS.md index 8337f18b..531e9fa3 100644 --- a/docs/docs/INLINE_BUTTONS.md +++ b/docs/docs/INLINE_BUTTONS.md @@ -55,4 +55,6 @@ $button->click(); -
\ No newline at end of file + + +
\ No newline at end of file diff --git a/docs/docs/INSTALLATION.md b/docs/docs/INSTALLATION.md index 3c96519c..52c68983 100644 --- a/docs/docs/INSTALLATION.md +++ b/docs/docs/INSTALLATION.md @@ -124,4 +124,6 @@ Now open `.env` and edit its values as needed. -
\ No newline at end of file + + +
\ No newline at end of file diff --git a/docs/docs/LOGGING.md b/docs/docs/LOGGING.md index 9d47a0dc..3841ce37 100644 --- a/docs/docs/LOGGING.md +++ b/docs/docs/LOGGING.md @@ -21,4 +21,6 @@ By default, `$level` is `\danog\MadelineProto\Logger:NOTICE`. -
\ No newline at end of file + + +
\ No newline at end of file diff --git a/docs/docs/LOGIN.md b/docs/docs/LOGIN.md index fa1a8058..50488894 100644 --- a/docs/docs/LOGIN.md +++ b/docs/docs/LOGIN.md @@ -62,4 +62,6 @@ Use `logout` to logout, see [here for the parameters and the result](https://doc -
\ No newline at end of file + + +
\ No newline at end of file diff --git a/docs/docs/LUA.md b/docs/docs/LUA.md index d80471e8..550af13c 100644 --- a/docs/docs/LUA.md +++ b/docs/docs/LUA.md @@ -20,4 +20,6 @@ td-cli wrappers are also present: you can use the tdcli_function in lua and pass -
\ No newline at end of file + + +
\ No newline at end of file diff --git a/docs/docs/PROXY.md b/docs/docs/PROXY.md index 5f37f78b..3c305b85 100644 --- a/docs/docs/PROXY.md +++ b/docs/docs/PROXY.md @@ -124,4 +124,6 @@ Can return additional HTTP headers to use when the HTTP protocol is being used. -
\ No newline at end of file + + +
\ No newline at end of file diff --git a/docs/docs/REQUIREMENTS.md b/docs/docs/REQUIREMENTS.md index 86a66525..5dfb524a 100644 --- a/docs/docs/REQUIREMENTS.md +++ b/docs/docs/REQUIREMENTS.md @@ -17,4 +17,6 @@ Next, follow the instructions on voip.madelineproto.xyz and prime.madelineproto. -
\ No newline at end of file + + +
\ No newline at end of file diff --git a/docs/docs/SECRET_CHATS.md b/docs/docs/SECRET_CHATS.md index eb27ae8a..9e37c4f4 100644 --- a/docs/docs/SECRET_CHATS.md +++ b/docs/docs/SECRET_CHATS.md @@ -72,4 +72,6 @@ This method gets info about a certain chat. -
\ No newline at end of file + + +
\ No newline at end of file diff --git a/docs/docs/SELF.md b/docs/docs/SELF.md index 6c804757..7d26183b 100644 --- a/docs/docs/SELF.md +++ b/docs/docs/SELF.md @@ -12,4 +12,6 @@ $me = $MadelineProto->get_self(); -
\ No newline at end of file + + +
\ No newline at end of file diff --git a/docs/docs/SETTINGS.md b/docs/docs/SETTINGS.md index 2670daf8..a5a0cfcf 100644 --- a/docs/docs/SETTINGS.md +++ b/docs/docs/SETTINGS.md @@ -401,4 +401,6 @@ $MadelineProto->settings['updates']['handle_updates'] = true; // reenable update -
\ No newline at end of file + + +
\ No newline at end of file diff --git a/docs/docs/TEMPLATES.md b/docs/docs/TEMPLATES.md index 344d665b..19f59e2b 100644 --- a/docs/docs/TEMPLATES.md +++ b/docs/docs/TEMPLATES.md @@ -32,4 +32,6 @@ $MadelineProto->set_web_template($new_template); The new template must have a structure similar the the default template. + +
\ No newline at end of file diff --git a/docs/docs/UPDATES.md b/docs/docs/UPDATES.md index 26a9e9cd..3529a144 100644 --- a/docs/docs/UPDATES.md +++ b/docs/docs/UPDATES.md @@ -202,4 +202,6 @@ Note that multiprocessing is not the same as multithreading, and should be avoid -
\ No newline at end of file + + +
\ No newline at end of file diff --git a/docs/docs/USING_METHODS.md b/docs/docs/USING_METHODS.md index 0c007719..bad63001 100644 --- a/docs/docs/USING_METHODS.md +++ b/docs/docs/USING_METHODS.md @@ -101,4 +101,6 @@ If the queue if the specified queue name does not exist, it will be created. -
\ No newline at end of file + + +
\ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 8ad95b0d..fa5f6b93 100644 --- a/docs/index.md +++ b/docs/index.md @@ -43,7 +43,7 @@ $MadelineProto->messages->sendMessage(['peer' => 'https://t.me/joinchat/Bgrajz6K echo 'OK, done!'.PHP_EOL; ``` -Run this code in a browser or in a console. +[Try this code now!](https://try.madelineproto.xyz) or run this code in a browser or in a console. Tip: if you receive an error (or nothing), [send us](https://t.me/pwrtelegramgroup) the error message and the `MadelineProto.log` file that was created in the same directory (if running from a browser). @@ -129,10 +129,10 @@ Tip: if you receive an error (or nothing), [send us](https://t.me/pwrtelegramgro * [Sending secret messages](https://docs.madelineproto.xyz/docs/SECRET_CHATS.html#sending-secret-messages) * [Lua binding](https://docs.madelineproto.xyz/docs/LUA.html) * [Using a proxy](https://docs.madelineproto.xyz/docs/PROXY.html) -* [Contributing](https://docs.madelineproto.xyz/docs/CONTRIBUTING.html) - * [Translation](https://docs.madelineproto.xyz/docs/CONTRIBUTING.html#translation) - * [Contribution guide](https://docs.madelineproto.xyz/docs/CONTRIBUTING.html#contribution-guide) - * [Credits](https://docs.madelineproto.xyz/docs/CONTRIBUTING.html#credits) +* [Contributing](https://docs.madelineproto.xyz/docs/CONTRIB.html) + * [Translation](https://docs.madelineproto.xyz/docs/CONTRIB.html#translation) + * [Contribution guide](https://docs.madelineproto.xyz/docs/CONTRIB.html#contribution-guide) + * [Credits](https://docs.madelineproto.xyz/docs/CONTRIB.html#credits) * [Web templates for `$MadelineProto->start()`](https://docs.madelineproto.xyz/docs/TEMPLATES.html)