From 34879db4c89fe53afab93a2361691b456aa9106f Mon Sep 17 00:00:00 2001
From: George Drak <sonicgd@gmail.com>
Date: Sun, 15 Aug 2021 16:38:14 +0500
Subject: [PATCH] feat(forms): add form field descriptions

---
 src/BioEngine.Admin/Pages/Pages/Edit.razor    |  7 +++++--
 src/BioEngine.Admin/Pages/Posts/Edit.razor    |  8 ++++++--
 .../Pages/Sections/Developers/Edit.razor      | 17 ++++++++++-------
 .../Pages/Sections/Games/Edit.razor           | 19 +++++++++++--------
 .../Pages/Sections/Topics/Edit.razor          | 13 ++++++++-----
 src/BioEngine.Admin/Pages/Sites/Edit.razor    | 11 +++++++----
 src/BioEngine.Admin/Pages/Tags/Edit.razor     |  3 ++-
 src/BioEngine.Admin/Web/src/index.scss        |  4 ++++
 8 files changed, 53 insertions(+), 29 deletions(-)

diff --git a/src/BioEngine.Admin/Pages/Pages/Edit.razor b/src/BioEngine.Admin/Pages/Pages/Edit.razor
index 6724540..414a118 100644
--- a/src/BioEngine.Admin/Pages/Pages/Edit.razor
+++ b/src/BioEngine.Admin/Pages/Pages/Edit.razor
@@ -23,10 +23,12 @@
         </Extra>
         <ChildContent>
             <FormItem Label="Заголовок">
-                <AntDesign.Input @bind-Value="@context.Entity.Title"/>
+                <AntDesign.Input @bind-Value="@context.Entity.Title" Placeholder="О сайте"/>
+                <Text Type="secondary">Заголовок страницы</Text>
             </FormItem>
             <FormItem Label="Адрес">
-                <AntDesign.Input @bind-Value="@context.Entity.Url"/>
+                <AntDesign.Input @bind-Value="@context.Entity.Url" Placeholder="about"/>
+                <Text Type="secondary">Адрес страницы на сайте — https://www.bioware.ru/pages/about.html</Text>
             </FormItem>
             <FormItem Label="Сайты">
                 <AntDesign.Select Mode="multiple"
@@ -41,6 +43,7 @@
                                   TItem="Site"
                                   EnableSearch
                                   AllowClear/>
+                <Text Type="secondary">Сайты, на которых будет показываться страница</Text>
             </FormItem>
             <AntBlocklyForm TEntity="Page" TForm="PageForm" @bind-Value="context.Entity.Blocks" Form="context" Options="context.BlocksOptions"></AntBlocklyForm>
         </ChildContent>
diff --git a/src/BioEngine.Admin/Pages/Posts/Edit.razor b/src/BioEngine.Admin/Pages/Posts/Edit.razor
index 936128e..33ad417 100644
--- a/src/BioEngine.Admin/Pages/Posts/Edit.razor
+++ b/src/BioEngine.Admin/Pages/Posts/Edit.razor
@@ -38,12 +38,14 @@
             <Row Gutter="24">
                 <AntDesign.Col Span="12">
                     <FormItem Label="Заголовок">
-                        <AntDesign.Input @bind-Value="@context.Entity.Title" OnkeyUp="context.TitleChanged"/>
+                        <AntDesign.Input @bind-Value="@context.Entity.Title" OnkeyUp="context.TitleChanged" Placeholder="Новый пост"/>
+                        <Text Type="secondary">Заголовок поста</Text>
                     </FormItem>
                 </AntDesign.Col>
                 <AntDesign.Col Span="12">
                     <FormItem Label="Адрес">
-                        <AntDesign.Input @bind-Value="@context.Entity.Url"/>
+                        <AntDesign.Input @bind-Value="@context.Entity.Url" Placeholder="newpost"/>
+                        <Text Type="secondary">Адрес поста на сайте — https://www.bioware.ru/posts/newpost.html</Text>
                     </FormItem>
                 </AntDesign.Col>
             </Row>
@@ -63,6 +65,7 @@
                                           EnableSearch
                                           AllowClear>
                         </AntDesign.Select>
+                        <Text Type="secondary">Разделы, к которым относится пост</Text>
                     </FormItem>
                 </AntDesign.Col>
                 <AntDesign.Col Span="12">
@@ -80,6 +83,7 @@
                                           EnableSearch
                                           AllowClear>
                         </AntDesign.Select>
+                        <Text Type="secondary">Тэги, описывающие пост</Text>
                     </FormItem>
                 </AntDesign.Col>
             </Row>
diff --git a/src/BioEngine.Admin/Pages/Sections/Developers/Edit.razor b/src/BioEngine.Admin/Pages/Sections/Developers/Edit.razor
index 002ad6b..1831a35 100644
--- a/src/BioEngine.Admin/Pages/Sections/Developers/Edit.razor
+++ b/src/BioEngine.Admin/Pages/Sections/Developers/Edit.razor
@@ -37,19 +37,21 @@
         <ChildContent>
             <Row Gutter="24">
                 <AntDesign.Col Span="12">
-                    <FormItem Label="Заголовок">
-                        <AntDesign.Input @bind-Value="@context.Entity.Title" OnkeyUp="context.TitleChanged"/>
+                    <FormItem Label="Название">
+                        <AntDesign.Input @bind-Value="@context.Entity.Title" OnkeyUp="context.TitleChanged" Placeholder="Название разработчик"/>
+                        <Text Type="secondary">Название разработчика</Text>
                     </FormItem>
                 </AntDesign.Col>
                 <AntDesign.Col Span="12">
                     <FormItem Label="Адрес">
-                        <AntDesign.Input @bind-Value="@context.Entity.Url"/>
+                        <AntDesign.Input @bind-Value="@context.Entity.Url" Placeholder="developername"/>
+                        <Text Type="secondary">Адрес разработчика на сайте — https://www.bioware.ru/developers/developername.html</Text>
                     </FormItem>
                 </AntDesign.Col>
             </Row>
             <Row Gutter="24">
                 <AntDesign.Col Span="12">
-                    <FormItem Label="Сайты" >
+                    <FormItem Label="Сайты">
                         <AntDesign.Select Mode="multiple"
                                           DataSource="@context.SitesList"
                                           @bind-Value="@context.DummySiteId"
@@ -62,11 +64,13 @@
                                           TItem="Site"
                                           EnableSearch
                                           AllowClear/>
+                        <Text Type="secondary">Сайты, на которых отображать разработчика</Text>
                     </FormItem>
                 </AntDesign.Col>
                 <AntDesign.Col Span="12">
                     <FormItem Label="Хештег">
-                        <AntDesign.Input @bind-Value="@context.Entity.Data.Hashtag"/>
+                        <AntDesign.Input @bind-Value="@context.Entity.Data.Hashtag" Placeholder="developername"/>
+                        <Text Type="secondary">Хештег для публикаций в соцсетях</Text>
                     </FormItem>
                 </AntDesign.Col>
             </Row>
@@ -74,10 +78,9 @@
                 <AntDesign.Col Span="12">
                     <FormItem Label="Картинка в шапку">
                         <AntStorageImageInput @bind-Value="@context.Entity.Data.HeaderPicture" Storage="@context.Storage" UploadPath="/developers" GenerateMetadata="@StorageUploadExtensions.GenerateMetadataAsync"></AntStorageImageInput>
+                        <Text Type="secondary">Картинка в шапке на странице разработчика</Text>
                     </FormItem>
                 </AntDesign.Col>
-                <AntDesign.Col Span="12">
-                </AntDesign.Col>
             </Row>
             <AntBlocklyForm TEntity="Developer" TForm="DeveloperForm" @bind-Value="context.Entity.Blocks" Form="context" Options="context.BlocksOptions"></AntBlocklyForm>
         </ChildContent>
diff --git a/src/BioEngine.Admin/Pages/Sections/Games/Edit.razor b/src/BioEngine.Admin/Pages/Sections/Games/Edit.razor
index 9a5641e..676ca61 100644
--- a/src/BioEngine.Admin/Pages/Sections/Games/Edit.razor
+++ b/src/BioEngine.Admin/Pages/Sections/Games/Edit.razor
@@ -13,8 +13,8 @@
                     <a href="/">BRCGames</a>
                 </BreadcrumbItem>
                 <BreadcrumbItem>
-                                    <a href="/Games">Игры</a>
-                                </BreadcrumbItem>
+                    <a href="/Games">Игры</a>
+                </BreadcrumbItem>
             </Breadcrumb>
         </Breadcrumb>
         <Extra>
@@ -37,13 +37,15 @@
         <ChildContent>
             <Row Gutter="24">
                 <AntDesign.Col Span="12">
-                    <FormItem Label="Заголовок">
-                        <Input @bind-Value="@context.Entity.Title" OnkeyUp="context.TitleChanged"/>
+                    <FormItem Label="Название">
+                        <Input @bind-Value="@context.Entity.Title" OnkeyUp="context.TitleChanged" Placeholder="Название игры"/>
+                        <Text Type="secondary">Название игры</Text>
                     </FormItem>
                 </AntDesign.Col>
                 <AntDesign.Col Span="12">
                     <FormItem Label="Адрес">
-                        <Input @bind-Value="@context.Entity.Url"/>
+                        <Input @bind-Value="@context.Entity.Url" Placeholder="gamename"/>
+                        <Text Type="secondary">Адрес игры на сайте — https://www.bioware.ru/games/gamename.html</Text>
                     </FormItem>
                 </AntDesign.Col>
             </Row>
@@ -63,11 +65,13 @@
                                 EnableSearch
                                 AllowClear>
                         </Select>
+                        <Text Type="secondary">Сайты, на которых отображать игру</Text>
                     </FormItem>
                 </AntDesign.Col>
                 <AntDesign.Col Span="12">
                     <FormItem Label="Хештег">
-                        <Input @bind-Value="@context.Entity.Data.Hashtag"/>
+                        <Input @bind-Value="@context.Entity.Data.Hashtag" Placeholder="gamename"/>
+                        <Text Type="secondary">Хештег для публикации в соцсетях</Text>
                     </FormItem>
                 </AntDesign.Col>
             </Row>
@@ -75,10 +79,9 @@
                 <AntDesign.Col Span="12">
                     <FormItem Label="Картинка в шапку">
                         <AntStorageImageInput @bind-Value="@context.Entity.Data.HeaderPicture" Storage="@context.Storage" UploadPath="/games" GenerateMetadata="@StorageUploadExtensions.GenerateMetadataAsync"></AntStorageImageInput>
+                        <Text Type="secondary">Картинка в шапке на странице игры</Text>
                     </FormItem>
                 </AntDesign.Col>
-                <AntDesign.Col Span="12">
-                </AntDesign.Col>
             </Row>
             <AntBlocklyForm TEntity="Game" TForm="GameForm" @bind-Value="context.Entity.Blocks" Form="context" Options="context.BlocksOptions"></AntBlocklyForm>
         </ChildContent>
diff --git a/src/BioEngine.Admin/Pages/Sections/Topics/Edit.razor b/src/BioEngine.Admin/Pages/Sections/Topics/Edit.razor
index 6500730..0801583 100644
--- a/src/BioEngine.Admin/Pages/Sections/Topics/Edit.razor
+++ b/src/BioEngine.Admin/Pages/Sections/Topics/Edit.razor
@@ -37,13 +37,15 @@
         <ChildContent>
             <Row Gutter="24">
                 <AntDesign.Col Span="12">
-                    <FormItem Label="Заголовок">
-                        <Input @bind-Value="@context.Entity.Title" OnkeyUp="context.TitleChanged"/>
+                    <FormItem Label="Название">
+                        <Input @bind-Value="@context.Entity.Title" OnkeyUp="context.TitleChanged" Placeholder="Мегатема"/>
+                        <Text Type="secondary">Название темы</Text>
                     </FormItem>
                 </AntDesign.Col>
                 <AntDesign.Col Span="12">
                     <FormItem Label="Адрес">
-                        <Input @bind-Value="@context.Entity.Url"/>
+                        <Input @bind-Value="@context.Entity.Url" Placeholder="topicname"/>
+                        <Text Type="secondary">Адрес темы на сайте — https://www.bioware.ru/topics/topicname.html</Text>
                     </FormItem>
                 </AntDesign.Col>
             </Row>
@@ -62,11 +64,13 @@
                                 TItem="Site"
                                 EnableSearch
                                 AllowClear/>
+                        <Text Type="secondary">Сайты, на которых показывать тему</Text>
                     </FormItem>
                 </AntDesign.Col>
                 <AntDesign.Col Span="12">
                     <FormItem Label="Хештег">
                         <Input @bind-Value="@context.Entity.Data.Hashtag"/>
+                        <Text Type="secondary">Хештег для публикаций в соцсетях</Text>
                     </FormItem>
                 </AntDesign.Col>
             </Row>
@@ -74,10 +78,9 @@
                 <AntDesign.Col Span="12">
                     <FormItem Label="Картинка в шапку">
                         <AntStorageImageInput @bind-Value="@context.Entity.Data.HeaderPicture" Storage="@context.Storage" UploadPath="/topics" GenerateMetadata="@StorageUploadExtensions.GenerateMetadataAsync"></AntStorageImageInput>
+                        <Text Type="secondary">Картинка в шапке на странице темы</Text>
                     </FormItem>
                 </AntDesign.Col>
-                <AntDesign.Col Span="12">
-                </AntDesign.Col>
             </Row>
             <AntBlocklyForm TEntity="Topic" TForm="TopicForm" @bind-Value="context.Entity.Blocks" Form="context" Options="context.BlocksOptions"></AntBlocklyForm>
         </ChildContent>
diff --git a/src/BioEngine.Admin/Pages/Sites/Edit.razor b/src/BioEngine.Admin/Pages/Sites/Edit.razor
index b37a612..fa9acd4 100644
--- a/src/BioEngine.Admin/Pages/Sites/Edit.razor
+++ b/src/BioEngine.Admin/Pages/Sites/Edit.razor
@@ -21,13 +21,16 @@
         </Extra>
         <ChildContent>
             <FormItem Label="Заголовок">
-                <Input @bind-Value="@context.Entity.Title"/>
+                <Input @bind-Value="@context.Entity.Title" Placeholder="Мегасайт"/>
+                <Text Type="secondary">Название сайта для отображения в админке</Text>
             </FormItem>
             <FormItem Label="Адрес">
-                <Input @bind-Value="@context.Entity.Url"/>
+                <Input @bind-Value="@context.Entity.Url" Placeholder="https://site.dev"/>
+                <Text Type="secondary">Полный адрес сайта с протоколом</Text>
             </FormItem>
-            <FormItem Label="Главный сайт">
-                <Checkbox @bind-Value="context.Entity.IsMain">Является приоритетным при публикации на форуме</Checkbox>
+            <FormItem>
+                <Checkbox @bind-Value="context.Entity.IsMain">Главный сайт</Checkbox>
+                <Text Type="secondary">Является приоритетным при публикации на форуме</Text>
             </FormItem>
         </ChildContent>
     </PageContainer>
diff --git a/src/BioEngine.Admin/Pages/Tags/Edit.razor b/src/BioEngine.Admin/Pages/Tags/Edit.razor
index cdb2569..8b8fa20 100644
--- a/src/BioEngine.Admin/Pages/Tags/Edit.razor
+++ b/src/BioEngine.Admin/Pages/Tags/Edit.razor
@@ -21,7 +21,8 @@
         </Extra>
         <ChildContent>
             <FormItem Label="Тег">
-                <Input @bind-Value="@context.Entity.Title"/>
+                <Input @bind-Value="@context.Entity.Title" Placeholder="cooltag"/>
+                <Text Type="secondary">Название тега</Text>
             </FormItem>
         </ChildContent>
     </PageContainer>
diff --git a/src/BioEngine.Admin/Web/src/index.scss b/src/BioEngine.Admin/Web/src/index.scss
index bc10ad2..4f42a66 100644
--- a/src/BioEngine.Admin/Web/src/index.scss
+++ b/src/BioEngine.Admin/Web/src/index.scss
@@ -62,4 +62,8 @@ body {
     height: 40px;
     font-size: 16px;
   }
+
+  .ant-form-item span.ant-typography.ant-typography-secondary {
+    display: block;
+  }
 }