[PATCH] orgweb: Update org-ruby link (tools)

[PATCH] orgweb: Update org-ruby link (tools)

[Max Nikulin]

[-- Attachment #1: Type: text/plain, Size: 539 bytes --]

Hi,

It seems the org-ruby project link on the https://orgmode.org/tools.html 
page is outdated and should be updated to the repository of its current 
maintainer.

I suggest to move the link to the Import&Export section since the 
primary purpose of the project is conversion to HTML, Markdown, or 
textile. I have tried to blindly update zh-CN file. Likely it should be 
done more accurately.

Would it be acceptable to add an additional link to the dedicated page 
on Worg?
[[https://orgmode.org/worg/org-tutorials/org-ruby.html][Worg]]

[-- Attachment #2: 0001-tools.org-Update-link-to-org-ruby.patch --]
[-- Type: text/x-patch, Size: 1294 bytes --]

From 65f797a418d73077171b5f74b5930179939e7a3f Mon Sep 17 00:00:00 2001
From: Max Nikulin <manikulin@gmail.com>
Date: Sat, 8 Jun 2024 23:01:56 +0700
Subject: [PATCH 1/2] tools.org: Update link to org-ruby

* tools.org:
* zh-CN/tools.org: Update org-ruby project page.

Use link from <https://rubygems.org/gems/org-ruby>
---
 tools.org       | 2 +-
 zh-CN/tools.org | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/tools.org b/tools.org
index 447ec57..525953a 100644
--- a/tools.org
+++ b/tools.org
@@ -232,7 +232,7 @@ ** Perl
 /Org​::parser/
 {{{end-link}}}
 ** Ruby
-{{{gh(bdewey/org-ruby)}}}
+{{{gh(wallyqs/org-ruby)}}}
 [[https://upload.wikimedia.org/wikipedia/commons/7/73/Ruby_logo.svg]]
 
 /org-ruby/ gem --- parse Org files and convert to HTML or textile. Used
diff --git a/zh-CN/tools.org b/zh-CN/tools.org
index aeca181..77f838f 100644
--- a/zh-CN/tools.org
+++ b/zh-CN/tools.org
@@ -131,7 +131,7 @@ ** Perl
 /Org​::parser/
 {{{end-link}}}
 ** Ruby
-{{{gh(bdewey/org-ruby)}}}
+{{{gh(wallyqs/org-ruby)}}}
 [[https://upload.wikimedia.org/wikipedia/commons/7/73/Ruby_logo.svg]]
 
 /org-ruby/ 是一个解析 Org 文件以及将其转换为文本格式以及 HTML 格式的 Ruby 库。此外，GitHub 使用这个库来显示网页上的 Org 文件。
-- 
2.39.2


[-- Attachment #3: 0002-tools.org-Move-org-ruby-to-export-section.patch --]
[-- Type: text/x-patch, Size: 2482 bytes --]

From c38db1f3dfaf17f441347e4b1f12c6bd957413ec Mon Sep 17 00:00:00 2001
From: Max Nikulin <manikulin@gmail.com>
Date: Sat, 8 Jun 2024 23:13:07 +0700
Subject: [PATCH 2/2] tools.org: Move org-ruby to export section

* tools.org:
* zh-CN/tools.org: Put org-ruby to exporters
---
 tools.org       | 14 +++++++-------
 zh-CN/tools.org | 12 ++++++------
 2 files changed, 13 insertions(+), 13 deletions(-)

diff --git a/tools.org b/tools.org
index 525953a..89ce863 100644
--- a/tools.org
+++ b/tools.org
@@ -88,6 +88,13 @@ ** Pandoc
 The Swiss-army knife of markup format converters.
 It can convert documents between many source formats, including Org
 {{{end-link}}}
+** Org-ruby
+{{{gh(wallyqs/org-ruby)}}}
+[[https://upload.wikimedia.org/wikipedia/commons/7/73/Ruby_logo.svg]]
+
+Gem and CLI tool to convert Org files to HTML, Markdown, or textile. Used
+by GitHub
+{{{end-link}}}
 * Publishing
 :PROPERTIES:
 :HTML_CONTAINER_CLASS: columns
@@ -231,13 +238,6 @@ ** Perl
 
 /Org​::parser/
 {{{end-link}}}
-** Ruby
-{{{gh(wallyqs/org-ruby)}}}
-[[https://upload.wikimedia.org/wikipedia/commons/7/73/Ruby_logo.svg]]
-
-/org-ruby/ gem --- parse Org files and convert to HTML or textile. Used
-by GitHub
-{{{end-link}}}
 ** Rust
 {{{gh(poiscript/orgize)}}}
 [[https://upload.wikimedia.org/wikipedia/commons/d/d5/Rust_programming_language_black_logo.svg]]
diff --git a/zh-CN/tools.org b/zh-CN/tools.org
index 77f838f..95519f3 100644
--- a/zh-CN/tools.org
+++ b/zh-CN/tools.org
@@ -37,6 +37,12 @@ ** Pandoc
 
 瑞士军刀级别的 markup 文档转换器：它能将文档在不同格式之间自由转换，包括 Org。
 {{{end-link}}}
+** Org-ruby 是
+{{{gh(wallyqs/org-ruby)}}}
+[[https://upload.wikimedia.org/wikipedia/commons/7/73/Ruby_logo.svg]]
+
+个解析 Org 文件以及将其转换为文本格式以及 HTML 格式的 Ruby 库。此外，GitHub 使用这个库来显示网页上的 Org 文件。
+{{{end-link}}}
 * 发布
 :PROPERTIES:
 :HTML_CONTAINER_CLASS: columns
@@ -130,12 +136,6 @@ ** Perl
 
 /Org​::parser/
 {{{end-link}}}
-** Ruby
-{{{gh(wallyqs/org-ruby)}}}
-[[https://upload.wikimedia.org/wikipedia/commons/7/73/Ruby_logo.svg]]
-
-/org-ruby/ 是一个解析 Org 文件以及将其转换为文本格式以及 HTML 格式的 Ruby 库。此外，GitHub 使用这个库来显示网页上的 Org 文件。
-{{{end-link}}}
 ** Rust
 {{{gh(poiscript/orgize)}}}
 [[https://upload.wikimedia.org/wikipedia/commons/d/d5/Rust_programming_language_black_logo.svg]]
-- 
2.39.2

Re: [PATCH] orgweb: Update org-ruby link (tools)

[Ihor Radchenko]

Max Nikulin <manikulin@gmail.com> writes:

> It seems the org-ruby project link on the https://orgmode.org/tools.html 
> page is outdated and should be updated to the repository of its current 
> maintainer.
>
> I suggest to move the link to the Import&Export section since the 
> primary purpose of the project is conversion to HTML, Markdown, or 
> textile.

+1

> ... I have tried to blindly update zh-CN file. Likely it should be 
> done more accurately.

Yes. Let's not fiddle with Chinese version. It is already out of sync,
but we cannot do much unless we get someone Chinese-speaking volunteer.

> Would it be acceptable to add an additional link to the dedicated page 
> on Worg?
> [[https://orgmode.org/worg/org-tutorials/org-ruby.html][Worg]]

Yes, but I'd prefer if such link would be not just a text link, but
something more compact. Maybe something like "wiki" button on top-left
corner of the logo.

Note that the extended tools page on
https://orgmode.org/worg/org-tools/index.html already has the link you proposed.

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>

Re: [PATCH] orgweb: Update org-ruby link (tools)

[Max Nikulin]

On 09/06/2024 02:18, Ihor Radchenko wrote:
> Max Nikulin writes:
>> ... I have tried to blindly update zh-CN file. Likely it should be
>> done more accurately.
> 
> Yes. Let's not fiddle with Chinese version. It is already out of sync,
> but we cannot do much unless we get someone Chinese-speaking volunteer.

Feel free to skip chunks you do not like.

> 
>> Would it be acceptable to add an additional link to the dedicated page
>> on Worg?
>> [[https://orgmode.org/worg/org-tutorials/org-ruby.html][Worg]]
> 
> Yes, but I'd prefer if such link would be not just a text link, but
> something more compact. Maybe something like "wiki" button on top-left
> corner of the logo.

I do not like and idea of a button over an active link.

Since org-ruby has no its own logo I would consider 3 smaller links instead:
- https://github.com/wallyqs/org-ruby with the github logo
- https://rubygems.org/gems/org-ruby with the current gem icon
- https://orgmode.org/worg/org-tutorials/org-ruby.html with styled 
"Worg" text.

> Note that the extended tools page on
> https://orgmode.org/worg/org-tools/index.html already has the link you proposed.

Formally it is more appropriate for 
https://orgmode.org/worg/org-translators.html "Org-mode Import/Export 
Tools". (I have no idea why this page is not in the org-tools folder.)

 From my point of view, when a user sees the ruby icon nothing suggests 
that, besides clicking on the link, they may find additional info on a 
page linked from another page accessible through a link at the bottom of 
the current one.

Re: [PATCH] orgweb: Update org-ruby link (tools)

[Ihor Radchenko]

Max Nikulin <manikulin@gmail.com> writes:

> On 09/06/2024 02:18, Ihor Radchenko wrote:
>> Max Nikulin writes:
>>> ... I have tried to blindly update zh-CN file. Likely it should be
>>> done more accurately.
>> 
>> Yes. Let's not fiddle with Chinese version. It is already out of sync,
>> but we cannot do much unless we get someone Chinese-speaking volunteer.
>
> Feel free to skip chunks you do not like.

Applied.
I retained the old description in the Chinese translation.
https://git.sr.ht/~bzg/orgweb/commit/96072c43b4a497f614f3bb4251da341b9df3b5b9
https://git.sr.ht/~bzg/orgweb/commit/29cbf1f4b433f6dc008aad1a71a9b60367740d33

>>> Would it be acceptable to add an additional link to the dedicated page
>>> on Worg?
>>> [[https://orgmode.org/worg/org-tutorials/org-ruby.html][Worg]]
>> 
>> Yes, but I'd prefer if such link would be not just a text link, but
>> something more compact. Maybe something like "wiki" button on top-left
>> corner of the logo.
>
> I do not like and idea of a button over an active link.
>
> Since org-ruby has no its own logo I would consider 3 smaller links instead:
> - https://github.com/wallyqs/org-ruby with the github logo
> - https://rubygems.org/gems/org-ruby with the current gem icon
> - https://orgmode.org/worg/org-tutorials/org-ruby.html with styled 
> "Worg" text.

I do not mind as long as the overall style remains consistent. Feel free
to submit a patch.

>> Note that the extended tools page on
>> https://orgmode.org/worg/org-tools/index.html already has the link you proposed.
>
> Formally it is more appropriate for 
> https://orgmode.org/worg/org-translators.html "Org-mode Import/Export 
> Tools". (I have no idea why this page is not in the org-tools folder.)

Historical, I guess.
We may move it, but I am not sure if it is a big deal.

> From my point of view, when a user sees the ruby icon nothing suggests 
> that, besides clicking on the link, they may find additional info on a 
> page linked from another page accessible through a link at the bottom of 
> the current one.

That's true. On the other hand, tools page is not really a Wiki.
It is ok to put some links to the wiki/worg, but not at the cost of
information overloading.

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>