[ian-reeds-games] Re: Help with html for my user guide
- From: "Craig Brett" <dmarc-noreply@xxxxxxxxxxxxx> (Redacted sender "craigbrett17@xxxxxxx" for DMARC)
- To: "ian-reeds-games@xxxxxxxxxxxxx" <ian-reeds-games@xxxxxxxxxxxxx>
- Date: Sat, 21 Mar 2015 18:23:58 +0000
You're fine to delete those markdown files, yeah. They might come in handy if
you decide to try your hand at markdown yourself.
I get why you'd want to do it in html though. It does give you more control
If you're doing it by hand, you can do those in page links. You need to set up
your headings as links with names and ids (sorry I don't remember which one)
and then set the href of your link to it to #myname.
Hope that helps!
Craig
> On 21 Mar 2015, at 7:41 am, Monkey <murtagh69.monkeys@xxxxxxxxx> wrote:
>
> Ah, that does help, thank you!
> And that also explains the md files...I was wondering what those were
> for. I take it we shouldn't delete those, right?
>
> I was coding by hand. I thought it was good practice, since I haven't
> used much html in years. Mainly just bb-code on forums and the like.
>
>> On 3/21/15, Victorious <dtvictorious@xxxxxxxxx> wrote:
>> Ian, Craig and I use something called markdown to write our html
>> documentation. It is a simplified syntax that is easy to write. The
>> markdown
>> source file is then ran through a programme that converts that to the
>> actual
>> html markup. Below are some examples of markdown.
>>
>> A heading lvl 1 called user guide:
>> # User Guide
>> A level 2 heading called changelog:
>> ## Changelog
>>
>> A list of items:
>> * item 1
>> * item 2
>> * this is item 1 of a nested list
>> * this is item 2 of a nested list
>> * this is item 3 of a nested list
>> * item 3
>>
>> In the data for tb\documentation folder, you'll see .md files which are
>> markdown sources of things like craig's script guide, the game manual etc.
>> Open them with any text editor to take a look.
>>
>> There are many programmes available that do the conversion between markdown
>> to html. I like a free command-line utility called pandoc
>> (http://johnmacfarlane.net/pandoc/). The batch file that converts my
>> readme.md into the readme.html that you see in the documentation folder
>> looks like this:
>> pandoc -f markdown -t html --self-contained --toc --toc-depth=3 -o
>> "readme.html" "readme.md"
>>
>> Pandoc has support for automatic generation of table contents which are
>> created based on the document's heading structure. Just google for more
>> information on the markdown syntax and pandoc's command line options.
>>
>> Hope that helps.
>>
>> Victorious
>>
>>
>>
>>
>> -----Original Message-----
>> From: ian-reeds-games-bounce@xxxxxxxxxxxxx
>> [mailto:ian-reeds-games-bounce@xxxxxxxxxxxxx] On Behalf Of Monkey
>> Sent: Saturday, March 21, 2015 2:57 PM
>> To: ian-reeds-games
>> Subject: [ian-reeds-games] Help with html for my user guide
>>
>> Hello,
>>
>> I'm doing the user guide for my map pack...it's about time I get that done!
>> I want to do a table of contents similar to what some of the other guides
>> have, such as the one for the game itself, and I'm wondering how exactly to
>> set it up so that you can click on the link and have it take you to that
>> particular section in the file. I know how to do links to webpages, but not
>> to a specific section of a page or especially the same page you're on.
>> Could someone please explain that to me? Or alternatively, if you know
>> where
>> I can find a tutorial that also works. I'm looking through W3Schools
>> because
>> that's where I learned most of my HTML (years ago now), but I haven't found
>> this yet.
>
>
> --
> -Mew
> __________
> http://www.savethefrogs.com/
>
Other related posts:
