update tutorials

Author: danlu1

docs/tutorials/python/tutorial_scripts/wiki.py

@@ -3,12 +3,13 @@
 Tutorial script demonstrating the Synapse Wiki models functionality.
 
 This script shows how to:
-1.
-2. Work with wiki headers and hierarchy
-3. Access wiki history
-4. Manage wiki order hints
-5. Handle attachments and markdown content
-6. Download wiki content and attachments
+1. Create, read, and update wiki pages
+2. Work with WikiPage Markdown
+3. Work with WikiPage Attachments
+4. Work with WikiHeader
+5. Work with WikiHistorySnapshot
+6. Work with WikiOrderHint
+7. Delete wiki pages
 """
 import gzip
 import os
@@ -119,7 +120,7 @@ def hello_world():
 """
 
 # Create wiki page from markdown text
-markdown_wiki = WikiPage(
+markdown_wiki_1 = WikiPage(
     owner_id=my_test_project.id,
     parent_id=wiki_page_1.id,
     title="Sub Page 2 created from markdown text",
@@ -133,21 +134,21 @@ def hello_world():
     gz.write("This is a markdown file")
 
 # Create wiki page from markdown file
-markdown_wiki = WikiPage(
+markdown_wiki_2 = WikiPage(
     owner_id=my_test_project.id,
     parent_id=wiki_page_1.id,
     title="Sub Page 3 created from markdown file",
     markdown=markdown_file_path,
 ).store()
 
 # Download the markdown file
-# delete the markdown file after downloading --> check if the file is downloaded
+# delete the markdown file after downloading
 os.remove(markdown_file_path)
-markdown_file = WikiPage(owner_id=my_test_project.id, id=markdown_wiki.id).get_markdown(
-    download_file=True, download_location=".", download_file_name="markdown_file.md"
-)
+markdown_file_2 = WikiPage(
+    owner_id=my_test_project.id, id=markdown_wiki_2.id
+).get_markdown(download_file=True, download_location=".")
 
-print(f"Markdown file downloaded to: {markdown_file}")
+print(f"Markdown file downloaded to: {markdown_file_2}")
 
 # Section 3: WikiPage with Attachments
 # Create a temporary file for the attachment

docs/tutorials/python/wiki.md

@@ -12,73 +12,83 @@ The Synapse Wiki models include:
 - **WikiHistorySnapshot**: Provides access to wiki version history
 - **WikiOrderHint**: Manages the order of wiki pages within an entity
 
+This tutorial shows how to:
+1. Create, read, and update wiki pages
+2. Work with WikiPage Markdown
+3. Work with WikiPage Attachments
+4. Work with WikiHeader
+5. Work with WikiHistorySnapshot
+6. Work with WikiOrderHint
+7. Delete wiki pages
+
 ## Basic Setup
 ```python
-{!docs/tutorials/python/tutorial_scripts/wiki.py!lines=13-28}
+{!docs/tutorials/python/tutorial_scripts/wiki.py!lines=14-29}
 ```
 
 ## 1. Create, read, and update wiki pages
 ### Create a new wiki page for the project with plain text markdown
 ```python
-{!docs/tutorials/python/tutorial_scripts/wiki.py!lines=32-36}
+{!docs/tutorials/python/tutorial_scripts/wiki.py!lines=33-37}
 ```
 
 ### OR you can create a wiki page with an existing markdown file
 ```python
-{!docs/tutorials/python/tutorial_scripts/wiki.py!lines=39-44}
+{!docs/tutorials/python/tutorial_scripts/wiki.py!lines=40-45}
 ```
 
 ### Create a new wiki page with updated content
 ```python
-{!docs/tutorials/python/tutorial_scripts/wiki.py!lines=47-52}
+{!docs/tutorials/python/tutorial_scripts/wiki.py!lines=48-53}
 ```
 
 ### Restore the wiki page to the original version
 ```python
-{!docs/tutorials/python/tutorial_scripts/wiki.py!lines=55-63}
+{!docs/tutorials/python/tutorial_scripts/wiki.py!lines=56-64}
 ```
 
 ### Create a sub-wiki page
 ```python
-{!docs/tutorials/python/tutorial_scripts/wiki.py!lines=66-71}
+{!docs/tutorials/python/tutorial_scripts/wiki.py!lines=67-72}
 ```
 
 ### Get an existing wiki page for the project, now you can see one root wiki page and one sub-wiki page
 ```python
-{!docs/tutorials/python/tutorial_scripts/wiki.py!lines=74-75}
+{!docs/tutorials/python/tutorial_scripts/wiki.py!lines=75-76}
 ```
 
 ### Retrieving a Wiki Page
 Note: You need to know the wiki page ID or wiki page title to retrieve it
 #### Retrieve a Wiki Page with wiki page ID
 ```python
-{!docs/tutorials/python/tutorial_scripts/wiki.py!lines=78-79}
+{!docs/tutorials/python/tutorial_scripts/wiki.py!lines=79-80}
 ```
 
 #### Retrieve a Wiki Page with wiki page title
 ```python
-{!docs/tutorials/python/tutorial_scripts/wiki.py!lines=82-83}
+{!docs/tutorials/python/tutorial_scripts/wiki.py!lines=83-84}
 ```
 
 #### Check if the retrieved wiki page is the same as the original wiki page
 ```python
-{!docs/tutorials/python/tutorial_scripts/wiki.py!lines=86-91}
+{!docs/tutorials/python/tutorial_scripts/wiki.py!lines=87-92}
 ```
 
 ## 2. WikiPage Markdown Operations
 ### Create wiki page from markdown text
 ```python
-{!docs/tutorials/python/tutorial_scripts/wiki.py!lines=95-118}
+{!docs/tutorials/python/tutorial_scripts/wiki.py!lines=96-119}
 ```
 
-### Create wiki page from  a markdown file
+### Create wiki page from a markdown file
 ```python
-{!docs/tutorials/python/tutorial_scripts/wiki.py!lines=122-132}
+{!docs/tutorials/python/tutorial_scripts/wiki.py!lines=123-133}
 ```
 
 ### Download the markdown file
+Note: If the markdown is generated from plain text using the client, the downloaded file will be named wiki_markdown_<wiki_page_id>.md.gz. If it is generated from an existing markdown file, the downloaded file will retain the original filename with the .gz suffix appended.
 ```python
-{!docs/tutorials/python/tutorial_scripts/wiki.py!lines=136-143}
+{!docs/tutorials/python/tutorial_scripts/wiki.py!lines=137-143}
 ```
 
 ## 3. WikiPage Attachments Operations
@@ -92,7 +102,7 @@ Note: You need to know the wiki page ID or wiki page title to retrieve it
 ```
 ### Download an attachment
 ```python
-{!docs/tutorials/python/tutorial_scripts/wiki.py!lines=168-175}
+{!docs/tutorials/python/tutorial_scripts/wiki.py!lines=167-175}
 ```
 
 ### Get attachment URL without downloading
@@ -117,7 +127,7 @@ Note: You need to know the wiki page ID or wiki page title to retrieve it
 
 ### Accessing Wiki History
 ```python
-{!docs/tutorials/python/tutorial_scripts/wiki.py!lines=203-207}
+{!docs/tutorials/python/tutorial_scripts/wiki.py!lines=204-208}
 ```
 
 ## 6. WikiOrderHint - Managing Wiki Order