# Every title in Julia's manual should be identified explicitly

**URL:** <https://discourse.julialang.org/t/every-title-in-julias-manual-should-be-identified-explicitly/6176>\
**Category:** Community\
**Created:** [October 1, 2017, 12:30am UTC](https://discourse.julialang.org/t/every-title-in-julias-manual-should-be-identified-explicitly/6176 "2017-10-01T00:30:39Z")\
**Posts on this page:** 7\
**Page:** 1

<div class="post-metadata">

**Author:** ![mnru](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/mnru/32/2047_2.png) [@mnru](https://discourse.julialang.org/u/mnru)\
**Post date:** [October 1, 2017, 12:30am UTC](https://discourse.julialang.org/t/every-title-in-julias-manual-should-be-identified-explicitly/6176/1 "2017-10-01T00:30:39Z")

</div>

Hi,I’m a one of Japanese transrators of Julia’s manual ([https://hshindo.github.io/julia-doc-ja-v0.6/](https://hshindo.github.io/julia-doc-ja-v0.6/)).  
Then I have an proposal for Julia’s English Manual ver 1.0 that every title in the manual should be identified explicitly.  
What it means,there are two style for reference of markdown

```julia
Title Reference
"### title" "[title](@ref)"
"### title(@id title)" "[title](@ref title)"

```

and,their translations are,

```julia
"### タイトル" "[タイトル](@ref)"
"### タイトル(@id title)" "[タイトル](@ref title)"

```

if all translations were finished,then all links would alive,  
but If English and Japanese references are mixed,  
above style links are broken,but below links are still alive.  
so I think every references should be written in below style.

How about this proposal?

---

<div class="post-metadata">

**Author:** ![mnru](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/mnru/32/2047_2.png) [@mnru](https://discourse.julialang.org/u/mnru)\
**Post date:** [October 1, 2017, 8:21am UTC](https://discourse.julialang.org/t/every-title-in-julias-manual-should-be-identified-explicitly/6176/2 "2017-10-01T08:21:30Z")

</div>

I’m surprised at no response such a long time.  
I think this proposal is serious and it’s better to do before version 1.0.  
Where should I present this proposal?

---

<div class="post-metadata">

**Author:** ![Tamas\_Papp](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/tamas_papp/32/25949_2.png) [@Tamas\_Papp](https://discourse.julialang.org/u/Tamas_Papp)\
**Post date:** [October 1, 2017, 8:24am UTC](https://discourse.julialang.org/t/every-title-in-julias-manual-should-be-identified-explicitly/6176/3 "2017-10-01T08:24:20Z")

</div>

> [@mnru](#):
>
> I’m surprised at no response such a long time.

You mean 8h on Sunday (or late Saturday, depending on timezone)?

---

<div class="post-metadata">

**Author:** ![ChrisRackauckas](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/chrisrackauckas/32/77_2.png) [@ChrisRackauckas](https://discourse.julialang.org/u/ChrisRackauckas)\
**Post date:** [October 1, 2017, 9:50am UTC](https://discourse.julialang.org/t/every-title-in-julias-manual-should-be-identified-explicitly/6176/4 "2017-10-01T09:50:41Z")

</div>

> [@mnru](#):
>
> Where should I present this proposal?

> **[Issues · JuliaLang/julia](https://github.com/JuliaLang/julia/issues)**
>
> The Julia Programming Language. Contribute to JuliaLang/julia development by creating an account on GitHub.

---

<div class="post-metadata">

**Author:** ![mnru](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/mnru/32/2047_2.png) [@mnru](https://discourse.julialang.org/u/mnru)\
**Post date:** [October 1, 2017, 2:26pm UTC](https://discourse.julialang.org/t/every-title-in-julias-manual-should-be-identified-explicitly/6176/5 "2017-10-01T14:26:56Z")

</div>

I posted the same proposal there.Thank you.

---

<div class="post-metadata">

**Author:** ![waldyrious](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/waldyrious/32/80_2.png) [@waldyrious](https://discourse.julialang.org/u/waldyrious)\
**Post date:** [October 2, 2017, 7:27am UTC](https://discourse.julialang.org/t/every-title-in-julias-manual-should-be-identified-explicitly/6176/6 "2017-10-02T07:27:49Z")

</div>

Here’s the link, for reference:

[https://github.com/JuliaLang/julia/issues/23951](https://github.com/JuliaLang/julia/issues/23951)

---

<div class="post-metadata">

**Author:** ![Per](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/per/32/10387_2.png) [@Per](https://discourse.julialang.org/u/Per)\
**Post date:** [October 2, 2017, 8:07am UTC](https://discourse.julialang.org/t/every-title-in-julias-manual-should-be-identified-explicitly/6176/7 "2017-10-02T08:07:29Z")

</div>

Since each `@id` must be unique, I’d suggest making it depend not just on the title, but also on all higher-level titles.

```markdown
# Foo(@id Foo)
## Example(@id Foo-Example)
# Bar(@id Bar)
## Example(@id Bar-Example)

```

I bet there are hackers out there who could write a Julia function to do this to the entire manual in less than ten lines of code.
