Opened 12 years ago

Closed 7 years ago

# new documentation categories "FAQ" and "Thematic Tutorials"

Reported by: Owned by: mvngu mvngu major sage-duplicate/invalid/wontfix documentation FAQ, HOWTO, tutorial wdj, rlm, ncohen, rbeezer, sage-combinat, bump, jhpalmieri, jason Ralf Stephan, Karl-Dieter Crisman N/A

This is a meta-ticket that helps in organizing changes and additions to the Sage standard documentation. On sage-devel and sage-combinat-devel, it is proposed that we create two new documentation categories called:

• FAQ --- a collection of answers to frequently asked questions.
• Thematic Tutorials --- a collection of in-depth tutorials on specific topics.

See this thread on sage-devel for further discussion about more accessible documentation. For starters, here is a list of tickets with enhancements for those two new documentation categories:

• #8442 Lie Methods and Related Combinatorics
• #8464 FAQ
• #8465 Python Functional Programming for Mathematicians
• #8466 Sage and Coding Theory
• #8467 Linear Programming in Sage
• #8468 Group Theory and Sage: A Primer
• #8469 Number Theory and the RSA Public Key Cryptosystem
• #8886 tutorial on Python object and classes

Once all the above tickets are closed, the current ticket can be closed as fixed.

Prerequisites:

1. #8480 stylistic clean-ups on web page of standard documentation
2. #8468 Group Theory and Sage
3. #8464 add FAQ to standard documentation
4. #8533 browse thematic tutorials from command line and within notebook
5. #8465 Functional Programming for Mathematicians
6. #8469 Number Theory and the RSA Public Key Cryptosystem
7. #8442 Lie Methods and Related Combinatorics

### comment:1 Changed 12 years ago by jhpalmieri

• Cc jhpalmieri added

### comment:2 Changed 12 years ago by mvngu

• Description modified (diff)

### comment:3 Changed 12 years ago by nthiery

This sounds very good! Should the following appear there as well?

• the category primer (sage.categories.primer)
• the "implementing a parent" tutorial (sage.categories.tutorial); this needs further work!

For the record, in the Sage-Combinat queue, some work is being done on:

• A tutorial on iterators
• A tutorial on combinatorics

### comment:4 Changed 12 years ago by mvngu

• Keywords tutorial added
• Summary changed from new documentation categories "FAQ" and "Sage HOWTOs" to new documentation categories "FAQ" and "Thematic Tutorials"

### comment:5 Changed 12 years ago by mvngu

• Description modified (diff)

### comment:6 Changed 12 years ago by mvngu

• Description modified (diff)

### comment:7 Changed 12 years ago by mvngu

• Description modified (diff)

### comment:8 Changed 12 years ago by mvngu

• Description modified (diff)

### comment:9 Changed 12 years ago by mvngu

• Description modified (diff)

### comment:10 Changed 12 years ago by mvngu

• Description modified (diff)

### comment:11 Changed 12 years ago by bump

Here is a more complete list of patches that are relevant to this metaticket:

```trac_8480-clean-up.patch
trac_8464-faq-general.patch
trac_8464-faq-usage.patch
trac_8464-faq-contribute.patch
trac_8464-ref.patch
trac_8465-functional.patch
trac_8469-rsa.patch
trac_8468-groups.patch
trac_8411_branching_rules.patch
trac_8414_weyl_group_space.patch
trac_8442-lie-rebased.patch
trac_8442-reviewer.patch
trac_8492-ref.patch
```

In addition three .png files from #8442 need to be copied into `doc/en/thematic_tutorials/static`.

With this preparation, the pdf and html documentation build and look very good.

### comment:12 Changed 12 years ago by mvngu

• Description modified (diff)

### comment:13 Changed 12 years ago by mvngu

• Description modified (diff)

### comment:14 Changed 12 years ago by jason

• Cc jason added

### comment:15 Changed 8 years ago by jdemeyer

• Milestone changed from sage-5.11 to sage-5.12

### comment:16 Changed 8 years ago by vbraun_spam

• Milestone changed from sage-6.1 to sage-6.2

### comment:17 Changed 8 years ago by vbraun_spam

• Milestone changed from sage-6.2 to sage-6.3

### comment:18 Changed 7 years ago by vbraun_spam

• Milestone changed from sage-6.3 to sage-6.4

### comment:19 Changed 7 years ago by rws

• Milestone changed from sage-6.4 to sage-duplicate/invalid/wontfix
• Status changed from new to needs_review

All done!

### comment:20 Changed 7 years ago by kcrisman

• Reviewers set to Ralf Stephan, Karl-Dieter Crisman
• Status changed from needs_review to positive_review

We certainly need better organization of documentation, but this ticket has achieved its purpose, you are right. Too bad #8533 isn't finished yet, but oh well.

### comment:21 Changed 7 years ago by vbraun

• Resolution set to fixed
• Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.