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

Shortend anchors for FAQ might be to short #63

Closed
Lineflyer opened this issue Apr 9, 2015 · 6 comments
Closed

Shortend anchors for FAQ might be to short #63

Lineflyer opened this issue Apr 9, 2015 · 6 comments
Assignees

Comments

@Lineflyer
Copy link
Member

Example:
http://cgeo.github.io/faq.html#faq.Iamnotable

There are two entries matching it.

I could try to manually avoid it by changing the title, still this is no failsafe method.
Suggestions?

@Bananeweizen
Copy link
Member

Actually I'm thinking that removing the auto-generated anchor might be the best solution. I.e. just add another data item for each faq entry, like

title: I am new to Geocaching. How does all of this work?
anchor: newbie
content: |
            Explaining all details of Geocaching ...

Then we can simply use

{{item.anchor}}

in the faq.html instead of the automatically shortened title.

This has multiple benefits:

  • anchors become more readable (which you will surely notice when posting them on facebook)
  • anchors don't change when someone updates a FAQ title, which otherwise breaks cross links

If we change this, then I suggest to also remove the "faq." part in the anchor, as it appears twice in the URL and doesn't add any value.

Note: I've not tested anything of my suggestions, as I didn't get jekyll running yet.

@SammysHP
Copy link
Member

#15 (comment)
#15 (comment)

You can add the anchor key (for all faq entries) and I'll make the necessary modifications to our script.

@Lineflyer
Copy link
Member Author

You can add the anchor key (for all faq entries) and I'll make the necessary modifications to our script.

Who are you adressing?

@SammysHP
Copy link
Member

@Lineflyer You, it's your FAQ. ;)

@Lineflyer
Copy link
Member Author

@SammysHP Can you do an example for me so that I understand the way it will work? Then I can do the rest of the work for sure.

@SammysHP
Copy link
Member

      - title: This is the title
        id: this-is-the-title
        content: |
            This is the content…

@Lineflyer Lineflyer assigned Lineflyer and unassigned SammysHP May 18, 2015
SammysHP added a commit that referenced this issue May 18, 2015
Work on #63: Adding ID field to FAQ
@SammysHP SammysHP assigned SammysHP and unassigned Lineflyer May 18, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants