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

Insert spaces around backticks for markups to be correctly detected #141

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

noritada
Copy link
Contributor

Hi,

This is a series of corrections for issues that some markups are not detected in following sections:

  • book/02-git-basics/sections/recording-changes.asc HTML
  • book/09-git-and-other-scms/sections/import-svn.asc HTML
  • book/A-git-in-other-environments/sections/*.asc HTML
  • book/B-embedding-git/sections/jgit.asc HTML

Could you please review?

Many thanks

Copy link
Collaborator

@tnir tnir left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Almost every reformatting looks good except that ``...'' should be preserved 👍

@@ -174,14 174,14 @@ Changes not staged for commit:
----

//////////////////////////
The `CONTRIBUTING.md` file appears under a section named ``Changes not staged for commit'' – which means that a file that is tracked has been modified in the working directory but not yet staged.
The `CONTRIBUTING.md` file appears under a section named "`Changes not staged for commit`" -- which means that a file that is tracked has been modified in the working directory but not yet staged.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we need this kind of change 🤔

Suggested change
The `CONTRIBUTING.md` file appears under a section named "`Changes not staged for commit`" -- which means that a file that is tracked has been modified in the working directory but not yet staged.
The `CONTRIBUTING.md` file appears under a section named ``Changes not staged for commit'' -- which means that a file that is tracked has been modified in the working directory but not yet staged.

To stage it, you run the `git add` command.
`git add` is a multipurpose command – you use it to begin tracking new files, to stage files, and to do other things like marking merge-conflicted files as resolved.
It may be helpful to think of it more as ``add this content to the next commit'' rather than ``add this file to the project''.(((git commands, add)))
It may be helpful to think of it more as "`add this content to the next commit`" rather than "`add this file to the project`".(((git commands, add)))
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
It may be helpful to think of it more as "`add this content to the next commit`" rather than "`add this file to the project`".(((git commands, add)))
It may be helpful to think of it more as ``add this content to the next commit'' rather than ``add this file to the project''.(((git commands, add)))

Comment on lines 183 to 184
`CONTRIBUTING.md` ファイルは "`Changed but not staged for commit`" という欄に表示されます。これは、追跡対象のファイルが作業ディレクトリ内で変更されたけれどもまだステージされていないという意味です。
ステージするには `git add` コマンドを実行します。 `git add` にはいろんな意味合いがあり、新しいファイルの追跡開始・ファイルのステージング・マージ時に衝突が発生したファイルに対する「解決済み」マーク付けなどで使用します。 "`指定したファイルをプロジェクトに追加(add)する`" コマンド、というよりは、 "`指定した内容を次のコミットに追加(add)する`" コマンド、と捉えるほうがわかりやすいかもしれません。(((git commands, add)))
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`CONTRIBUTING.md` ファイルは "`Changed but not staged for commit`" という欄に表示されます。これは、追跡対象のファイルが作業ディレクトリ内で変更されたけれどもまだステージされていないという意味です。
ステージするには `git add` コマンドを実行します。 `git add` にはいろんな意味合いがあり、新しいファイルの追跡開始・ファイルのステージング・マージ時に衝突が発生したファイルに対する「解決済み」マーク付けなどで使用します。 "`指定したファイルをプロジェクトに追加(add)する`" コマンド、というよりは、 "`指定した内容を次のコミットに追加(add)する`" コマンド、と捉えるほうがわかりやすいかもしれません。(((git commands, add)))
`CONTRIBUTING.md` ファイルは ``Changed but not staged for commit'' という欄に表示されます。これは、追跡対象のファイルが作業ディレクトリ内で変更されたけれどもまだステージされていないという意味です。
ステージするには `git add` コマンドを実行します。 `git add` にはいろんな意味合いがあり、新しいファイルの追跡開始・ファイルのステージング・マージ時に衝突が発生したファイルに対する「解決済み」マーク付けなどで使用します。 ``指定したファイルをプロジェクトに追加(add)する'' コマンド、というよりは、 ``指定した内容を次のコミットに追加(add)する'' コマンド、と捉えるほうがわかりやすいかもしれません。(((git commands, add)))

@@ -181,13 181,13 @@ We won't be doing a detailed rundown of these tools (they have their own documen
ここではツールの詳細な説明はしません(GitHubクライアントの自前のドキュメントがあります)が、 ``changes'' ビュー(ツールの実行時間の大半はここを使うことになると思います)の内容をざっと見ていきましょう。

//////////////////////////
* On the left is the list of repositories the client is tracking; you can add a repository (either by cloning or attaching locally) by clicking the `` '' icon at the top of this area.
* On the left is the list of repositories the client is tracking; you can add a repository (either by cloning or attaching locally) by clicking the "` `" icon at the top of this area.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* On the left is the list of repositories the client is tracking; you can add a repository (either by cloning or attaching locally) by clicking the "` `" icon at the top of this area.
* On the left is the list of repositories the client is tracking; you can add a repository (either by cloning or attaching locally) by clicking the `` '' icon at the top of this area.

* In the center is a commit-input area, which lets you input a commit message, and select which files should be included.
(On Windows, the commit history is displayed directly below this; on Mac, it's on a separate tab.)
* On the right is a diff view, which shows what's changed in your working directory, or which changes were included in the selected commit.
* The last thing to notice is the ``Sync'' button at the top-right, which is the primary way you interact over the network.
//////////////////////////
* 左側には、クライアントが追跡しているリポジトリのリストが表示されます。この領域の一番上の `` '' アイコンをクリックすると、(ローカルでクローンするかアタッチするかして)リポジトリを追加できます。
* 左側には、クライアントが追跡しているリポジトリのリストが表示されます。この領域の一番上の "` `" アイコンをクリックすると、(ローカルでクローンするかアタッチするかして)リポジトリを追加できます。
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* 左側には、クライアントが追跡しているリポジトリのリストが表示されます。この領域の一番上の "` `" アイコンをクリックすると、(ローカルでクローンするかアタッチするかして)リポジトリを追加できます。
* 左側には、クライアントが追跡しているリポジトリのリストが表示されます。この領域の一番上の `` '' アイコンをクリックすると、(ローカルでクローンするかアタッチするかして)リポジトリを追加できます。

@noritada
Copy link
Contributor Author

@tnir Thank you very much for review comments and I'm sorry for my missing explanations.

I made this change because when multiple pairs of this markup are included, like ``foo'' and ``bar'', AsciiDoctor recognizes that foo'' and is the content of quotes of `` and wrongly highlights those words.
I investigated this issue and found that AsciiDoctor's curved quotation syntax seems to have been changed from ``foo'' to `"foo"` in v1.5.0, and this book's English version has already been changed to the new syntax. For this reason, I made corresponding changes in this PR to avoid highlighting issues.

However, I myself respect the original Japanese translation, so if there is any problem, I would like to revert to the original syntax. Could you give me a suggestion on which is better?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants