Improve wording

This commit is contained in:
Tyrrrz 2023-12-28 23:56:19 +02:00
parent 1ad42ee48b
commit e04eb890e6
4 changed files with 34 additions and 12 deletions

View file

@ -30,8 +30,8 @@ public abstract class ExportCommandBase : DiscordCommandBase
"output", "output",
'o', 'o',
Description = "Output file or directory path. " Description = "Output file or directory path. "
+ "Directory path must end with a slash to avoid ambiguity. " + "If a directory is specified, file names will be generated automatically based on the channel names and export parameters. "
+ "If a directory is specified, file names will be generated automatically. " + "Directory paths must end with a slash to avoid ambiguity. "
+ "Supports template tokens, see the documentation for more info." + "Supports template tokens, see the documentation for more info."
)] )]
public string OutputPath public string OutputPath

View file

@ -13,7 +13,7 @@ public class GuideCommand : ICommand
{ {
// User token // User token
using (console.WithForegroundColor(ConsoleColor.White)) using (console.WithForegroundColor(ConsoleColor.White))
console.Output.WriteLine("To get user token:"); console.Output.WriteLine("To get the token for your personal account:");
console console
.Output .Output
@ -34,7 +34,7 @@ public class GuideCommand : ICommand
// Bot token // Bot token
using (console.WithForegroundColor(ConsoleColor.White)) using (console.WithForegroundColor(ConsoleColor.White))
console.Output.WriteLine("To get bot token:"); console.Output.WriteLine("To get the token for your bot:");
console.Output.WriteLine(" 1. Go to Discord developer portal"); console.Output.WriteLine(" 1. Go to Discord developer portal");
console.Output.WriteLine(" 2. Open your application's settings"); console.Output.WriteLine(" 2. Open your application's settings");
@ -43,13 +43,13 @@ public class GuideCommand : ICommand
console console
.Output .Output
.WriteLine( .WriteLine(
" * Your bot needs to have Message Content Intent enabled to read messages" " * Your bot needs to have the Message Content Intent enabled to read messages"
); );
console.Output.WriteLine(); console.Output.WriteLine();
// Guild or channel ID // Guild or channel ID
using (console.WithForegroundColor(ConsoleColor.White)) using (console.WithForegroundColor(ConsoleColor.White))
console.Output.WriteLine("To get guild ID or channel ID:"); console.Output.WriteLine("To get the ID of a guild or a channel:");
console.Output.WriteLine(" 1. Open Discord"); console.Output.WriteLine(" 1. Open Discord");
console.Output.WriteLine(" 2. Open Settings"); console.Output.WriteLine(" 2. Open Settings");
@ -64,13 +64,18 @@ public class GuideCommand : ICommand
// Docs link // Docs link
using (console.WithForegroundColor(ConsoleColor.White)) using (console.WithForegroundColor(ConsoleColor.White))
{
console console
.Output .Output
.WriteLine("If you have questions or issues, please refer to the documentation:"); .WriteLine("If you have questions or issues, please refer to the documentation:");
}
using (console.WithForegroundColor(ConsoleColor.DarkCyan)) using (console.WithForegroundColor(ConsoleColor.DarkCyan))
{
console console
.Output .Output
.WriteLine("https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs"); .WriteLine("https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs");
}
return default; return default;
} }

View file

@ -166,44 +166,55 @@
<Run <Run
FontSize="16" FontSize="16"
FontWeight="SemiBold" FontWeight="SemiBold"
Text="To get token for your personal account:" /> Text="To get the token for your personal account:" />
<LineBreak /> <LineBreak />
<Run Text="* Automating user accounts is technically against TOS —" /> <Run Text="* Automating user accounts is technically against TOS —" />
<Run FontWeight="SemiBold" Text="use at your own risk" /><Run Text="!" /> <Run FontWeight="SemiBold" Text="use at your own risk" /><Run Text="!" />
<LineBreak /> <LineBreak />
<Run Text="1. Open Discord in your" /> <Run Text="1. Open Discord in your" />
<Hyperlink Command="{s:Action OpenDiscord}"> <Hyperlink Command="{s:Action OpenDiscord}">
<Run Text="web browser" /> <Run Text="web browser" />
</Hyperlink> </Hyperlink>
<Run Text="and login" /> <Run Text="and login" />
<LineBreak /> <LineBreak />
<Run Text="2. Open any server or direct message channel" /> <Run Text="2. Open any server or direct message channel" />
<LineBreak /> <LineBreak />
<Run Text="3. Press" /> <Run Text="3. Press" />
<Run FontWeight="SemiBold" Text="Ctrl+Shift+I" /> <Run FontWeight="SemiBold" Text="Ctrl+Shift+I" />
<Run Text="to show developer tools" /> <Run Text="to show developer tools" />
<LineBreak /> <LineBreak />
<Run Text="4. Navigate to the" /> <Run Text="4. Navigate to the" />
<Run FontWeight="SemiBold" Text="Network" /> <Run FontWeight="SemiBold" Text="Network" />
<Run Text="tab" /> <Run Text="tab" />
<LineBreak /> <LineBreak />
<Run Text="5. Press" /> <Run Text="5. Press" />
<Run FontWeight="SemiBold" Text="Ctrl+R" /> <Run FontWeight="SemiBold" Text="Ctrl+R" />
<Run Text="to reload" /> <Run Text="to reload" />
<LineBreak /> <LineBreak />
<Run Text="6. Switch between random channels to trigger network requests" /> <Run Text="6. Switch between random channels to trigger network requests" />
<LineBreak /> <LineBreak />
<Run Text="7. Search for a request that starts with" /> <Run Text="7. Search for a request that starts with" />
<Run FontWeight="SemiBold" Text="messages" /> <Run FontWeight="SemiBold" Text="messages" />
<LineBreak /> <LineBreak />
<Run Text="8. Select the" /> <Run Text="8. Select the" />
<Run FontWeight="SemiBold" Text="Headers" /> <Run FontWeight="SemiBold" Text="Headers" />
<Run Text="tab on the right" /> <Run Text="tab on the right" />
<LineBreak /> <LineBreak />
<Run Text="9. Scroll down to the" /> <Run Text="9. Scroll down to the" />
<Run FontWeight="SemiBold" Text="Request Headers" /> <Run FontWeight="SemiBold" Text="Request Headers" />
<Run Text="section" /> <Run Text="section" />
<LineBreak /> <LineBreak />
<Run Text="10. Copy the value of the" /> <Run Text="10. Copy the value of the" />
<Run FontWeight="SemiBold" Text="authorization" /> <Run FontWeight="SemiBold" Text="authorization" />
<Run Text="header" /> <Run Text="header" />
@ -220,25 +231,30 @@
<Run <Run
FontSize="16" FontSize="16"
FontWeight="SemiBold" FontWeight="SemiBold"
Text="To get token for a bot account:" /> Text="To get the token for your bot:" />
<LineBreak /> <LineBreak />
<Run Text="1. Open Discord" /> <Run Text="1. Open Discord" />
<Hyperlink Command="{s:Action OpenDiscordDeveloperPortal}"> <Hyperlink Command="{s:Action OpenDiscordDeveloperPortal}">
<Run Text="developer portal" /> <Run Text="developer portal" />
</Hyperlink> </Hyperlink>
<LineBreak /> <LineBreak />
<Run Text="2. Open your application's settings" /> <Run Text="2. Open your application's settings" />
<LineBreak /> <LineBreak />
<Run Text="3. Navigate to the" /> <Run Text="3. Navigate to the" />
<Run FontWeight="SemiBold" Text="Bot" /> <Run FontWeight="SemiBold" Text="Bot" />
<Run Text="section on the left" /> <Run Text="section on the left" />
<LineBreak /> <LineBreak />
<Run Text="4. Under" /> <Run Text="4. Under" />
<Run FontWeight="SemiBold" Text="Token" /> <Run FontWeight="SemiBold" Text="Token" />
<Run Text="click" /> <Run Text="click" />
<Run FontWeight="SemiBold" Text="Copy" /> <Run FontWeight="SemiBold" Text="Copy" />
<LineBreak /> <LineBreak />
<Run Text="* Your bot needs to have" />
<Run Text="* Your bot needs to have the" />
<Run FontWeight="SemiBold" Text="Message Content Intent" /> <Run FontWeight="SemiBold" Text="Message Content Intent" />
<Run Text="enabled to read messages" /> <Run Text="enabled to read messages" />
<LineBreak /> <LineBreak />

View file

@ -89,8 +89,9 @@
<TextBox.ToolTip> <TextBox.ToolTip>
<TextBlock> <TextBlock>
<Run Text="Output file or directory path." /> <Run Text="Output file or directory path." />
<Run Text="If a directory is specified, file names will be generated automatically based on the channel names and other parameters." /> <Run Text="If a directory is specified, file names will be generated automatically based on the channel names and export parameters." />
<Run Text="Directory path should end with a slash to avoid ambiguity." /> <Run Text="Directory paths must end with a slash to avoid ambiguity." />
<Run Text="Supports template tokens, see the documentation for more info." />
<LineBreak /> <LineBreak />
<LineBreak /> <LineBreak />
<Run Text="Available template tokens:" /> <Run Text="Available template tokens:" />
@ -232,7 +233,7 @@
materialDesign:HintAssist.IsFloating="True" materialDesign:HintAssist.IsFloating="True"
Style="{DynamicResource MaterialDesignOutlinedTextBox}" Style="{DynamicResource MaterialDesignOutlinedTextBox}"
Text="{Binding MessageFilterValue}" Text="{Binding MessageFilterValue}"
ToolTip="Only include messages that satisfy this filter (e.g. 'from:foo#1234' or 'has:image')" /> ToolTip="Only include messages that satisfy this filter (e.g. 'from:foo#1234' or 'has:image'). See the documentation for more info." />
<!-- Markdown formatting --> <!-- Markdown formatting -->
<Grid Margin="16,8" ToolTip="Process markdown, mentions, and other special tokens"> <Grid Margin="16,8" ToolTip="Process markdown, mentions, and other special tokens">