Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

【PgEditor】ヘルプツリーの追加 #296

Closed
snext1220 opened this issue Jul 21, 2021 · 7 comments
Closed

【PgEditor】ヘルプツリーの追加 #296

snext1220 opened this issue Jul 21, 2021 · 7 comments
Labels
enhancement 新機能提案* Testing テスト中(現在のテスト対象項目)

Comments

@snext1220
Copy link
Owner

snext1220 commented Jul 21, 2021

#293 の対応に伴い、PgEditorにタグリファレンスを組み込みました。
ヘルプデータがまだ完備できていないので、細部な問題はありますが、ほぼほぼ旧来のブログレベルの情報はPgEditor上で得られるかと思います。
https://www.web-deli.com/sorcerian/text/playground/editor.html
# 再編の副作用として、Flow2Editorの機能がGitHub Pagesでも利用できるようになる予定です(現在は未対応)

本件対応に伴い、

  • ブログ側のマニュアルからタグドキュメントは取り除いていくことになるかと思います(情報の分散は避けたいので)。
  • また、SGML式や条件式の記述なども、今後Playgroundに組み込むなり、既存ドキュメントを再編するなりしていく予定です。★済★
  • テストが完了し、安定したことを確認次第、現在公開中のPgEditorは削除していく予定です。
@snext1220 snext1220 added enhancement 新機能提案* Testing テスト中(現在のテスト対象項目) labels Jul 21, 2021
@snext1220 snext1220 added this to the 2021 Summer Update milestone Jul 21, 2021
@cocotori
Copy link
Collaborator

cocotori commented Aug 2, 2021

ページの移動なく詳細情報がわかるのは手軽なので
非常にありがたい機能だと思います!

その一方で、従来のヘルプページはページ一枚になっていて
見通しはよかったのでなくしてしまうのは少しさみしいかな・・・と思います。
(検索もしやすいので)

ただ情報の分散を避けるというのもよくわかりますので、
管理のしやすいやり方を採ってもらえればと思います。

@snext1220
Copy link
Owner Author

ご確認ありがとうございます!

ページ1枚>こちらは必要性に応じて、現在のヘルプデータから動的に1枚形式のヘルプを生成するようにすれば、似たものを残すことはできるかと思います(ブログ側でなく、本家サイトの方への掲載になる&データの再編は必要になりますが^^;)。

あとは、どのような使い方をされていたか、ですかね~

  • 要素/属性名で検索されていたならば → ヘルプツリーそのものに検索機能を付けるのがむしろ手軽かも
  • 全文での検索をされていたならば → 1枚形式のヘルプページを設ける
  • 特定の要素配下の属性を一望したいならば → 現在のツリーの要素ヘルプで、要素概要だけでなく属性ヘルプもまとめて表示する

などなど。ある程度慣れを待ってからの方が良い面もありそうですが、その他も具体的な用途伺えれば改善もできるかと思うので、引き続きご意見頂ければ幸いです~

@cocotori
Copy link
Collaborator

cocotori commented Aug 3, 2021

基本的には要素名・属性名で検索していたので、
ヘルプツリーに検索機能があるとありがたいです。

@snext1220
Copy link
Owner Author

こちら早速検索機能を追加してみました。
ツリー上部のテキストボックスにキーワードを入力すると、部分一致した要素/属性だけに絞り込み表示される感じです。ご利用ください~

@snext1220
Copy link
Owner Author

とりあえずFlow/Editor共にヘルプ機能そのものは問題なさそうなので、Pg上のメニューバーから辿れるヘルプリンクも改めて整理しました。これで対応するドキュメント、discussionも辿りやすくなったのではないかと…!

@Salvadors-cabin
Copy link
Collaborator

Win10+Edge環境でPgEditorのヘルプツリーが機能していることを確認しました。

@toki-sor1
Copy link
Collaborator

Win 8.1/Chrome 92.0.4515.131(64bit)にて動作確認。
ヘルプツリーが正常に表示されているのを確認しました。
目当てのヘルプを見付けやすいところも良いですね。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement 新機能提案* Testing テスト中(現在のテスト対象項目)
Projects
None yet
Development

No branches or pull requests

4 participants